https://github.com/isadorasophia/gum

A dialogue narrative scripting language that integrates with Murder Engine.
https://github.com/isadorasophia/gum

Last synced: about 2 months ago
JSON representation

A dialogue narrative scripting language that integrates with Murder Engine.

• Host: GitHub
• URL: https://github.com/isadorasophia/gum
• Owner: isadorasophia
• License: mit
• Created: 2023-04-02T08:14:09.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-15T07:34:51.000Z (5 months ago)
• Last Synced: 2024-04-21T01:58:47.035Z (5 months ago)
• Language: C#
• Homepage:
• Size: 177 KB
• Stars: 36
• Watchers: 5
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🍬 gum

[![Release](https://github.com/isadorasophia/gum/actions/workflows/ci.yaml/badge.svg)](https://github.com/isadorasophia/gum/actions/workflows/ci.yaml)

[![LICENSE](https://img.shields.io/github/license/isadorasophia/gum.svg)](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

```shell

$ gum.exe  

```

- ``

  - Path of a directory or a single file to all *.gum files.

- `` 

  - Output *.json with C# metadata to be consumed by a third party.

  

#### Example

```shell

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

```