Skip to content

Version 1.0.0 · What's new

Download

Nothing to install to try it: the web IDE runs the real compiler in your browser, and the playground has examples to play. When you're ready to put a story in a game, pick what you need.

Web IDE

No download: write on the left, play on the right, share a story as a link. Your stories stay in your browser. Works on phones too.

Open the web IDE

Unity package

Unity 2021.3 or newer. Imports .bruja files as story assets, shows errors in the inspector, and plays them with StoryRunner. Works with Mono and IL2CPP.

In Unity: Window → Package Manager → + → Add package from git URL, and paste:

https://git.halfhumangames.com/snarlynarwhal/Bruja.git?path=/unity/com.halfhumangames.bruja#v1.0.0

Then see Unity in the docs. The repository also has a sample project in unity/SampleProject.

.NET runtime and compiler

For any C# game, engine or tool. Both target .NET Standard 2.1 and .NET 10.

dotnet add package Bruja.Runtime    # plays compiled stories (MIT)
dotnet add package Bruja.Compiler   # compiles .bruja source (MPL-2.0)

Ship the compiler only if your game compiles stories at runtime, for example for mods. Using stories in games covers the API.

Command line

Play stories in the terminal, check them for errors (great in CI), compile them ahead of time, manage localization (line IDs, string tables, checking translations), or open a REPL. Needs the .NET SDK.

dotnet tool install -g Bruja.Cli

bruja -f story.bruja          # play
bruja check -f story.bruja    # errors and warnings
bruja                      # REPL
bruja lines add -f story.bruja                 # give every line a #line: ID
bruja lines export -f story.bruja -o lines.csv  # the table for translators
bruja lines import -f story.bruja -i fr.csv     # check a string table

VS Code extension

Highlighting, errors and warnings as you type, and a Run button that plays the file in a terminal. It uses the command line above.

Build it from editors/vscode in the repository (npm install, then npm run package) and install the .vsix with Extensions: Install from VSIX…. Details.

Source

Everything is open source. Releases, issues and the full history live on the repository.

git clone https://git.halfhumangames.com/snarlynarwhal/Bruja.git
cd Bruja
dotnet build && dotnet test

Licences

Runtime, Unity packageMIT: use in any game, commercial or not.
CompilerMPL-2.0: can ship inside games, for mods or runtime compiling.
Command line, web IDE, VS Code extensionAGPL-3.0
Your storiesYours.