diff --git a/README.md b/README.md index 748008a..4ecd9a5 100644 --- a/README.md +++ b/README.md @@ -9,12 +9,14 @@ The file *formspec.spec* in your: ```minetest_folder/games/formspec_editor/mods/formspec_edit``` -contains a formspec you can edit and see updates of in real time. +contains a formspec you can edit and see updates of in real time. (You can also specify a file location with the `formspec_editor.file_path` setting.) Simply add the game to MT, load up a level of *Formspec Editor*, and -you will be greeted with the *formspec.spec* formspec. +you will be greeted with the formspec. -- To make edits, open the file (formspec.spec) in your editor of choice and make changes as you see fit. When you hit save, the formspec will auto-update. Best when used side by side. +- To make edits, open the file in your editor of choice and make changes as you see fit. When you hit save, the formspec will auto-update. Best when used side by side. - To exit just hit or use a button_exit[] button. Both send the fields.quit message. - You can test with images if you want, adding a "textures" folder to the formspec_edit gamemod folder, otherwise images will default to random colors. +- You can show the formspec with builtin, minetest_game or mineclone2 styling (see the `formspec_editor.style` setting) +- You can change the refresh rate by changing the `formspec_editor.update_time` setting diff --git a/mods/formspec_edit/init.lua b/mods/formspec_edit/init.lua index 4ec4af5..5a38e08 100644 --- a/mods/formspec_edit/init.lua +++ b/mods/formspec_edit/init.lua @@ -10,6 +10,7 @@ minetest.register_alias("mapgen_water_source", "air") --Variables local modpath = minetest.get_modpath("formspec_edit") local insecure_env = minetest.request_insecure_environment() +local io = insecure_env.io local update_time = tonumber(minetest.settings:get("formspec_editor.update_time")) or 0.2 --Load provided file if present @@ -18,6 +19,12 @@ if not filepath or filepath == "" then filepath = modpath .. "/formspec.spec" end +--Get styling presets +local styling = minetest.settings:get("formspec_editor.style") +if not styling or styling == "" then + styling = "builtin" +end + local error_formspec = [[ formspec_version[4] size[8,2] @@ -31,51 +38,12 @@ if not minetest.is_singleplayer() then error("[formspec_editor] This game doesn't work in multiplayer!") end ---function declarations -local update_formspec = nil -local load_formspec = nil -local turn_off_hud = nil -local set_sky - ---Registrations - ------------------------------------ ---on_joinplayer() ------------------------------------ -minetest.register_on_joinplayer( -function(player_ref,_) - turn_off_hud(player_ref) - set_sky(player_ref) -end -) ------------------------------------ ---on_player_receive_fields() ------------------------------------ -minetest.register_on_player_receive_fields( -function(player_ref, _, fields) - if(fields.quit) then - minetest.request_shutdown() - end - update_formspec(player_ref:get_player_name()) -end -) - --function definitions ------------------------------------ ---update_formspec() ------------------------------------ -update_formspec = function(player_name) - minetest.after(0.1, function(name) - minetest.show_formspec(name, "fs", load_formspec()) - end, player_name) -end - ----------------------------------- --load_formspec() ----------------------------------- -load_formspec = function() - local io = insecure_env.io +local function load_formspec() local file = io.open(filepath, "rb") if file == nil then return error_formspec @@ -90,11 +58,58 @@ load_formspec = function() end end +----------------------------------- +--update_formspec() +----------------------------------- +local function update_formspec(player_name) + minetest.after(0.1, function(name) + minetest.show_formspec(name, "fs", load_formspec()) + end, player_name) +end + +----------------------------------- +--apply_styling() +----------------------------------- +local function apply_styling(player_ref) + local prepend = "" + if styling == "minetest_game" then + ------------------------------------------------ + ---------------Minetest Game code--------------- + ------------------------------------------------ + prepend = [[ + bgcolor[#080808BB;true] + listcolors[#00000069;#5A5A5A;#141318;#30434C;#FFF] + ]] + local name = player_ref:get_player_name() + local info = minetest.get_player_information(name) + if info.formspec_version > 1 then + prepend = prepend .. "background9[5,5;1,1;mtg_gui_formbg.png;true;10]" + else + prepend = prepend .. "background[5,5;1,1;mtg_gui_formbg.png;true]" + end + elseif styling == "mineclone2" then + ------------------------------------------------ + ---------------MineClone2 code------------------ + ------------------------------------------------ + --Sadly, this code doesn't support inventory slot styling (texture based) + prepend = "listcolors[#9990;#FFF7;#FFF0;#000;#FFF]".. + "style_type[image_button;border=false;bgimg=mcl_inventory_button9.png;bgimg_pressed=mcl_inventory_button9_pressed.png;bgimg_middle=2,2]".. + "style_type[button;border=false;bgimg=mcl_inventory_button9.png;bgimg_pressed=mcl_inventory_button9_pressed.png;bgimg_middle=2,2]".. + "style_type[field;textcolor=#323232]".. + "style_type[label;textcolor=#323232]".. + "style_type[textarea;textcolor=#323232]".. + "style_type[checkbox;textcolor=#323232]".. + "bgcolor[#00000000]".. + "background9[1,1;1,1;mcl_base_textures_background9.png;true;7]" + end + player_ref:set_formspec_prepend(prepend) +end + ----------------------------------- --turn_off_hud() ----------------------------------- -turn_off_hud = function(player_ref) - local flags = { +local function turn_off_hud(player_ref) + player_ref:hud_set_flags({ hotbar = false, healthbar = false, crosshair = false, @@ -102,28 +117,49 @@ turn_off_hud = function(player_ref) breathbar = false, minimap = false, minimap_radar = false, - } - player_ref:hud_set_flags(flags) + }) end ----------------------------------- --set_sky() ----------------------------------- -set_sky = function(player_ref) - local sky = { +local function set_sky(player_ref) + player_ref:set_sky({ base_color = "#AAF", type = "plain", clouds = false, - } - player_ref:set_sky(sky) + }) + player_ref:set_stars({visible = false}) + player_ref:set_sun({visible = false}) + player_ref:set_moon({visible = false}) player_ref:override_day_night_ratio(0) end +--Registrations + +----------------------------------- +--on_joinplayer() +----------------------------------- +minetest.register_on_joinplayer(function(player_ref,_) + apply_styling(player_ref) + turn_off_hud(player_ref) + set_sky(player_ref) +end) +----------------------------------- +--on_player_receive_fields() +----------------------------------- +minetest.register_on_player_receive_fields(function(player_ref, _, fields) + if fields.quit then + minetest.request_shutdown() + end + update_formspec(player_ref:get_player_name()) +end) + local time = 0 minetest.register_globalstep(function(dtime) time = time + dtime if time >= update_time then - local player = minetest.get_connected_players()[1] + local player = minetest.get_connected_players()[1] --The game isn't supposed to work in multiplayer if player then update_formspec(player:get_player_name()) end diff --git a/mods/formspec_edit/textures/CREDITS.md b/mods/formspec_edit/textures/CREDITS.md new file mode 100644 index 0000000..15fba50 --- /dev/null +++ b/mods/formspec_edit/textures/CREDITS.md @@ -0,0 +1,9 @@ +These textures are copied from Minetest Game and MineClone2 projects + +# Minetest Game (CC BY-SA 3.0) +mtg_gui_formbg.png + +# MineClone2 (CC BY-SA 3.0) +mcl_inventory_button9.png +mcl_inventory_button9_pressed.png +mcl_base_textures_background9.png \ No newline at end of file diff --git a/mods/formspec_edit/textures/mcl2/mcl_base_textures_background9.png b/mods/formspec_edit/textures/mcl2/mcl_base_textures_background9.png new file mode 100644 index 0000000..e5d693e Binary files /dev/null and b/mods/formspec_edit/textures/mcl2/mcl_base_textures_background9.png differ diff --git a/mods/formspec_edit/textures/mcl2/mcl_inventory_button9.png b/mods/formspec_edit/textures/mcl2/mcl_inventory_button9.png new file mode 100644 index 0000000..aab1601 Binary files /dev/null and b/mods/formspec_edit/textures/mcl2/mcl_inventory_button9.png differ diff --git a/mods/formspec_edit/textures/mcl2/mcl_inventory_button9_pressed.png b/mods/formspec_edit/textures/mcl2/mcl_inventory_button9_pressed.png new file mode 100644 index 0000000..aeaea13 Binary files /dev/null and b/mods/formspec_edit/textures/mcl2/mcl_inventory_button9_pressed.png differ diff --git a/mods/formspec_edit/textures/mtg/mtg_gui_formbg.png b/mods/formspec_edit/textures/mtg/mtg_gui_formbg.png new file mode 100644 index 0000000..e259fec Binary files /dev/null and b/mods/formspec_edit/textures/mtg/mtg_gui_formbg.png differ diff --git a/settingtypes.txt b/settingtypes.txt index f23715d..fe15730 100644 --- a/settingtypes.txt +++ b/settingtypes.txt @@ -1,5 +1,8 @@ # Formspec update time (in seconds) formspec_editor.update_time (Update time) float 0.2 -# Path to the default font. -formspec_editor.file_path (File path) filepath \ No newline at end of file +# Path of the formspec file +formspec_editor.file_path (File path) filepath + +# Style type +formspec_editor.style (Formspec style) enum builtin builtin,minetest_game,mineclone2 \ No newline at end of file