From 403e6e6c9cf6be5e16e3f1f9bd7805fe9b3006cd Mon Sep 17 00:00:00 2001
From: est31 <MTest31@outlook.com>
Date: Tue, 21 Jul 2015 17:17:46 +0200
Subject: [PATCH] Document game main menu image system
---
doc/lua_api.txt | 11 ++++++++++-
1 file changed, 10 insertions(+), 1 deletion(-)
diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index e156d75e4..318c23a76 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -65,6 +65,15 @@ e.g.
The game directory can contain the file minetest.conf, which will be used
to set default settings when running the particular game.
+### Menu images
+
+Games can provide custom main menu images. They are put inside a `menu` directory inside the game directory.
+
+The images are named `$identifier.png`, where `$identifier` is one of `overlay,background,footer,header`.
+If you want to specify multiple images for one identifier, add additional images named like `$identifier.$n.png`, with an ascending number $n starting with 1,
+and a random image will be chosen from the provided ones.
+
+
Mod load path
-------------
Generic:
@@ -1711,7 +1720,7 @@ Helper functions
max_jitter = 0.5, -- maximum packet time jitter
avg_jitter = 0.03, -- average packet time jitter
connection_uptime = 200, -- seconds since client connected
-
+
-- following information is available on debug build only!!!
-- DO NOT USE IN MODS
--ser_vers = 26, -- serialization version used by client
--
GitLab