Skip to content

Latest commit

 

History

History
44 lines (36 loc) · 1.14 KB

README.md

File metadata and controls

44 lines (36 loc) · 1.14 KB

🍬 gum

Release LICENSE

gum is a tool that converts narrative scripts into a graph that can be read by C# metadata.

Syntax

= new situation
- executed once
+ executed multiple times
() for conditional statements
(...) for else statements, will be part of the same block as above
-> goto
-> exit! stops
@random picks randomly - and + blocks
@[0-9] which [0-9] is the amount of times this block may be executed
[] for actions
c: when referencing components
i: when referencing icons
{variable_name} for referencing variables
// comments
>> title for options section
> option
%[0-9]+ chance of executing lines

Usage

$ gum.exe <scripts_path> <out_path>
  • <scripts_path>
    • Path of a directory or a single file to all *.gum files.
  • <out_path>
    • Output *.json with C# metadata to be consumed by a third party.

Example

$ gum.exe ../game/resources/dialogs ../game/src/project/packed/dialogs