oreolek/ink-instead
1
0
Fork 0
mirror of https://github.com/Oreolek/ink-instead.git synced 2024-06-28 21:04:58 +03:00
Code Issues Releases Wiki Activity

Update README.md

Browse source
This commit is contained in:
Přemek Vyhnal 2017-08-20 18:39:34 +02:00 committed by GitHub
parent bbdbd087d4
commit 88e8994a0b
1 changed files with 16 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -5,9 +5,8 @@ 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._ _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 ## Parser
Supported:
### Parser
- Paragraphs - Paragraphs
- Comments - Comments
- Choices - Choices
@ -19,19 +18,31 @@ _Ink is inkle's scripting language for writing interactive narrative, both for t
- Include - Include
- Tags - Tags
### Runtime API ### Runtime API
Supported:
```lua ```lua
boolean story.canContinue boolean story.canContinue
nil story.continue() string story.continue()
table story.currentChoices table story.currentChoices
nil story.chooseChoiceIndex(index) nil story.chooseChoiceIndex(index)
nil story.choosePathString(path) nil story.choosePathString(path)
table story.globalTags table story.globalTags
table story.tagsForContentAtPath(path) table story.tagsForContentAtPath(path)
table story.currentTags table story.currentTags
number story.state.visitCountAtPathString(path) number story.state.visitCountAtPathString(path)
``` ```
TODO:
```lua
string story.state.toJson()
nil story.state.loadJson(savedJson)
story.variablesState["variable_name"] = newValue
value = story.variablesState["variable_name"]
story.observeVariable ("variable_name", function(string varName, object newValue) )
story.bindExternalFunction ("function_name", function(...))
});
```
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. 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 ## Used by