VNLEWIKIBuild stories. Connect worlds.Deutsch
VNLE Handbook

Godot

This example project uses Godot 4.5.2. It includes the dialogue UI, reader and the same story as the browser example.

Download the Godot project

Open and play

  1. Extract the ZIP. Open the Godot Project Manager and choose Import.
  2. Select project.godot in the extracted folder and open the project.
  3. Press F6 in Main.tscn or F5 for the project. Choose Talk to Mira.
  4. Click Continue twice and buy the key. Check Gold 5 and the item in the inventory. Continue until the conversation closes.
  5. Test Start with 2 gold, the second reply, English / Deutsch, Save game and Load game.

What the project contains

Main.tscn        Main screen
Main.gd          Dialogue UI, inventory and save/load
VNLEStory.gd     Story flow, choices, variables and text resolution
story/story.json Exported VNLE story
story/guide-map.json Example IDs
story/assets/    Mira’s portrait

Use it in your game

  1. Copy VNLEStory.gd and the story folder into your Godot project.
  2. Start by using the dialogue UI in Main.gd unchanged. begin(10) starts with ten gold; in your game, pass the current gold value.
  3. In game_action, replace the example inventory with your inventory. Return success or cancellation only after the item transfer finishes.
  4. When view.kind == "finished", close your dialogue UI and restore player control.
  5. When using your own story, replace story.json and assets together. Update the IDs from guide-map.json using your export.
  6. To export your game: Project → Export → Add preset for your platform. Under Resources → Filters to export non-resource files enter *.json, *.png. The image reader loads the PNG by its exported path. Test the exported game too.

JSON and entry points explained