Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Godot-specific ignores
.import/
.godot/
export.cfg
export_presets.cfg
*.pck
Expand Down
20 changes: 16 additions & 4 deletions .gut_editor_config.json
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
{
"background_color": "ff262626",
"compact_mode": false,
"config_file": "res://.gutconfig.json",
"dirs": [
"res://test/unit",
"res://test/integration/runtime",
"res://test/integration/player"
],
"disable_colors": false,
"double_strategy": "partial",
"double_strategy": 1,
"errors_do_not_cause_failure": false,
"font_color": "ffcccccc",
"font_name": "AnonymousPro",
"font_size": 30,
"gut_on_top": true,
"hide_orphans": false,
"ignore_pause": false,
"include_subdirs": false,
Expand All @@ -19,6 +22,17 @@
"junit_xml_timestamp": false,
"log_level": 1,
"opacity": 100,
"paint_after": 0.1,
"panel_options": {
"font_name": "CourierPrime",
"font_size": 30,
"hide_output_text": false,
"hide_result_tree": false,
"hide_settings": false,
"output_font_name": "CourierPrime",
"output_font_size": 30,
"use_colors": false
},
"post_run_script": "",
"pre_run_script": "",
"prefix": "test_",
Expand All @@ -28,8 +42,6 @@
"should_maximize": false,
"show_help": false,
"suffix": ".gd",
"tests": [

],
"tests": [],
"unit_test_name": null
}
17 changes: 17 additions & 0 deletions .gut_editor_shortcuts.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
[main]

run_all=Object(Shortcut,"resource_local_to_scene":false,"resource_name":"","events":[Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":0,"key_label":0,"unicode":0,"echo":false,"script":null)
],"script":null)

run_current_script=Object(Shortcut,"resource_local_to_scene":false,"resource_name":"","events":[Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":0,"key_label":0,"unicode":0,"echo":false,"script":null)
],"script":null)

run_current_inner=Object(Shortcut,"resource_local_to_scene":false,"resource_name":"","events":[Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":0,"key_label":0,"unicode":0,"echo":false,"script":null)
],"script":null)

run_current_test=Object(Shortcut,"resource_local_to_scene":false,"resource_name":"","events":[Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":0,"key_label":0,"unicode":0,"echo":false,"script":null)
],"script":null)

panel_button=Object(Shortcut,"resource_local_to_scene":false,"resource_name":"","events":[Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":0,"key_label":0,"unicode":0,"echo":false,"script":null)
],"script":null)

4 changes: 2 additions & 2 deletions .inkgd_ink.cfg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[inkgd]

stories=[ {
stories=[{
"source_file_path": "res://examples/ink/the_intercept/the_intercept.ink",
"target_file_path": "res://examples/ink/the_intercept/the_intercept.ink.json",
"watched_folder_path": "res://examples/ink/the_intercept/"
Expand All @@ -16,7 +16,7 @@ stories=[ {
"source_file_path": "res://examples/ink/not_a_halloween_game/not_a_halloween_game.ink",
"target_file_path": "res://examples/ink/not_a_halloween_game/not_a_halloween_game.ink.json",
"watched_folder_path": "res://examples/ink/not_a_halloween_game"
} ]
}]

[format]

Expand Down
20 changes: 18 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,24 @@
# Change Log
Important changes to _inkgd_ will be documented in this file.

## [0.6.0](https://github.com/ephread/inkgd/releases/tag/0.6.0)
Released on 2023-XX-XX.

### Added
- Added support for Godot 4.1.1+

### Changed

#### ⚠️ **BREAKING CHANGE**
- Reorganized files internally and updated type names.
- [`InkStory`] Renamed `continue`, `continue_async` and `continue_maximally` to
`continue_story`, `continue_story_async` and `continue_story_maximally` due to keyword conflicts.
- [`InkVariableStates`] Renamed `get` and `set` to `get_variable` and `set_variable` due to keyword conflicts.
- [`InkPlayer`] Renamed `continue`, `continue_async`, `continue_maximally`, `get` and `set` to
`continue_story`, `continue_story_async`, `continue_story_maximally`, `get_variable` and `set_variable` due to keyword conflicts.

## [0.5.0](https://github.com/ephread/inkgd/releases/tag/0.5.0)
Released on 2024-08-28.
Released on 2023-08-28.

### Changed
- Added support for inklecate 1.1.1.
Expand All @@ -17,7 +33,7 @@ Released on 2024-08-28.
Released on 2022-08-07.

### Fixed
- Add missing `add_child` call in templates.
- Added missing `add_child` call in templates.

## [0.4.6](https://github.com/ephread/inkgd/releases/tag/0.4.6)
Released on 2022-07-31.
Expand Down
23 changes: 14 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,17 @@

[![build](https://github.com/ephread/inkgd/workflows/build/badge.svg)](https://github.com/ephread/inkgd/actions)
[![Documentation Status](https://readthedocs.org/projects/inkgd/badge/?version=latest)](https://inkgd.readthedocs.io/en/latest/?badge=latest)
![Version](https://img.shields.io/badge/version-0.5.0-orange.svg)
![Version](https://img.shields.io/badge/version-0.6.0-orange.svg)
![Godot Version](https://img.shields.io/badge/godot-3.3+-blue.svg)
![License](https://img.shields.io/badge/license-MIT-green.svg)

Implementation of [inkle’s Ink] in pure GDScript, with editor support.

⚠️ **Note:** While the implementation of the runtime is feature-complete and
passes the test suite, it’s unlikely to ever be considered “production-ready”.
_inkgd_ shines for rapid-prototyping in GDScript and small games, but for bigger
projects it’s likely to be too slow. If you need a more bulletproof solution
and don’t mind C#, you should consider using [godot-ink].
📖 **Note:** _inkgd_ shines for rapid prototyping in GDScript and small games.
While the runtime implementation is feature-complete and passes the
test suite, it’s slower than the original C# implementation. It is used
in commercial games, but if you need a faster solution and don’t mind C#,
you should consider using [godot-ink].

[inkle’s Ink]: https://github.com/inkle/ink
[godot-ink]: https://github.com/paulloz/godot-ink
Expand Down Expand Up @@ -41,14 +41,14 @@ and don’t mind C#, you should consider using [godot-ink].
- [x] Integrated story previewer

## Requirements
- Godot 3.3+
- Inklecate 1.0.0+
- Godot 4.1.1+
- Inklecate 1.1.1+

## Asking Questions / Contributing

### Asking questions

If you need help with something in particular, [start a discussion].
If you need help with something, [start a discussion].
If you want to report a problem, [open an issue].

[start a discussion]: https://github.com/ephread/inkgd/discussions/new
Expand Down Expand Up @@ -83,6 +83,7 @@ hosted on [Read The Docs].
| 0.3.0 | 1.0.0 | 3.2 – 3.4 |
| 0.4.0 – 0.4.7 | 1.0.0 | 3.3 – 3.5 |
| 0.5.0 | 1.1.1 | 3.3 – 3.5 |
| 0.6.0 | 1.1.1 | 4.1.1 |

## Acknowledgement

Expand Down Expand Up @@ -117,6 +118,10 @@ hosted on [Read The Docs].

[video series]: https://www.youtube.com/playlist?list=PLtepyzbiiwBrHoTloHJ2B-DWQxgrseuMB

## Sponsors

[![WILD WITS Games](docs/source/img/wild_wits_logo.webp)](https://wildwits.games)

## License

_inkgd_ is released under the MIT license. See LICENSE for details.
Loading