From 52bfbf6ed02e16d11f353c4066a0f4129d045e15 Mon Sep 17 00:00:00 2001
From: ExeVirus <44562154+ExeVirus@users.noreply.github.com>
Date: Mon, 22 Nov 2021 12:26:46 -0500
Subject: Allow for Game-Specific Menu Music (#11241)
---
builtin/mainmenu/dlg_create_world.lua | 2 +-
builtin/mainmenu/game_theme.lua | 203 ++++++++++++++++++++++++++++++++++
builtin/mainmenu/init.lua | 8 +-
builtin/mainmenu/tab_local.lua | 12 +-
builtin/mainmenu/tab_settings.lua | 2 +-
builtin/mainmenu/textures.lua | 185 -------------------------------
6 files changed, 214 insertions(+), 198 deletions(-)
create mode 100644 builtin/mainmenu/game_theme.lua
delete mode 100644 builtin/mainmenu/textures.lua
(limited to 'builtin')
diff --git a/builtin/mainmenu/dlg_create_world.lua b/builtin/mainmenu/dlg_create_world.lua
index 1938747fe..5456eb3eb 100644
--- a/builtin/mainmenu/dlg_create_world.lua
+++ b/builtin/mainmenu/dlg_create_world.lua
@@ -393,7 +393,7 @@ local function create_world_buttonhandler(this, fields)
core.settings:set("menu_last_game",pkgmgr.games[gameindex].id)
if this.data.update_worldlist_filter then
menudata.worldlist:set_filtercriteria(pkgmgr.games[gameindex].id)
- mm_texture.update("singleplayer", pkgmgr.games[gameindex].id)
+ mm_game_theme.update("singleplayer", pkgmgr.games[gameindex].id)
end
menudata.worldlist:refresh()
core.settings:set("mainmenu_last_selected_world",
diff --git a/builtin/mainmenu/game_theme.lua b/builtin/mainmenu/game_theme.lua
new file mode 100644
index 000000000..f8deb29a1
--- /dev/null
+++ b/builtin/mainmenu/game_theme.lua
@@ -0,0 +1,203 @@
+--Minetest
+--Copyright (C) 2013 sapier
+--
+--This program is free software; you can redistribute it and/or modify
+--it under the terms of the GNU Lesser General Public License as published by
+--the Free Software Foundation; either version 2.1 of the License, or
+--(at your option) any later version.
+--
+--This program is distributed in the hope that it will be useful,
+--but WITHOUT ANY WARRANTY; without even the implied warranty of
+--MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+--GNU Lesser General Public License for more details.
+--
+--You should have received a copy of the GNU Lesser General Public License along
+--with this program; if not, write to the Free Software Foundation, Inc.,
+--51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+
+mm_game_theme = {}
+
+--------------------------------------------------------------------------------
+function mm_game_theme.init()
+ mm_game_theme.defaulttexturedir = core.get_texturepath() .. DIR_DELIM .. "base" ..
+ DIR_DELIM .. "pack" .. DIR_DELIM
+ mm_game_theme.basetexturedir = mm_game_theme.defaulttexturedir
+
+ mm_game_theme.texturepack = core.settings:get("texture_path")
+
+ mm_game_theme.gameid = nil
+
+ mm_game_theme.music_handle = nil
+end
+
+--------------------------------------------------------------------------------
+function mm_game_theme.update(tab,gamedetails)
+ if tab ~= "singleplayer" then
+ mm_game_theme.reset()
+ return
+ end
+
+ if gamedetails == nil then
+ return
+ end
+
+ mm_game_theme.update_game(gamedetails)
+end
+
+--------------------------------------------------------------------------------
+function mm_game_theme.reset()
+ mm_game_theme.gameid = nil
+ local have_bg = false
+ local have_overlay = mm_game_theme.set_generic("overlay")
+
+ if not have_overlay then
+ have_bg = mm_game_theme.set_generic("background")
+ end
+
+ mm_game_theme.clear("header")
+ mm_game_theme.clear("footer")
+ core.set_clouds(false)
+
+ mm_game_theme.set_generic("footer")
+ mm_game_theme.set_generic("header")
+
+ if not have_bg then
+ if core.settings:get_bool("menu_clouds") then
+ core.set_clouds(true)
+ else
+ mm_game_theme.set_dirt_bg()
+ end
+ end
+
+ if mm_game_theme.music_handle ~= nil then
+ core.sound_stop(mm_game_theme.music_handle)
+ end
+end
+
+--------------------------------------------------------------------------------
+function mm_game_theme.update_game(gamedetails)
+ if mm_game_theme.gameid == gamedetails.id then
+ return
+ end
+
+ local have_bg = false
+ local have_overlay = mm_game_theme.set_game("overlay",gamedetails)
+
+ if not have_overlay then
+ have_bg = mm_game_theme.set_game("background",gamedetails)
+ end
+
+ mm_game_theme.clear("header")
+ mm_game_theme.clear("footer")
+ core.set_clouds(false)
+
+ if not have_bg then
+
+ if core.settings:get_bool("menu_clouds") then
+ core.set_clouds(true)
+ else
+ mm_game_theme.set_dirt_bg()
+ end
+ end
+
+ mm_game_theme.set_game("footer",gamedetails)
+ mm_game_theme.set_game("header",gamedetails)
+
+ mm_game_theme.gameid = gamedetails.id
+end
+
+--------------------------------------------------------------------------------
+function mm_game_theme.clear(identifier)
+ core.set_background(identifier,"")
+end
+
+--------------------------------------------------------------------------------
+function mm_game_theme.set_generic(identifier)
+ --try texture pack first
+ if mm_game_theme.texturepack ~= nil then
+ local path = mm_game_theme.texturepack .. DIR_DELIM .."menu_" ..
+ identifier .. ".png"
+ if core.set_background(identifier,path) then
+ return true
+ end
+ end
+
+ if mm_game_theme.defaulttexturedir ~= nil then
+ local path = mm_game_theme.defaulttexturedir .. DIR_DELIM .."menu_" ..
+ identifier .. ".png"
+ if core.set_background(identifier,path) then
+ return true
+ end
+ end
+
+ return false
+end
+
+--------------------------------------------------------------------------------
+function mm_game_theme.set_game(identifier, gamedetails)
+
+ if gamedetails == nil then
+ return false
+ end
+
+ mm_game_theme.set_music(gamedetails)
+
+ if mm_game_theme.texturepack ~= nil then
+ local path = mm_game_theme.texturepack .. DIR_DELIM ..
+ gamedetails.id .. "_menu_" .. identifier .. ".png"
+ if core.set_background(identifier, path) then
+ return true
+ end
+ end
+
+ -- Find out how many randomized textures the game provides
+ local n = 0
+ local filename
+ local menu_files = core.get_dir_list(gamedetails.path .. DIR_DELIM .. "menu", false)
+ for i = 1, #menu_files do
+ filename = identifier .. "." .. i .. ".png"
+ if table.indexof(menu_files, filename) == -1 then
+ n = i - 1
+ break
+ end
+ end
+ -- Select random texture, 0 means standard texture
+ n = math.random(0, n)
+ if n == 0 then
+ filename = identifier .. ".png"
+ else
+ filename = identifier .. "." .. n .. ".png"
+ end
+
+ local path = gamedetails.path .. DIR_DELIM .. "menu" ..
+ DIR_DELIM .. filename
+ if core.set_background(identifier, path) then
+ return true
+ end
+
+ return false
+end
+
+--------------------------------------------------------------------------------
+function mm_game_theme.set_dirt_bg()
+ if mm_game_theme.texturepack ~= nil then
+ local path = mm_game_theme.texturepack .. DIR_DELIM .."default_dirt.png"
+ if core.set_background("background", path, true, 128) then
+ return true
+ end
+ end
+
+ -- Use universal fallback texture in textures/base/pack
+ local minimalpath = defaulttexturedir .. "menu_bg.png"
+ core.set_background("background", minimalpath, true, 128)
+end
+
+--------------------------------------------------------------------------------
+function mm_game_theme.set_music(gamedetails)
+ if mm_game_theme.music_handle ~= nil then
+ core.sound_stop(mm_game_theme.music_handle)
+ end
+ local music_path = gamedetails.path .. DIR_DELIM .. "menu" .. DIR_DELIM .. "theme"
+ mm_game_theme.music_handle = core.sound_play(music_path, true)
+end
diff --git a/builtin/mainmenu/init.lua b/builtin/mainmenu/init.lua
index 0c8578cd6..8e716c2eb 100644
--- a/builtin/mainmenu/init.lua
+++ b/builtin/mainmenu/init.lua
@@ -35,7 +35,7 @@ dofile(menupath .. DIR_DELIM .. "async_event.lua")
dofile(menupath .. DIR_DELIM .. "common.lua")
dofile(menupath .. DIR_DELIM .. "pkgmgr.lua")
dofile(menupath .. DIR_DELIM .. "serverlistmgr.lua")
-dofile(menupath .. DIR_DELIM .. "textures.lua")
+dofile(menupath .. DIR_DELIM .. "game_theme.lua")
dofile(menupath .. DIR_DELIM .. "dlg_config_world.lua")
dofile(menupath .. DIR_DELIM .. "dlg_settings_advanced.lua")
@@ -87,7 +87,7 @@ local function init_globals()
core.settings:set("menu_last_game", default_game)
end
- mm_texture.init()
+ mm_game_theme.init()
-- Create main tabview
local tv_main = tabview_create("maintab", {x = 12, y = 5.4}, {x = 0, y = 0})
@@ -113,7 +113,7 @@ local function init_globals()
if tv_main.current_tab == "local" then
local game = pkgmgr.find_by_gameid(core.settings:get("menu_last_game"))
if game == nil then
- mm_texture.reset()
+ mm_game_theme.reset()
end
end
@@ -121,8 +121,6 @@ local function init_globals()
tv_main:show()
ui.update()
-
- core.sound_play("main_menu", true)
end
init_globals()
diff --git a/builtin/mainmenu/tab_local.lua b/builtin/mainmenu/tab_local.lua
index be5f905ac..2d1a616a8 100644
--- a/builtin/mainmenu/tab_local.lua
+++ b/builtin/mainmenu/tab_local.lua
@@ -54,7 +54,7 @@ if enable_gamebar then
for key,value in pairs(fields) do
for j=1,#pkgmgr.games,1 do
if ("game_btnbar_" .. pkgmgr.games[j].id == key) then
- mm_texture.update("singleplayer", pkgmgr.games[j])
+ mm_game_theme.update("singleplayer", pkgmgr.games[j])
core.set_topleft_text(pkgmgr.games[j].name)
core.settings:set("menu_last_game",pkgmgr.games[j].id)
menudata.worldlist:set_filtercriteria(pkgmgr.games[j].id)
@@ -323,7 +323,7 @@ local function main_button_handler(this, fields, name, tabdata)
create_world_dlg:set_parent(this)
this:hide()
create_world_dlg:show()
- mm_texture.update("singleplayer", current_game())
+ mm_game_theme.update("singleplayer", current_game())
return true
end
@@ -340,7 +340,7 @@ local function main_button_handler(this, fields, name, tabdata)
delete_world_dlg:set_parent(this)
this:hide()
delete_world_dlg:show()
- mm_texture.update("singleplayer",current_game())
+ mm_game_theme.update("singleplayer",current_game())
end
end
@@ -358,7 +358,7 @@ local function main_button_handler(this, fields, name, tabdata)
configdialog:set_parent(this)
this:hide()
configdialog:show()
- mm_texture.update("singleplayer",current_game())
+ mm_game_theme.update("singleplayer",current_game())
end
end
@@ -375,7 +375,7 @@ if enable_gamebar then
if game then
menudata.worldlist:set_filtercriteria(game.id)
core.set_topleft_text(game.name)
- mm_texture.update("singleplayer",game)
+ mm_game_theme.update("singleplayer",game)
end
singleplayer_refresh_gamebar()
@@ -387,7 +387,7 @@ if enable_gamebar then
gamebar:hide()
end
core.set_topleft_text("")
- mm_texture.update(new_tab,nil)
+ mm_game_theme.update(new_tab,nil)
end
end
end
diff --git a/builtin/mainmenu/tab_settings.lua b/builtin/mainmenu/tab_settings.lua
index f06e35872..29f3c9b62 100644
--- a/builtin/mainmenu/tab_settings.lua
+++ b/builtin/mainmenu/tab_settings.lua
@@ -247,7 +247,7 @@ local function handle_settings_buttons(this, fields, tabname, tabdata)
adv_settings_dlg:set_parent(this)
this:hide()
adv_settings_dlg:show()
- --mm_texture.update("singleplayer", current_game())
+ --mm_game_theme.update("singleplayer", current_game())
return true
end
if fields["cb_smooth_lighting"] then
diff --git a/builtin/mainmenu/textures.lua b/builtin/mainmenu/textures.lua
deleted file mode 100644
index a3acbbdec..000000000
--- a/builtin/mainmenu/textures.lua
+++ /dev/null
@@ -1,185 +0,0 @@
---Minetest
---Copyright (C) 2013 sapier
---
---This program is free software; you can redistribute it and/or modify
---it under the terms of the GNU Lesser General Public License as published by
---the Free Software Foundation; either version 2.1 of the License, or
---(at your option) any later version.
---
---This program is distributed in the hope that it will be useful,
---but WITHOUT ANY WARRANTY; without even the implied warranty of
---MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
---GNU Lesser General Public License for more details.
---
---You should have received a copy of the GNU Lesser General Public License along
---with this program; if not, write to the Free Software Foundation, Inc.,
---51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-
-
-mm_texture = {}
-
---------------------------------------------------------------------------------
-function mm_texture.init()
- mm_texture.defaulttexturedir = core.get_texturepath() .. DIR_DELIM .. "base" ..
- DIR_DELIM .. "pack" .. DIR_DELIM
- mm_texture.basetexturedir = mm_texture.defaulttexturedir
-
- mm_texture.texturepack = core.settings:get("texture_path")
-
- mm_texture.gameid = nil
-end
-
---------------------------------------------------------------------------------
-function mm_texture.update(tab,gamedetails)
- if tab ~= "singleplayer" then
- mm_texture.reset()
- return
- end
-
- if gamedetails == nil then
- return
- end
-
- mm_texture.update_game(gamedetails)
-end
-
---------------------------------------------------------------------------------
-function mm_texture.reset()
- mm_texture.gameid = nil
- local have_bg = false
- local have_overlay = mm_texture.set_generic("overlay")
-
- if not have_overlay then
- have_bg = mm_texture.set_generic("background")
- end
-
- mm_texture.clear("header")
- mm_texture.clear("footer")
- core.set_clouds(false)
-
- mm_texture.set_generic("footer")
- mm_texture.set_generic("header")
-
- if not have_bg then
- if core.settings:get_bool("menu_clouds") then
- core.set_clouds(true)
- else
- mm_texture.set_dirt_bg()
- end
- end
-end
-
---------------------------------------------------------------------------------
-function mm_texture.update_game(gamedetails)
- if mm_texture.gameid == gamedetails.id then
- return
- end
-
- local have_bg = false
- local have_overlay = mm_texture.set_game("overlay",gamedetails)
-
- if not have_overlay then
- have_bg = mm_texture.set_game("background",gamedetails)
- end
-
- mm_texture.clear("header")
- mm_texture.clear("footer")
- core.set_clouds(false)
-
- if not have_bg then
-
- if core.settings:get_bool("menu_clouds") then
- core.set_clouds(true)
- else
- mm_texture.set_dirt_bg()
- end
- end
-
- mm_texture.set_game("footer",gamedetails)
- mm_texture.set_game("header",gamedetails)
-
- mm_texture.gameid = gamedetails.id
-end
-
---------------------------------------------------------------------------------
-function mm_texture.clear(identifier)
- core.set_background(identifier,"")
-end
-
---------------------------------------------------------------------------------
-function mm_texture.set_generic(identifier)
- --try texture pack first
- if mm_texture.texturepack ~= nil then
- local path = mm_texture.texturepack .. DIR_DELIM .."menu_" ..
- identifier .. ".png"
- if core.set_background(identifier,path) then
- return true
- end
- end
-
- if mm_texture.defaulttexturedir ~= nil then
- local path = mm_texture.defaulttexturedir .. DIR_DELIM .."menu_" ..
- identifier .. ".png"
- if core.set_background(identifier,path) then
- return true
- end
- end
-
- return false
-end
-
---------------------------------------------------------------------------------
-function mm_texture.set_game(identifier, gamedetails)
-
- if gamedetails == nil then
- return false
- end
-
- if mm_texture.texturepack ~= nil then
- local path = mm_texture.texturepack .. DIR_DELIM ..
- gamedetails.id .. "_menu_" .. identifier .. ".png"
- if core.set_background(identifier, path) then
- return true
- end
- end
-
- -- Find out how many randomized textures the game provides
- local n = 0
- local filename
- local menu_files = core.get_dir_list(gamedetails.path .. DIR_DELIM .. "menu", false)
- for i = 1, #menu_files do
- filename = identifier .. "." .. i .. ".png"
- if table.indexof(menu_files, filename) == -1 then
- n = i - 1
- break
- end
- end
- -- Select random texture, 0 means standard texture
- n = math.random(0, n)
- if n == 0 then
- filename = identifier .. ".png"
- else
- filename = identifier .. "." .. n .. ".png"
- end
-
- local path = gamedetails.path .. DIR_DELIM .. "menu" ..
- DIR_DELIM .. filename
- if core.set_background(identifier, path) then
- return true
- end
-
- return false
-end
-
-function mm_texture.set_dirt_bg()
- if mm_texture.texturepack ~= nil then
- local path = mm_texture.texturepack .. DIR_DELIM .."default_dirt.png"
- if core.set_background("background", path, true, 128) then
- return true
- end
- end
-
- -- Use universal fallback texture in textures/base/pack
- local minimalpath = defaulttexturedir .. "menu_bg.png"
- core.set_background("background", minimalpath, true, 128)
-end
--
cgit v1.2.3