https://github.com/aistra0528/novelogic
Create interactive fictions in your Godot games.
https://github.com/aistra0528/novelogic
gdscript godot godot-addon interactive-fiction text-adventure
Last synced: 3 months ago
JSON representation
Create interactive fictions in your Godot games.
- Host: GitHub
- URL: https://github.com/aistra0528/novelogic
- Owner: aistra0528
- License: mit
- Created: 2024-05-16T08:13:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-16T09:00:00.000Z (about 1 year ago)
- Last Synced: 2024-05-21T03:19:03.697Z (about 1 year ago)
- Topics: gdscript, godot, godot-addon, interactive-fiction, text-adventure
- Language: GDScript
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Novelogic
Create interactive fictions in your Godot games.
[VSC Extension](https://github.com/aistra0528/novelogic-vsc-extension)
## Get Started
Enable Novelogic in Project Settings > Plugins.
```gdscript
func _ready():
... # Novelogic.signal_name.connect(...)
var timeline = Novelogic.load_timeline("/path/to/file")
Novelogic.start_timeline(timeline)
...
func _on_button_pressed():
Novelogic.handle_next_event()
```
Novelogic uses four spaces for indentation. Don't use tabs.
### Text
```gdscript
signal text_started(text: String)
```
```
Hello!
Hi,
{player}!
```
### Dialogue
```gdscript
signal dialogue_started(who: String, dialogue: String)
```
```
Player: Hello!
Npc: Hi,
{player}!
```
### Label
```
@label
...
<> label_call
...
-> label_jump
@label_call
...
# Return where label called, or end the timeline.
<-
@label_jump
-> timeline_jump
@timeline_jump
-> timeline@label
@timeline_jump_with_variables
<> timeline@label
```
### Assignment
```
# Timeline variables
hp_max = 42
# hp = hp_max if hp is not defined
hp ?= hp_max
hp -= 3 * d(12) + 6
game_over = hp <= 0
log = "HP: {hp}/{hp_max}"
# Global variables
Player.name = "You"
Count.game_over += 1
Flag.hard_mode = true
```
### Condition
```
d = d(6)
if d == 1:
Huh?
elif d == 6:
Nice!
else:
It's {d}.
```
### Choice
```gdscript
signal choice_started(choices: PackedStringArray)
...
func handle_choice(choice: String):
```
```
- Buy something ?: Player.money > 0
...
- Leave
...
...
```
### Input
```gdscript
signal input_started(prompt: String)
...
func handle_input(text: String, escape: bool = true):
```
```
Player.name ?? What's your name?
```
### Call
```gdscript
class_name MyExtension extends NovelogicExtension
...
func do_something(...):
...
```
```gdscript
func _ready():
Novelogic.extension = MyExtension.new()
```
```
do_something(...)
Autoload.do_something(...)
```