From f4f7c7a11b74d8102afa6b78822830aea551408a Mon Sep 17 00:00:00 2001
From: Wuzzy <wuzzy2@mail.ru>
Date: Wed, 8 Jan 2020 21:27:54 +0000
Subject: Improve Lua API documentation on sounds (#9265)

---
 doc/menu_lua_api.txt | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'doc/menu_lua_api.txt')

diff --git a/doc/menu_lua_api.txt b/doc/menu_lua_api.txt
index cc1e508c3..4861ed0d9 100644
--- a/doc/menu_lua_api.txt
+++ b/doc/menu_lua_api.txt
@@ -244,3 +244,11 @@ Limitations of Async operations
  -Limited set of available functions
 	e.g. No access to functions modifying menu like core.start,core.close,
 	core.show_path_select_dialog
+
+Background music
+----------------
+The main menu supports background music.
+It looks for a `main_menu` sound in `$USER_PATH/sounds`. The same naming
+conventions as for normal sounds apply.
+This means the player can add a custom sound.
+It will be played in the main menu (gain = 1.0), looped.
-- 
cgit v1.2.3