Basic Development Procedure
The following procedure applies to each supported content type. A worked example should be used as the initial configuration whenever one is available.
- Create the content folder. Assign a descriptive folder name and place all required images, sprite sheets, portraits, sounds, or music tracks within that folder.
- Prepare the configuration. Copy the example JSON file for the applicable content type. Revise its names and file paths so they correspond to the files in the new folder.
- Install the folder. Place it in the applicable subdirectory under
content/, which is located besideblarp.exe. For example, install characters undercontent/characters/and rooms undercontent/rooms/. - Reload and inspect the content. Press
Ctrl+Shift+R, or select File → Refresh. Blarp reloads installed content without requiring the user to restart the client or rejoin the server. - Package the completed content. Use the Content Packs window to create a
.bcpfile. Distribute this file to each user who requires the content.
Supported Content Types
Each content type occupies a defined location and provides a specific set of functions.
| Type | Location | What it adds |
|---|---|---|
| Rooms | content/rooms/<id>/ | Provides background artwork, collision, spawn points, exits, inspections, fog, sight limits, weather, and time-of-day settings. |
| Cues | GM panel | Provides scripted scene operations, including doors, NPC dialogue, sound, lighting, room memory, and cue sequences. |
| Characters | content/characters/<id>/ | Provides walk cycles, portraits, poses, combat clips, footsteps, shouts, text blips, VN sprites, and chat color. |
| Items | content/items/<id>/ | Provides named and described objects that users can carry, drop, and pick up. |
| Music lists | content/music/<id>/ | Provides music tracks organized by mood for playback through the room music controls. |
| Rulesets | content/rulesets/<id>/ | Defines combat statistics, actions, formulas, effects, and balance budgets. |
Content Distribution
Loose folders are suitable during development because the Refresh command loads file changes immediately. Completed content should be distributed as a .bcp file. The package keeps related files together, verifies the included files, records dependencies, and permits controlled removal.
Note: Each client must have a local copy of the content it displays or plays. The server identifies the active room, character, or music list, but it does not transfer complete artwork or audio packages during operation.
Authoring Support
Blarp is intended to provide visual authoring tools for each content type. Planned functions include visual sprite-frame selection, walk-cycle preview, portrait placement, and audio preview. These tools are intended to reduce the amount of manual configuration required to prepare content.