aboutsummaryrefslogtreecommitdiff
path: root/doc/world_format.txt
diff options
context:
space:
mode:
authorSmallJoker <SmallJoker@users.noreply.github.com>2022-02-23 21:21:37 +0100
committerGitHub <noreply@github.com>2022-02-23 21:21:37 +0100
commitf7311e0d97cb89bcb197a3e6b89e039151bb510f (patch)
tree47b53f3dce0b11dcb9b9bc985041b1a81148a500 /doc/world_format.txt
parent633e23bd6523d4ff14329e8429c2eaf795e6e128 (diff)
downloadhax-minetest-server-f7311e0d97cb89bcb197a3e6b89e039151bb510f.tar.gz
hax-minetest-server-f7311e0d97cb89bcb197a3e6b89e039151bb510f.zip
Lua API documentation: Various fixes (#12059)
Change 1: Clarify when on_step collision information is provided Change 2: Document PostgreSQL and Redis settings Change 3: Overall AreaStore documentation improvements including consistent parameter naming based on community suggestions
Diffstat (limited to 'doc/world_format.txt')
-rw-r--r--doc/world_format.txt14
1 files changed, 13 insertions, 1 deletions
diff --git a/doc/world_format.txt b/doc/world_format.txt
index 3035c4efb..17923df8e 100644
--- a/doc/world_format.txt
+++ b/doc/world_format.txt
@@ -129,9 +129,9 @@ Example content (added indentation and - explanations):
backend = sqlite3 - which DB backend to use for blocks (sqlite3, dummy, leveldb, redis, postgresql)
player_backend = sqlite3 - which DB backend to use for player data
readonly_backend = sqlite3 - optionally readonly seed DB (DB file _must_ be located in "readonly" subfolder)
+ auth_backend = files - which DB backend to use for authentication data
server_announce = false - whether the server is publicly announced or not
load_mod_<mod> = false - whether <mod> is to be loaded in this world
- auth_backend = files - which DB backend to use for authentication data
For load_mod_<mod>, the possible values are:
@@ -145,6 +145,18 @@ For load_mod_<mod>, the possible values are:
* Other locations and absolute paths are not supported
* Note that `moddir` is the directory name, not the mod name specified in mod.conf.
+PostgreSQL backend specific settings:
+ pgsql_connection = host=127.0.0.1 port=5432 user=mt_user password=mt_password dbname=minetest
+ pgsql_player_connection = (same parameters as above)
+ pgsql_readonly_connection = (same parameters as above)
+ pgsql_auth_connection = (same parameters as above)
+
+Redis backend specific settings:
+ redis_address = 127.0.0.1 - Redis server address
+ redis_hash = foo - Database hash
+ redis_port = 6379 - (optional) connection port
+ redis_password = hunter2 - (optional) server password
+
Player File Format
===================