🌩️Sparkifier

Used to create new or edit Sparks.

Details

• Converts 3D objects, such as GLB and gITF files, into a usable asset in Bonfire known as a Spark.

• Supports the conversion (or “Sparkification”) of Entity, Config, Symbol, and Audio assets.

Types of Sparks:

• Entity - An interactive 3D object, such as houses, walls, or tables, that can be placed in the world and anchored to a physical space. This is the most commonly used type of Spark.

• Config - Use a Config Spark to add Causes, Effects, and Traits without displaying any in-book visuals. Examples include systems such as an inventory manager, timer, or data holder.

• Symbol - Symbol Sparks represent symbols like text, images, or input fields used in graphical interfaces, such as forms or on screen health bars.

• Audio - Although there's no visual in the Book, the placed Spark location will serve as the point for spatial audio playback.

Creating Sparks

Entity

Prerequisites

Ensure that a .glb or .gITF file is ready for conversion.

Creating an Entity Spark

1. Navigate to the Sparkifier homepage and click the New Spark button.

1. A window will appear, prompting for the selection of the Spark type to be created. Choose Entity Spark Type from the available options.

1. Observe that the Spark Type dropdown in the lower left corner now displays “Spark.Entities.Entity”.

1. To import the .glb or .gltf file, click the browse button located underneath the Loaded Actor File Path field and select the intended file for conversion.

1. Assign a name to the new Spark, for example, “Sample Entity”.

1. Click the Build Spark button in the lower left corner and choose a folder for the export location.

1. In the builder interface, click the icon in the Spark Browser and locate the newly created Entity Spark. After importing, the “Sample Entity” Spark should appear in the Sparks → My Sparks directory.

Config

Symbol

Prerequisites

Ensure that a .jpg or .png file is ready for conversion.

Creating an Entity Spark

1. Navigate to the Sparkifier homepage and click the New Spark button.

1. A window will appear, prompting for the selection of the Spark type to be created. Choose Symbol Spark Type from the available options

1. Observe that the Spark Type dropdown in the lower left corner now displays “Spark.Symbols.Symbol”.

1. To import the .jpg or .png file, click the browse button located underneath the Loaded Actor File Path field and select the intended file for conversion.

1. Assign a name to the new Spark, for example, “Sample Symbol”.

1. Click the Build Spark button in the lower left corner and choose a folder for the export location.

1. In the builder interface, click the icon in the Spark Browser and locate the newly created Symbol Spark. After importing, the “Sample Symbol” Spark should appear in the Sparks → My Sparks directory

Audio

The following instructions describe creating an Audio Spark and configuring its settings.

Prerequisites

Ensure that a sample .mp3 file is available for conversion.

Creating an Audio Spark

1. Navigate to the Sparkifier homepage and click the New Spark button.

1. A window will appear, prompting for the selection of the Spark type to be created. Choose Audio Spark Type from the available options.

1. Observe that the Spark Type dropdown in the lower left corner now displays “Sparks.Configs.Audio”. This indicates that an Audio Spark is being created.

1. To import the .mp3 file, click the icon located at the top right corner. Select and open the .mp3 file intended for conversion.

1. Assign a name to the new Spark, for example, “Sample Audio”.

1. Click the Build Spark button in the lower left corner and choose a folder for the export location.

1. In the Builder interface, click the icon in the Spark Browser and locate the newly created Audio Spark. After importing, the “Sample Audio” Spark should appear in Sparks → My Sparks directory