|
|
# Developer Documentation
|
|
|
|
|
|
VOADI is built with Solarus Engine 1.5.3.
|
|
|
Because of this, most of what you need to know is already covered by the [Solarus Quest Documentation](http://www.solarus-games.org/doc/1.5/).
|
|
|
|
|
|
Here are some key points:
|
|
|
* It's scripted in [Lua](https://www.lua.org/pil/contents.html).
|
|
|
* The engine's entry point is hardcoded to `data/main.lua`.
|
|
|
All other scripts are imported from here.
|
|
|
* Game assets are indexed in `data/project_db.dat`.
|
|
|
* Game assets also have hardcoded paths in the engine.
|
|
|
For example, maps must exist in `data/maps`, and sprites in `data/sprites`.
|
|
|
* [Solarus Quest Editor](http://www.solarus-games.org/engine/solarus-quest-editor/) is your friend.
|
|
|
It abstracts most of this complexity into a nice GUI.
|
|
|
|
|
|
## Custom Lua API
|
|
|
|
|
|
VOADI contains customizations to the Solarus Engine Lua API, as well as some custom items and entities.
|
|
|
That's documented here.
|
|
|
|
|
|
* [Lua API changes](docs/lua-api)
|
|
|
|
|
|
## Installing Solarus Quest Editor
|
|
|
|
|
|
Following the directions on [*Running the Game*](../running-the-game) will get you mostly set-up for development.
|
|
|
Run `sudo apt install -y solarus-quest-editor` if you haven't, then launch it and choose `File > Load Quest...`, selecting the `voadi` project folder. |