oreolek/ink-instead
1
0
Fork 0
mirror of https://github.com/Oreolek/ink-instead.git synced 2024-04-27 22:59:26 +03:00
Code Issues Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Přemek Vyhnal 2017-08-12 23:50:59 +02:00 committed by GitHub
parent faedb6a3be
commit bbdbd087d4
1 changed files with 14 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -17,16 +17,27 @@ _Ink is inkle's scripting language for writing interactive narrative, both for t
- Diverts
- Glue
- Include
- Tags
### Runtime
- state.visitCountAtPathString() - allows the runtime to check if the story went through a scpecific point
### Runtime API
```lua
boolean story.canContinue
nil story.continue()
table story.currentChoices
nil story.chooseChoiceIndex(index)
nil story.choosePathString(path)
table story.globalTags
table story.tagsForContentAtPath(path)
table story.currentTags
number story.state.visitCountAtPathString(path)
```
See [WritingWithInk](https://github.com/inkle/ink/blob/master/Documentation/WritingWithInk.md) and [RunningYourInk](https://github.com/inkle/ink/blob/master/Documentation/RunningYourInk.md) for the description of the reference ink implementation.
## Used by
pink is used by my small game https://github.com/premek/enjoy
Let me know if you want to use it too.
Let me know if you want to use it too - or just use it!
## Install dependencies