Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
premek authored Jan 14, 2017
1 parent 19c9e86 commit 1bef2c4
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,21 @@ An attempt to implement a subset of [ink](https://github.com/inkle/ink) in lua u

_Ink is inkle's scripting language for writing interactive narrative, both for text-centric games as well as more graphical games that contain highly branching stories._

## Currently supported

- Paragraphs
- Comments
- Choices
- choice and output text
- nested choices
- Knots
- Diverts
- Glue



See https://github.com/inkle/ink/blob/master/Documentation/WritingWithInk.md for the description of the reference ink implementation.

## How to use this to run a game
To use it in your project download the latest source or the latest [release](../../releases). You need just the [pink](../../tree/master/pink) directory.

Expand Down

0 comments on commit 1bef2c4

Please sign in to comment.