diff options
| author | Perttu Ahola <celeron55@gmail.com> | 2013-03-21 20:04:00 +0200 |
|---|---|---|
| committer | Perttu Ahola <celeron55@gmail.com> | 2013-03-21 20:04:00 +0200 |
| commit | adc52f3f3c041e5914f665b6f96d07f49bbb6487 (patch) | |
| tree | ca6b5d26eb63487a9d43d3c3d10a30656c2caeab | |
| parent | 0a568a6037a6e97ffff747fbb7bcb04d0f9c4b16 (diff) | |
| download | minetest-adc52f3f3c041e5914f665b6f96d07f49bbb6487.tar.gz minetest-adc52f3f3c041e5914f665b6f96d07f49bbb6487.tar.bz2 minetest-adc52f3f3c041e5914f665b6f96d07f49bbb6487.zip | |
lua_api.txt: Document paths, games and common mod loading
| -rw-r--r-- | doc/lua_api.txt | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/lua_api.txt b/doc/lua_api.txt index 7d8fa149f..19fa81473 100644 --- a/doc/lua_api.txt +++ b/doc/lua_api.txt @@ -27,6 +27,36 @@ Startup Mods are loaded during server startup from the mod load paths by running 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 ------------- Generic: |