Merge branch 'master' into drop

Author: farooqkz

.github/pull_request_template.md

@@ -0,0 +1,3 @@
+
+
+- [ ] This PR has been tested locally

.github/workflows/build.yml

@@ -0,0 +1,10 @@
+name: luacheck
+on: [push, pull_request]
+jobs:
+  luacheck:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Luacheck
+        uses: lunarmodules/luacheck@master

.github/workflows/luacheck.yml

@@ -13,4 +13,6 @@ debug.txt
 /mods/ctf/ctf_map/textures/*Back.*
 /mods/ctf/ctf_map/textures/*Left.*
 /mods/ctf/ctf_map/textures/*Right.*
-/mods/ctf/ctf_map/textures/*_screenshot.png
+/mods/ctf/ctf_map/textures/*_screenshot.png
+
+*.blend1

.gitignore

@@ -45,22 +45,22 @@ Note that this version may be slightly behind the git version, but it will be a
 * If you use Visual Studio Code we recommend these extensions:
   * https://marketplace.visualstudio.com/items?itemName=sumneko.lua
   * https://marketplace.visualstudio.com/items?itemName=dwenegar.vscode-luacheck
+  * https://marketplace.visualstudio.com/items?itemName=GreenXenith.minetest-tools
 
 ## License
 
 Created by [rubenwardy](https://rubenwardy.com/).
 Developed by [LandarVargan](https://github.com/LoneWolfHT).
 Previous Developers: [savilli](https://github.com/savilli).
 
-Licenses where not specified:
-Code: LGPLv2.1+
-Textures: CC-BY-SA 3.0
-
-### Textures
+Check out [mods/](mods/) to see all the installed mods and their respective licenses.
 
-* [Header](menu/header.png): CC BY-SA 4.0 by xenonca
-* [Background Image](menu/background.png): CC0 (where applicable) by Apelta (Uses [Minetest Game](https://github.com/minetest/minetest_game) textures, the majority of which are licensed CC-BY-SA 3.0). The player skin used is licensed CC-BY-SA 3.0
+Licenses where not specified:\
+Code: [GNU LGPLv2.1+](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html)\
+Media: [CC BY-SA 3.0 Unported](https://creativecommons.org/licenses/by-sa/3.0/)
 
-### Mods
+### Textures
 
-Check out [mods/](mods/) to see all the installed mods and their respective licenses.
+* [Header](menu/header.png): [CC BY 3.0 Unported](https://creativecommons.org/licenses/by/3.0/) by [SuddenSFD](https://github.com/SuddenSFD)
+* [Background Image](menu/background.png): [CC BY-SA 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/) (where applicable) by [GreenBlob](https://github.com/a-blob) (Uses [Minetest Game](https://github.com/minetest/minetest_game) textures, the majority of which are licensed [CC BY-SA 3.0 Unported](https://creativecommons.org/licenses/by-sa/3.0/)). The player skins used are licensed under [CC BY-SA 3.0 Unported](https://creativecommons.org/licenses/by-sa/3.0/)
+* [Icon](menu/icon.png): [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/) by [SuddenSFD](https://github.com/SuddenSFD)

README.md

@@ -6,13 +6,16 @@ index 46c947b6..f4372843 100644
  local hud_ids = {}
 
  local function scaleToDefault(player, field)
-+       return player["get_" .. field](player)
--        -- Scale "hp" or "breath" to the default dimensions
--       local current = player["get_" .. field](player)
--       local nominal = core["PLAYER_MAX_".. field:upper() .. "_DEFAULT"]
--       local max_display = math.max(nominal,
--               math.max(player:get_properties()[field .. "_max"], current))
--       return current / max_display * nominal
++       if field == "health" then
++           return player["get_" .. field](player)
++       else
+            -- Scale "hp" or "breath" to the default dimensions
+            local current = player["get_" .. field](player)
+            local nominal = core["PLAYER_MAX_".. field:upper() .. "_DEFAULT"]
+            local max_display = math.max(nominal,
+                math.max(player:get_properties()[field .. "_max"], current))
+            return current / max_display * nominal
++       end
  end
 
  local function update_builtin_statbars(player)

docs/accurate_statbar.patch

@@ -1,6 +1,9 @@
 CaptureTheFlag Lua API Reference
 ==================================
 
+# Code Style
+* Use tabs for indentation.
+
 # mods/apis/
 This folder contains a collection of mods with the main goal of providing an API
 
@@ -21,7 +24,7 @@ ctf_settings.register("my_setting", {
 	on_change = function(player, new_value)
 		<...>
 	end
-}
+})
 ```
 
 ### `ctf_settings.set(player, setting, value)`
@@ -36,7 +39,10 @@ ctf_settings.register("my_setting", {
 
 ---
 # mods/ctf/
-TODO
+TODO, below is a collection of quick notes for later
+
+## ctf_teams
+* https://modern.ircdocs.horse/formatting.html#colors-16-98
 
 ---
 # mods/mtg/

docs/ctf-api.md

@@ -1,31 +1,48 @@
+local unset_function = "return "
+
 function ctf_gui.show_formspec_dev(player, formname, formspec, formcontext)
 	local filepath = minetest.get_worldpath().."/ctf_gui/"
 	local filename = filepath.."file_edit.txt"
+	local slower_loop = false
+
+	minetest.chat_send_all("Started formspec editing file at "..filename)
 
 	minetest.mkdir(filepath)
 
 	local file = assert(io.open(filename, "w"))
-
-	file:write(formspec)
-
+		if type(formspec) ~= "function" then
+			file:write(formspec)
+		else
+			file:write(unset_function)
+		end
 	file:close()
 
 	local function interval()
-		if formspec:sub(1, 3) == "[f]" then
-			local result, form = pcall(loadstring(formspec:sub(4)), formcontext)
-			ctf_gui.show_formspec(player, formname, result and form or "")
+		if type(formspec) == "function" then
+			ctf_gui.show_formspec(player, formname, formspec(formcontext))
+		elseif formspec:match("^%s*return") then
+			local result, form = pcall((loadstring(formspec) or function() return function() end end)(), formcontext)
+
+			ctf_gui.show_formspec(player, formname,
+				result and form or "size[10,10]hypertext[0,0;10,10;err;"..minetest.formspec_escape(form or "").."]"
+			)
+
+			slower_loop = not result
 		else
 			ctf_gui.show_formspec(player, formname, formspec)
 		end
 
-		minetest.after(1, function()
+		minetest.after(slower_loop and 3 or 1, function()
 			local f = assert(io.open(filename, "r"))
+			local new_form = f:read("*a")
 
-			formspec = f:read("*a")
+			if new_form ~= unset_function then
+				formspec = new_form
+			end
 
 			f:close()
 
-			if formspec:match("^exit") then
+			if type(formspec) == "function" or not formspec:match("^exit") then
 				interval()
 			else
 				minetest.request_shutdown("Formspec dev requested shutdown", true)

menu/background.png

@@ -39,6 +39,7 @@ function ctf_gui.init()
 				local action = ctx._on_formspec_input(pname, ctx, fields, ...)
 
 				if action == "refresh" then
+					minetest.log("action", "Refreshing formspec "..dump(ctx._formname).." to "..dump(pname))
 					minetest.show_formspec(pname, ctx._formname, ctx._formspec(ctx))
 				end
 			end
@@ -115,6 +116,7 @@ function ctf_gui.show_formspec(player, formname, formspec, formcontext)
 	context[player]._formname = formname
 	context[player]._formspec = formspec
 
+	minetest.log("action", "Showing new_formspec "..dump(formname).." to "..dump(player))
 	if type(formspec) == "function" then
 		minetest.show_formspec(player, formname, formspec(formcontext))
 	else
@@ -144,6 +146,7 @@ do
 			end
 		end
 
+		-- minetest.log("action", "[ctf_gui] unpacking: "..dump(l))
 		return format(base, unpck(l))
 	end
 
@@ -457,9 +460,16 @@ function ctf_gui.old_show_formspec(player, formname, formdef)
 		formdef._info = formdef
 		context[player] = formdef
 
-		minetest.show_formspec(player, formname, formspec)
+		if minetest.get_player_by_name(player) then
+			minetest.log("action", "Showing formspec "..dump(formname).." to "..dump(player))
+			minetest.show_formspec(player, formname, formspec)
+		end
 	end,
 	formdef, ctf_gui.ELEM_SIZE, ctf_gui.SCROLLBAR_WIDTH)
 end
 
+minetest.register_on_leaveplayer(function(player)
+	context[player:get_player_name()] = nil
+end)
+
 dofile(minetest.get_modpath("ctf_gui").."/dev.lua")

menu/header.png

@@ -3,7 +3,7 @@ ctf_settings = {
 	settings_list = {},
 }
 
-local FORMSIZE = {x = 8, y = 5}
+local FORMSIZE = {x = 8, y = 9.4}
 local SCROLLBAR_W = 0.4
 
 minetest.after(0, function()
@@ -29,16 +29,35 @@ function ctf_settings.register(name, def)
 	table.insert(ctf_settings.settings_list, name)
 end
 
+---@param player ObjectRef
 function ctf_settings.set(player, setting, value)
 	player:get_meta():set_string("ctf_settings:"..setting, value)
 end
 
+---@param player ObjectRef
 ---@return string Returns the player's chosen setting value, the default given at registration, or if both are unset: ""
 function ctf_settings.get(player, setting)
 	local value = player:get_meta():get_string("ctf_settings:"..setting)
 	local info = ctf_settings.settings[setting]
 
-	return value == "" and info.default or value
+	return value == "" and (info and info.default) or value
+end
+
+-- This Function MIT by Rubenwardy
+--- Creates a scrollbaroptions for a scroll_container
+--
+-- @param visible_l the length of the scroll_container and scrollbar
+-- @param total_l length of the scrollable area
+-- @param scroll_factor as passed to scroll_container
+local function make_scrollbaroptions_for_scroll_container(visible_l, total_l, scroll_factor)
+
+	assert(total_l >= visible_l)
+
+	local thumb_size = (visible_l / total_l) * (total_l - visible_l)
+
+	local max = total_l - visible_l
+
+	return ("scrollbaroptions[min=0;max=%f;thumbsize=%f]"):format(max / scroll_factor, thumb_size / scroll_factor)
 end
 
 minetest.register_on_mods_loaded(function()
@@ -48,30 +67,48 @@ minetest.register_on_mods_loaded(function()
 			local setting_list = {}
 			local lastypos = -0.5
 
+			if not context then
+				context = {}
+			end
+
+			if not context.setting then
+				context.setting = {}
+			end
+
 			for k, setting in ipairs(ctf_settings.settings_list) do
 				local settingdef = ctf_settings.settings[setting]
 
+				if not context.setting[setting] then
+					context.setting[setting] = ctf_settings.get(player, setting)
+				end
+
 				if settingdef.type == "bool" then
 					setting_list[k] = {
 						"checkbox[0,%f;%s;%s;%s]tooltip[%s;%s]",
 						lastypos,
 						setting,
 						settingdef.label or setting,
-						ctf_settings.get(player, setting),
+						context.setting[setting],
 						setting,
 						settingdef.description or HumanReadable(setting)
 					}
 
 					lastypos = lastypos + 0.5
 				elseif settingdef.type == "list" then
+					local max_len = 0
+
+					for _, val in pairs(settingdef.list) do
+						max_len = math.max(val:len(), max_len)
+					end
+
 					lastypos = lastypos + 0.3
 					setting_list[k] = {
 						"dropdown[0,%f;%f;%s;%s;%d]tooltip[0,%f;%f,0.6;%s]",
 						lastypos,
-						FORMSIZE.x/1.7,
+						math.max(FORMSIZE.x / 2, math.min(FORMSIZE.x - SCROLLBAR_W + 2, 0.5 + (max_len * 0.23))),
 						setting,
 						settingdef.list,
-						ctf_settings.get(player, setting),
+						context.setting[setting],
 						--label
 						lastypos,
 						(FORMSIZE.x/1.7) - 0.3,
@@ -84,21 +121,21 @@ minetest.register_on_mods_loaded(function()
 			local form = {
 			{"box[-0.1,-0.1;%f,%f;#00000055]", FORMSIZE.x - SCROLLBAR_W, FORMSIZE.y},
 				{"scroll_container[-0.1,0.3;%f,%f;settings_scrollbar;vertical;0.1]",
-					FORMSIZE.x - SCROLLBAR_W,
+					FORMSIZE.x - SCROLLBAR_W + 2,
 					FORMSIZE.y + 0.7
 				},
 				ctf_gui.list_to_formspec_str(setting_list),
 				"scroll_container_end[]",
-				{"scrollbaroptions[max=%d]", math.ceil((lastypos - 3.833) * 11.538)},
+				make_scrollbaroptions_for_scroll_container(FORMSIZE.y + 0.7, math.max(lastypos+1, FORMSIZE.y + 0.7), 0.1),
 				{"scrollbar[%f,-0.1;%f,%f;vertical;settings_scrollbar;%f]",
 					FORMSIZE.x - SCROLLBAR_W,
 					SCROLLBAR_W,
 					FORMSIZE.y,
-					context and context.settings_scrollbar or 0
+					context.settings_scrollbar or 0
 				},
 			}
 
-			return sfinv.make_formspec(player, context, ctf_gui.list_to_formspec_str(form), true)
+			return sfinv.make_formspec(player, context, ctf_gui.list_to_formspec_str(form), false)
 		end,
 		on_player_receive_fields = function(self, player, context, fields)
 			local refresh = false
@@ -110,24 +147,30 @@ minetest.register_on_mods_loaded(function()
 					if setting.type == "bool" then
 						local newvalue = value == "true" and "true" or "false"
 
-						ctf_settings.set(player, field, newvalue)
+						if context.setting[field] ~= newvalue then
+							context.setting[field] = newvalue
+							ctf_settings.set(player, field, newvalue)
 
-						if setting.on_change then
-							setting.on_change(player, newvalue)
+							if setting.on_change then
+								setting.on_change(player, newvalue)
+							end
+
+							refresh = true
 						end
 					elseif setting.type == "list" then
 						local idx = table.indexof(setting.list, value)
 
-						if idx ~= -1 then
+						if idx ~= -1 and context.setting[field] ~= tostring(idx) then
+							context.setting[field] = tostring(idx)
 							ctf_settings.set(player, field, tostring(idx))
 
 							if setting.on_change then
-								setting.on_change(player, idx)
+								setting.on_change(player, tostring(idx))
 							end
+
+							refresh = true
 						end
 					end
-
-					refresh = true
 				end
 			end