Some hints about installation.

Note: this is mostly from memory. I didn't actually test this
as I wrote it but it should be close to what is actually needed
to run this.
This commit is contained in:
Auke Kok 2019-01-28 20:53:05 -08:00
parent 459325b6d9
commit 3a2ef17ce3

View File

@ -69,6 +69,7 @@ about their performance in the box itself, but only on the first
attempt. The performance includes time spent in the box, times died,
and damage taken.
## Constructing
Players can construct new boxes. They do this by entering a pristine
@ -197,3 +198,50 @@ Placement of boxes will use VoxelManips as well as additional metadata
where needed to connect dynamic elements inside the box. These are
subsequently connected to assure proper functioning of the box.
## Running this game
Runnig this game requires a working copy of `lsqlite3`, which can be
obtained through `luarocks`, or manually compiled. You will need to
instal the `lsqite3.so` into a proper location. If you don't have it or
don't know where to put it, minetest's Lua will tell you where it looks.
The game doesn't require `Minetest Game`. It is a full game, not a
subgame or modpack. It requires that you create 2 mods manually outside
the game:
* `localmusic`
the `localmusic` mod is designed to keep music out of the git tree
and instead local to each server. You can find an example `localmusic`
mod as a subfolder of the `music` mod.
* `ranks`
the `ranks` mod is optional and is how `itb` gets ranking data back
from a backend service. Currently, ranking data is time intensive
and takes too long to do in lua, so on the official server this
happens in a separate daemon process. The `ranks` mod reads this data
back in and exposes it through the `ranks` global table.
Additionally, the `db` mod requires to be added to the `secure.trusted_mods`
minetest.conf setting:
```
secure.trusted_mods = db
```
Optional world settings are:
```
lobby_respawn_center = (<x>,<y>,<z>) -- where to respawn players who come back
-- to the lobby
lobby_respawn_radius = <min>,<max> -- use this radius around the center
tutorial_required = <true,false> -- are players required to complete this
tutorial_series = <id> -- number of the tutorial series
tutorial_entry_lobby = <id> -- tutorial entry lobby box_id
tutorial_exit_lobby = <id> -- tutorial exit lobby box_id
tutorial_exit = (<x>,<y>,<z>) -- where to teleport player at end of tutorial
```