Skip to content

Commit

Permalink
Bump to 0.1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
ephread committed May 19, 2019
1 parent 0545a1f commit d163724
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 8 deletions.
3 changes: 2 additions & 1 deletion .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
/.gitattributes export-ignore
/.gitignore export-ignore
/.gutconfig.json export-ignore
/.inkgd_compiler.gd export-ignore
/.inkgd_compiler.cfg export-ignore
/.inkgd_ink.cfg export-ignore
/CHANGELOG.md export-ignore
/CONTRIBUTING.md export-ignore
/default_env.tres export-ignore
Expand Down
10 changes: 8 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
# Change Log
Important changes to _inkgd_ will be documented in this file.

## [0.1.0](https://github.com/ephread/Instructions/releases/tag/0.1.0)
Released on 2019-05-18.
## [0.1.1](https://github.com/ephread/inkgd/releases/tag/0.1.1)
Released on 2019-05-19.

### Changed
- Changed the configuration system in two ways: store local paths when it makes sense and split the configuration into two files.

## [0.1.0](https://github.com/ephread/inkgd/releases/tag/0.1.0)
Released on 2019-05-19.

### Added
- Initial release of _inkgd_.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# ![inkgd](https://i.imgur.com/QbLG9Xp.png)

[![CircleCI](https://circleci.com/gh/ephread/inkgd/tree/master.svg?style=shield)](https://circleci.com/gh/ephread/inkgd/tree/master)
![Version](https://img.shields.io/badge/version-0.1.0-orange.svg)
![Godot Version](https://img.shields.io/badge/godot-3.1.1-blue.svg)
![Version](https://img.shields.io/badge/version-0.1.1-orange.svg)
![Godot Version](https://img.shields.io/badge/godot-3.1+-blue.svg)
![License](https://img.shields.io/badge/license-MIT-green.svg)

Implementation of [inkle's Ink] in pure GDScript, with editor support.
Expand Down Expand Up @@ -190,20 +190,27 @@ A new panel should pop up on the right side of your editor.

Here, you need to provide four (or three on Windows) different paths:

- *Mono*: path to mono. _(Note: doesn't appear on Windows)_.
- *Mono*: path to mono _(note: doesn't appear on Windows)_.
- *Executable*: path to inklecate.
- *Source File*: path to the ink file you want to compile.
- *Target File*: output path of the compiled story.

By clicking on "Test", you can test that the plugin can sucessfully run inklecate. You can also compile the story manually by clicking on "Compile".

The configuration is saved as two files inside the root directory of the project:

- `.inkgd_ink.cfg` stores the paths to both the source file and the target file.
- `.inkgd_compiler.cfg` stores the paths to inklecate and the mono runtime.

If you're working in a team, you may want to commit `.inkgd_ink.cfg` and keep `.inkgd_compiler.cfg` out of version control.

[inklecate]: https://github.com/inkle/ink/releases

## Compatibility Table

| _inkgd_ version | inklecate version | Godot version |
|:---------------:|:-----------------:|:-------------:|
| 0.1.0 | 0.8.2 – 0.8.3 | 3.1.1 |
| 0.1.0 – 0.1.1 | 0.8.2 – 0.8.3 | 3.1 – 3.1.1 |

## License

Expand Down
2 changes: 1 addition & 1 deletion addons/inkgd/plugin.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
name="InkGD"
description="Full implementation of inkle's Ink narrative lanaguge in pure GDScript, with editor support."
author="Frédéric Maquin"
version="0.1.0"
version="0.1.1"
script="editor/ink.gd"

0 comments on commit d163724

Please sign in to comment.