mirror of
https://github.com/Oreolek/ink-instead.git
synced 2024-07-08 01:24:39 +03:00
Update README.md
This commit is contained in:
parent
5a52de4270
commit
19c9e86efb
48
README.md
48
README.md
|
@ -1,7 +1,54 @@
|
|||
# pink
|
||||
An attempt to implement a subset of [ink](https://github.com/inkle/ink) in lua using [lpeg](http://www.inf.puc-rio.br/~roberto/lpeg)
|
||||
|
||||
_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._
|
||||
|
||||
## 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.
|
||||
|
||||
### Example
|
||||
Given some .ink file like below, you can easily run it in your lua application using the pink library.
|
||||
|
||||
```ink
|
||||
=== back_in_london ===
|
||||
We arrived into London at 9.45pm exactly.
|
||||
* "There is not a moment to lose!"[] I declared. -> hurry_outside
|
||||
* "Monsieur, let us savour this moment!"[] I declared.
|
||||
My master clouted me firmly around the head and dragged me out of the door.
|
||||
-> dragged_outside
|
||||
|
||||
=== hurry_outside ===
|
||||
We hurried home to Savile Row -> as_fast_as_we_could
|
||||
|
||||
=== dragged_outside ===
|
||||
He insisted that we hurried home to Savile Row
|
||||
-> as_fast_as_we_could
|
||||
|
||||
=== as_fast_as_we_could ===
|
||||
<> as fast as we could.
|
||||
```
|
||||
|
||||
|
||||
```lua
|
||||
local pink = require('pink.pink')
|
||||
-- 1) Load story
|
||||
local story = pink.getStory('examples/game.ink')
|
||||
while true do
|
||||
-- 2) Game content, line by line
|
||||
while story.canContinue do
|
||||
print(story.continue())
|
||||
end
|
||||
-- 3) Display story.currentChoices list, allow player to choose one
|
||||
for i = 1, #story.currentChoices do
|
||||
print(i .. "> " .. story.currentChoices[i].text)
|
||||
end
|
||||
if #story.currentChoices == 0 then break end -- cannot continue and there are no choices
|
||||
local answer=io.read()
|
||||
print (story.currentChoices[tonumber(answer)].choiceText)
|
||||
story.chooseChoiceIndex(answer)
|
||||
end
|
||||
```
|
||||
|
||||
See the examples directory for a simple text based example and a LÖVE integration.
|
||||
|
||||
This is how to run the text-based example:
|
||||
|
@ -13,7 +60,6 @@ And this example shows [LÖVE](https://love2d.org) integration:
|
|||
$ love examples/love2d
|
||||
|
||||
<!-- TODO: short example here -->
|
||||
To use it in your project download the latest source or the latest [release](../../releases). You need just the [pink](../../tree/master/pink) directory.
|
||||
|
||||
## How to run tests
|
||||
$ lua test.lua
|
||||
|
|
Loading…
Reference in a new issue