X-Git-Url: https://git.lizzy.rs/?a=blobdiff_plain;f=doc%2Fmenu_lua_api.txt;fp=doc%2Fmenu_lua_api.txt;h=4861ed0d9c36faaf1b80aab138ed1aceedeaac64;hb=f4f7c7a11b74d8102afa6b78822830aea551408a;hp=cc1e508c38157ff20a799989fd1034f6ab63f790;hpb=7c0e0c34ecb66e044f59cbab03a4c12fc7838e97;p=dragonfireclient.git 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.