minetest
/
minetest
mirror of https://github.com/minetest/minetest.git
1
0
Fork 0
Code Issues Releases Wiki Activity

lua_api.txt: Document paths, games and common mod loading

This commit is contained in:
Perttu Ahola 2013-03-21 20:04:00 +02:00
parent 0a568a6037
commit adc52f3f3c
1 changed files with 30 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
doc/lua_api.txt
View File

@ -27,6 +27,36 @@ Startup
Mods are loaded during server startup from the mod load paths by running Mods are loaded during server startup from the mod load paths by running
the init.lua scripts in a shared environment. the init.lua scripts in a shared environment.
Paths
-----
RUN_IN_PLACE=1: (Windows release, local build)
$path_user: Linux: <build directory>
Windows: <build directory>
$path_share: Linux: <build directory>
Windows: <build directory>
RUN_IN_PLACE=0: (Linux release)
$path_share: Linux: /usr/share/minetest
Windows: <install directory>/minetest-0.4.x
$path_user: Linux: ~/.minetest
Windows: C:/users/<user>/AppData/minetest (maybe)
Games
-----
Games are looked up from:
$path_share/games/gameid/
$path_user/games/gameid/
where gameid is unique to each game.
The game directory contains the file game.conf, which contains these fields:
name = <Human-readable full name of the game>
common_mods = <Comma-separated list of common mods>
eg.
name = Minetest
common_mods = bucket, default, doors, fire, stairs
Common mods are loaded from the pseudo-game "common".
Mod load path Mod load path
------------- -------------
Generic: Generic: