🌍 Language / Язык:
English • Русский

---

# ⚔️ Narrativa ### Dialogues & Choices [![Beet](https://img.shields.io/badge/Powered%20by-Beet-yellow)](https://github.com/minecraft-beet/beet) [![Bolt](https://img.shields.io/badge/Built%20with-Bolt-orange)](https://github.com/mcbeet/bolt) [![Minecraft](https://img.shields.io/badge/Minecraft-Datapack-green)](https://www.minecraft.net)

--- ## 🧩 What is Narrativa? Narrativa is a modular dialogue and choice system for Minecraft datapacks, built with Beet and Bolt. It allows creators to define structured, multi-line conversations in .yml files (JSON format), compile them into datapacks, and execute them in-game using a lightweight runtime. Narrativa is a **framework**, not a content pack. It does not ship with built-in storylines, quests, or gameplay content beyond minimal examples. Instead, it provides the infrastructure for you to design and implement your own narrative systems. Core capabilities include: - Structured, tellraw-based dialogue display - Branching choice menus with automatic /trigger handling - Optional automatic voice line generation (Autodub) - Clean module separation between engine and content - Compatibility with custom interpreters if desired Narrativa abstracts the complexity of dialogue state management, step progression, and choice resolution, enabling mapmakers and datapack developers to focus on writing narrative content rather than low-level command logic. `TL/DR` A dialogues & choices system for Minecraft datapacks, built with Beet and Bolt, supporting structured JSON/YML dialogues and optional autogenerated voice lines. --- ## 🚀 Quick Start & Examples Everything in the `examples` folder works the way it was intended, please report any bugs or issues. Run the following command in-game to start the example Hello World dialogue: ```mcfunction /function ceevyte:dialogues/en_us/example/hello_world ``` It will explain the basics to you. At the end of the dialogue, there will be choice options (which is its own system). Pick either `[2] Cheese.` for the showcase of capabilities in-use; or `[3] Could you explain it a bit more?` for a more technical explanation of how to actually use it. --- ## 📚 Setup & Documentation To simplify your pain in the back, here is the technical explanation directly from the bot: > ⚠️ **Warning:** Keep Narrativa in a separate datapack from your main project. Failing to do so will cause static dialogues to rebuild on every `beet build`. This is undesirable. ### Step 1: Folders Place the `dialogues` folder at the top level of your project. Place your `.yml` files inside it. Please keep the name & path of it consistent everywhere. Reference them from a module. ### Step 2: Modules Create a module. Recommended name: `X_narrativa_content.bolt`. Register it in `beet.json` under `meta/bolt/entrypoint`, next to `narrativa.bolt`. **Important:** Inside your newly created content module, you must import the Narrativa module (both should be in the same folder): ```bolt import ./narrativa as Narrativa ``` ### Step 3: Autodub & Sounds (Optional) Autodub generates voice lines automatically. 1. Place your dialogue file in the `script` folder, rename it `input.yml`, and run the script. *(Output: `.ogg` files from 0 to N. Requires enough different English voices to be installed on your system).* 2. Open `sounds.py`. Add dialogue lines to the `specs` array as shown in examples. 3. Run the script. *(Output: `sounds.json`).* 4. Place it in your resourcepack. Ensure the `.ogg` file path in `sounds.py` matches the actual file location. --- ## 💬 Dialogues Inside your `.yml` files, you'll quickly notice that the YML format is simply JSON here. Imagine yourself writing a `/tellraw` command, where arrays inside the main array each are a new line. ### Dialogue Format Dialogues **must** follow this strict structure: ```json DialogueArray[ IndividualLine[ FirstList{ Components } ] ] ``` > 🛑 **Deviation from this structure will cause in-game silent errors. There are no exceptions. Yeah, I know, or otherwise it just breaks.** *Example of a valid input structure:* ```json [ [{"text": " Hello there!"}], [{"text": "I'm inside a dialogue. Cool, right?"}] ] ``` *(Autodub works by inserting an `autodub` component inside of the first list of the line, which contains an indexed sound name).* ### Loading a Dialogue To import the YML file as a Dialogue, structure your function like this: ```bolt function START_FUNCTION: Narrativa.newDialogue(Narrativa.loadDialogue( "PATH_TO_DIALOGUE_FILE.yml" ), "AUTODUB_SOUND_NAME") ``` Example: ```bolt function username:dialogues/example/hello_world: Narrativa.newDialogue(Narrativa.loadDialogue( "dialogues/example/hello_world.yml" ), "username:dialogues.example.hello_world.") ``` *(You can also build your own interpreter: The `Narrativa.newDialogue(ArrayJSON)` just requires a valid `/tellraw` command by the structure mentioned above).* ### Dialogue Trigger Example Since this is an example, we'll do a simple dialogue trigger. Just call `function ceevyte:narrativa/dialogue/_/step` when it does trigger:

Show Trigger Code (Flip-Flop Logic)

```bolt append function_tag minecraft:load { "values": [ "username:dialogue/load" ] } append function_tag minecraft:tick { "values": [ "username:dialogue/tick" ] } predicate username:dialogue/trigger { "condition": "minecraft:entity_properties", "entity": "this", "predicate": { "type_specific": { "type": "minecraft:player", "input": { "forward": false, "backward": false, "left": false, "right": false, "jump": false, "sneak": false, "sprint": true } } } } function username:dialogue/load: scoreboard objectives add username.dialogue.trigger dummy {"text": "Dialogue Trigger Flip-Flop", "color": "gold"} function username:dialogue/tick: execute as @a[tag=ceevyte.narrativa.dialogue.active]: execute if score @s[predicate=!username:dialogue/trigger] username.dialogue.trigger matches 1: scoreboard players reset @s username.dialogue.trigger execute unless score @s[predicate=username:dialogue/trigger] username.dialogue.trigger matches 1..: function ceevyte:narrativa/dialogue/_/step scoreboard players set @s username.dialogue.trigger 1 ```

By running `beet build`, the dialogues should be compiled into a datapack properly. --- ## 🔀 Choices This one is a lot easier, and requires less fiddling with my awful code. Choice system requires three calls: 1. `Narrativa.newChoice()` at the start of your function. 2. Send a `tellraw` with your choice menu. Style is yours to define. 3. Call `Narrativa.lockChoice(...)` at the end. ### How Clicks Work Use `click_event` to `run_command`, but instead of running an actual command, just put `Narrativa.choiceCounter()` there. **It automatically generates a `/trigger` command, so it will work even without the cheats being on!** ### Full Choice Example ```bolt function ceevyte:choices/example/hello_world: Narrativa.newChoice() tellraw @s [ { "text": "\n" }, { "text": "— [1] Wowww, that's so cool :0", "color": "gray", "click_event": { "action": "run_command", # This function exists so that you don't have to type out the numbers manually, # and you can thank me later :^ "command": Narrativa.choiceCounter() }, "hover_event": { "action": "show_text", "value": [ { # You can do like, descriptions and stuff, but that's just # generic Json tellraw. "text": "False flattery. Classic." } ] } }, { "text": "\n" }, { "text": "— [2] Cheese.", "color": "gray", "click_event": { "action": "run_command", "command": Narrativa.choiceCounter() }, "hover_event": { "action": "show_text", "value": [ { "text": "I... honestly don't remember putting this in. O_o" } ] } }, { "text": "\n" }, { "text": "— [3] Could you explain it a bit more?", "color": "gray", "click_event": { "action": "run_command", "command": Narrativa.choiceCounter() }, "hover_event": { "action": "show_text", "value": [ { "text": "Nerd." } ] } } ] Narrativa.lockChoice( [ # [1] { "function": "ceevyte:dialogues/example/hello_world/that_s_so_cool" }, # [2] { "function": "ceevyte:dialogues/example/hello_world/cheese" }, # [3] { "function": "ceevyte:dialogues/example/hello_world/could_you_explain" } ] ) ``` *Note: Each "function" parameter in `lockChoice` correlates to the according choice option. This can be any function.* --- ## ❓ Commonly Asked Questions **Q: Do I really need to load the `narrativa.bolt` as a module?** > **A:** Yes, the `narrativa.bolt` is the Library module itself, and is required to be loaded by beet, preferably before the `narrativa_content` modules. **Q: Why is there code instead of just `.mcfunction`?** > **A:** Beet. **Q: Can I rewrite your stupid code and make a better one?** > **A:** PLEASE DO. **Q: How do I install Beet properly?** > **A:** [https://www.youtube.com/watch?v=IOS-OnqE4GY](https://www.youtube.com/watch?v=IOS-OnqE4GY) **Q: How to install the datapack?** > **A:** Either do `beet link (your world path at "../saves/")` in VSCode's console, or drag them there manually OR download the latest Release from this repository. **Q: Will it be updated further?** > **A:** Of course, I need to fix everything here, lol.

Light Meal

Compatibility

Minecraft: Java Edition

Platforms

Supported environments

Links

Tags

Creators

Details

mmmm... yummy