Skip to content

Commit

Permalink
Switched Common case and Defold
Browse files Browse the repository at this point in the history
  • Loading branch information
astrochili committed Oct 11, 2021
1 parent dc67a65 commit 3006e46
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,22 +95,7 @@ The separated [roadmap](ROADMAP.md) contains the full list of planned tasks, ide

## Installation

### Defold

Add links to the zip-archives of the latest versions of [narrator](https://github.com/astrochili/narrator/releases) and [defold-lpeg](https://github.com/astrochili/defold-lpeg/releases) to your Defold project as [dependencies](http://www.defold.com/manuals/libraries/).

```
https://github.com/astrochili/narrator/archive/master.zip
https://github.com/astrochili/defold-lpeg/archive/master.zip
```

Then you can require the ```narrator``` module.

```lua
local narrator = require('narrator.narrator')
```

### Common case
### Common case (Löve, pure Lua, etc.)

Download the latest [release archive](https://github.com/astrochili/narrator/releases) and require the ```narrator``` module.

Expand All @@ -126,6 +111,21 @@ $ luarocks install lpeg

In fact, you don't need ```lpeg``` in the release, but you need it locally to parse Ink content and generate lua versions of books to play in your game. Use parsing in development only, prefer already parsed and stored books in production.

### Defold

Add links to the zip-archives of the latest versions of [narrator](https://github.com/astrochili/narrator/releases) and [defold-lpeg](https://github.com/astrochili/defold-lpeg/releases) to your Defold project as [dependencies](http://www.defold.com/manuals/libraries/).

```
https://github.com/astrochili/narrator/archive/master.zip
https://github.com/astrochili/defold-lpeg/archive/master.zip
```

Then you can require the ```narrator``` module.

```lua
local narrator = require('narrator.narrator')
```

## Documentation

### narrator.parseFile(path, params)
Expand Down

0 comments on commit 3006e46

Please sign in to comment.