Difference between revisions of "Modding Tips"
Jump to navigation
Jump to search
(Add modding tips) |
(rename Minetest to Luanti) |
||
| (31 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | This page is a random collection of various tips and tricks, and solutions to common tasks/problems that occur frequently in mod/game development. See also: [ | + | {{LuaTips}} |
| + | |||
| + | This page is a random collection of various tips and tricks, and solutions to common tasks/problems that occur frequently in mod/game development. See also: [https://wiki.minetest.net/FAQ#Game_and_Mod_Development Modding FAQ] | ||
== Troubleshooting == | == Troubleshooting == | ||
| + | === OOM errors === | ||
| + | If your game or mod crashes due to an OOM error, it means that Luanti has ran out of memory (=OOM). This happens if your Lua code somewhere uses up a large amount of memory. This can happen if you construct large tables and fill them with lots of data and never free them, or you got a nice [https://en.wikipedia.org/wiki/Memory_leak memory leak]. Badly coded mapgens are a likely cause of OOM errors, if you implement a Lua API, you should always apply all [[Mapgen memory optimisations]]. | ||
| + | |||
| + | === “Irrlicht: PNG warning: iCCP: known incorrect sRGB profile” === | ||
| + | If you debug log level is set to “warning” or lower, you probably ran into the warning “Irrlicht: PNG warning: iCCP: known incorrect sRGB profile” quite often. | ||
| + | it means that *some* PNG file is bad. But this warning is useless for you because there's no file name mentioned. | ||
| + | |||
| + | If you want to track down ''which'' PNGs are broken, set the debug level (<code>debug_log_level</code>) to “verbose”. Now the log will show the PNG file name right above the warning. Now just fix the offending PNGs with your favourite image editor to get rid of these warnings. | ||
| + | |||
| + | === Deprecated function calls === | ||
| + | As Luanti develops, some API functions fall out of use and become deprecated in favour of newer functions with different names. Looking at console log or debug log output should give you the deprecation warnings that your mod throws. See the warning, which might give the name of the new function, and the Lua API for any eventual change in behaviour it has. | ||
| + | |||
| + | When upgrading your mod from version 0.4.x to 5.x, you may use the [https://gist.github.com/SmallJoker/cb89c3f9e4be27a0e8bc10ced1c5fc31 MT-replace-deprecated.sh] script ([https://forum.minetest.net/viewtopic.php?f=18&t=20403 forum thread]) which can automatically rename some deprecated functions. | ||
| + | |||
| + | To abort on any execution of a deprecated function, you can set the “deprecated_lua_api_handling” setting to “error”, useful during development to clearly see any deprecated functions being used. | ||
| + | |||
=== Positional sounds are either full volume or completely silent === | === Positional sounds are either full volume or completely silent === | ||
| − | Problem: | + | Problem: You want to play a sound at a position, but it's always at full volume when you're in range or completely silent if you're not. For example, you have a zombie that growls, but when it growls, somehow its growl is either at full volume or not hearable at all (if you're out of the sound range); there's no gradient at all. This can be annoying. |
| − | + | Reason: Your audio file is probably stereo. The fix is to make all positional sounds mono. You probably want to check ALL audio files then, it's very likely this wasn't the only one. | |
The documentation says: | The documentation says: | ||
| − | + | For positional playing of sounds, only single-channel (mono) files are | |
| − | + | supported. Otherwise OpenAL will play them non-positionally. | |
Note that non-positional sounds do not have to be mono, so you don't have to touch them. | Note that non-positional sounds do not have to be mono, so you don't have to touch them. | ||
| − | === | + | === The mapgen generates some nodes that let me see through the world but I still collide and/or interact with them === |
| − | + | This can happen in the mapgen v6 if you forgot to set some mapgen aliases, or a mapgen alias is set to a non-existing node. What is happening here is that these “broken” nodes are [https://wiki.minetest.net/Ignore Ignore] nodes because the v6 mapgen doesn't know which node to place here (because the given node name was invalid or undefined). | |
| − | |||
| − | If you | + | If you are using the mapgen v6, you must make sure that the mapgen aliases are set to a valid value. See <code>lua_api.md</code> for a list. |
| − | === | + | === My nodes don't propagate light properly until I dig around them === |
| − | + | This is probably because they don't have <code>paramtype="light"</code> set. Depending on the node drawtype, this paramtype is required for the lighting to work correctly (see lua_api.md for details). Note this might not immediately fix existing worlds, try a new world for testing instead. | |
| − | + | === I have floating plants === | |
| + | If you have plant decorations that for some inexplicable reason float in the air, there are multiple possible reasons for this, but here are some of the common ones: | ||
| − | + | * The v6 mapgen is a little buggy | |
| + | * Other decorations accidentally have plants on the floor and the schematic author overlooked them when saving the schematic | ||
| + | * ??? | ||
== Tips == | == Tips == | ||
| + | === Making warnings visible in chat === | ||
| + | By default, warnings are only seen in the debug log file and the program's console. For developers, it is very helpful to make all warnings visible in the chat as well so you won't miss them. Many warnings are about stuff like deprecated code, so it's a good idea to have them always highly visible. | ||
| + | |||
| + | Set the setting <code>chat_log_level</code> to <code>warning</code> to enable this. | ||
| + | |||
| + | === Improving Lua mapgen memory performance === | ||
| + | If you created a Lua mapgen, it is strongly recommended to make sure you optimize the memory performance, otherwise you could quickly run into OOM (out-of-memory) errors. See [[Mapgen memory optimisations]]. | ||
| + | |||
| + | === More optimization tips === | ||
| + | For more optimization tips, go to [[Lua Optimization Tips]]. | ||
| + | |||
=== Checking if a mod exists === | === Checking if a mod exists === | ||
If you want to check if a mod named “example” is currently loaded and actively used, use this code: | If you want to check if a mod named “example” is currently loaded and actively used, use this code: | ||
| Line 45: | Line 76: | ||
Here's a list of things to check in your game or mod to improve general quality and to avoid common pitfalls. Not all things might apply for your game, always use good judgement. | Here's a list of things to check in your game or mod to improve general quality and to avoid common pitfalls. Not all things might apply for your game, always use good judgement. | ||
| − | Note: Some of these can be checked quickly with [ | + | Note: Some of these can be checked quickly with [https://forum.minetest.net/viewtopic.php?t=15759 QA-Block]. See also: [[Development Tools]]. |
=== Preventing crashes, exploits and bugs === | === Preventing crashes, exploits and bugs === | ||
| − | * In minetest.after, do you consider that any external variable or object might become nil or disappear in the meantime?<ref>For example, if minetest.after does anything on a player object that you got 5 seconds ago, it's possible the player has left in that time. If you do anything (besides checking for existence) on the player object, you trigger a crash</ref> | + | * In <code>minetest.after</code>, do you consider that any external variable or object might become nil or disappear in the meantime?<ref>For example, if minetest.after does anything on a player object that you got 5 seconds ago, it's possible the player has left in that time. If you do anything (besides checking for existence) on the player object, you trigger a crash</ref> |
* In formspecs, did you check for all [https://forum.minetest.net/viewtopic.php?f=47&t=19129 Time Of Check is not Time Of Use vulnerabilities]? | * In formspecs, did you check for all [https://forum.minetest.net/viewtopic.php?f=47&t=19129 Time Of Check is not Time Of Use vulnerabilities]? | ||
* In formspecs, do you [https://forum.minetest.net/viewtopic.php?f=47&t=19129 Never Trust User-Provided Data]? | * In formspecs, do you [https://forum.minetest.net/viewtopic.php?f=47&t=19129 Never Trust User-Provided Data]? | ||
* In formspecs, do you enclose all variable, unpredictable text in <code>minetest.formspec_escape</code>? <ref>Variable text, especially translations or user input, can potentially contain the magic characters that formspecs use, so if unescaped, they will break the formspec.</ref> | * In formspecs, do you enclose all variable, unpredictable text in <code>minetest.formspec_escape</code>? <ref>Variable text, especially translations or user input, can potentially contain the magic characters that formspecs use, so if unescaped, they will break the formspec.</ref> | ||
* Does the game behave properly when restarted?<ref>Some game data might be accidentally reset or just not be persisted across restarts. For example, rainy weather might be reset to clear because it was not saved.</ref> | * Does the game behave properly when restarted?<ref>Some game data might be accidentally reset or just not be persisted across restarts. For example, rainy weather might be reset to clear because it was not saved.</ref> | ||
| − | * Did you check if implementing [https://forum.minetest.net/viewtopic.php?f=18&t=12471 mod security] is | + | * Did you check if implementing [https://forum.minetest.net/viewtopic.php?f=18&t=12471 mod security] is necessary? If yes, did you implement it? |
* For singleplayer games: Do you error out if someone tries to run your game in multiplayer?<ref>Use <code>minetest.is_singleplayer</code> to check. Use Lua's <code>error</code> function to error out, or just kick all players.</ref> | * For singleplayer games: Do you error out if someone tries to run your game in multiplayer?<ref>Use <code>minetest.is_singleplayer</code> to check. Use Lua's <code>error</code> function to error out, or just kick all players.</ref> | ||
| + | * Do you restrict detached inventories to players, where necessary?<ref>Detached inventories are sent to everyone unless you specify a name in the registration. So other players using a modified/hacked client could theoretically alter any detached inventory without an attached name.</ref> | ||
=== General code quality === | === General code quality === | ||
| − | * Does the game/mod avoid polluting the global namespace with tons of identifiers?<ref>The keyword “<code>local</code>” should be your new friend. Everything that does not need to be visible outside should be made local. This will avoid a lot of weird bugs caused by mods overwriting their global variables each other. As a rule of thumb, your mod should only have up to 1 global variable which is also the same name as the mod. Make this a table in which you include all global stuff.</ref> | + | * Does the game/mod avoid polluting the global namespace with tons of identifiers?<ref>The keyword “<code>local</code>” should be your new friend. Everything that does not need to be visible outside should be made local. This will avoid a lot of weird bugs caused by mods overwriting their global variables each other. As a rule of thumb, your mod should only have up to 1 global variable which is also the same name as the mod. Make this a table in which you include all global stuff. You can use [https://forum.minetest.net/viewtopic.php?t=15759 QA-Block] to find suspicious global variables.</ref> |
| − | * All deprecated code removed/replaced?<ref>See also: [MT-replace-deprecated.sh]</ref> | + | * All deprecated code removed/replaced?<ref>See also: [[MT-replace-deprecated.sh]]</ref> |
* Are all APIs (that are intended for external use) documented? | * Are all APIs (that are intended for external use) documented? | ||
| + | |||
| + | === Performance === | ||
| + | * Do you use the “buffer” argument in the LuaVoxelManip and Perlin noise functions (like <code>get_data</code> or <code>get_2d_map_flat</code>)?<ref>See also [[Mapgen_memory_optimisations]]</ref> | ||
| + | * Do you avoid re-creating the same Perlin noise over and over again?<ref>See also [[Mapgen_memory_optimisations]]</ref> | ||
=== Entities/players === | === Entities/players === | ||
| Line 76: | Line 112: | ||
* Does your game/mod have a name? | * Does your game/mod have a name? | ||
* Is the name of the game/mod used consistently everywhere? | * Is the name of the game/mod used consistently everywhere? | ||
| − | * For games: Name, icon, header present?<ref> | + | * For games: Name, icon, header present?<ref>The images just to help identifying the game in the game icon list in the main menu. Without an icon, your game is harder to find. At least draw a dummy image if you're in a hurry.</ref> |
=== Graphics, audio, text === | === Graphics, audio, text === | ||
| Line 82: | Line 118: | ||
* Does the UI still work in higher scaling/DPI? | * Does the UI still work in higher scaling/DPI? | ||
* Are all required textures included? | * Are all required textures included? | ||
| + | * Do your leaves still look okay when simple leaves are used (<code>leaves_style = simple</code>)<ref>Luanti will use the color of the transparent pixels of the PNG file; check out your manual of your graphics program to learn how to set the color of transparent pixels</ref> | ||
* Do all items that the player can legitimately get have <code>description</code> set? | * Do all items that the player can legitimately get have <code>description</code> set? | ||
* Do all chat commands have <code>description</code> and parameter list set? | * Do all chat commands have <code>description</code> and parameter list set? | ||
| − | * In the parameter list of chat commands, does it follow the format defined in <code>lua_api. | + | * In the parameter list of chat commands, does it follow the format defined in <code>lua_api.md</code>? |
* Do all items have unique descriptions (=no confusing duplicates, unless intentional for some reason) | * Do all items have unique descriptions (=no confusing duplicates, unless intentional for some reason) | ||
* Is the writing style consistent across the entire game? | * Is the writing style consistent across the entire game? | ||
| Line 94: | Line 131: | ||
* Does the UI provide reasonably enough space for translations? | * Does the UI provide reasonably enough space for translations? | ||
* Was at least one translation playtested? | * Was at least one translation playtested? | ||
| − | * Do you avoid using string concatenation to include variable text?<ref>If you don't understand this, review lua_api. | + | * Do you avoid using string concatenation to include variable text?<ref>If you don't understand this, review lua_api.md</ref> |
* Can all user-facing texts be translated? | * Can all user-facing texts be translated? | ||
* Have all in-game images with baked-in, untranslatable texts, been replaced with text?<ref>There might be possible exceptions, such as names and logos. But generally, all baked-in text should be avoided where possible.</ref> | * Have all in-game images with baked-in, untranslatable texts, been replaced with text?<ref>There might be possible exceptions, such as names and logos. But generally, all baked-in text should be avoided where possible.</ref> | ||
| Line 103: | Line 140: | ||
| − | [[Category: | + | [[Category:Modding API]] |
Latest revision as of 21:55, 22 October 2024
 |
This page contains community-written advice, tips, tricks or recommendations about modding. Your mileage may vary. |
This page is a random collection of various tips and tricks, and solutions to common tasks/problems that occur frequently in mod/game development. See also: Modding FAQ
Troubleshooting
OOM errors
If your game or mod crashes due to an OOM error, it means that Luanti has ran out of memory (=OOM). This happens if your Lua code somewhere uses up a large amount of memory. This can happen if you construct large tables and fill them with lots of data and never free them, or you got a nice memory leak. Badly coded mapgens are a likely cause of OOM errors, if you implement a Lua API, you should always apply all Mapgen memory optimisations.
“Irrlicht: PNG warning: iCCP: known incorrect sRGB profile”
If you debug log level is set to “warning” or lower, you probably ran into the warning “Irrlicht: PNG warning: iCCP: known incorrect sRGB profile” quite often.
it means that *some* PNG file is bad. But this warning is useless for you because there's no file name mentioned.
If you want to track down which PNGs are broken, set the debug level (debug_log_level) to “verbose”. Now the log will show the PNG file name right above the warning. Now just fix the offending PNGs with your favourite image editor to get rid of these warnings.
Deprecated function calls
As Luanti develops, some API functions fall out of use and become deprecated in favour of newer functions with different names. Looking at console log or debug log output should give you the deprecation warnings that your mod throws. See the warning, which might give the name of the new function, and the Lua API for any eventual change in behaviour it has.
When upgrading your mod from version 0.4.x to 5.x, you may use the MT-replace-deprecated.sh script (forum thread) which can automatically rename some deprecated functions.
To abort on any execution of a deprecated function, you can set the “deprecated_lua_api_handling” setting to “error”, useful during development to clearly see any deprecated functions being used.
Positional sounds are either full volume or completely silent
Problem: You want to play a sound at a position, but it's always at full volume when you're in range or completely silent if you're not. For example, you have a zombie that growls, but when it growls, somehow its growl is either at full volume or not hearable at all (if you're out of the sound range); there's no gradient at all. This can be annoying.
Reason: Your audio file is probably stereo. The fix is to make all positional sounds mono. You probably want to check ALL audio files then, it's very likely this wasn't the only one.
The documentation says:
For positional playing of sounds, only single-channel (mono) files are supported. Otherwise OpenAL will play them non-positionally.
Note that non-positional sounds do not have to be mono, so you don't have to touch them.
The mapgen generates some nodes that let me see through the world but I still collide and/or interact with them
This can happen in the mapgen v6 if you forgot to set some mapgen aliases, or a mapgen alias is set to a non-existing node. What is happening here is that these “broken” nodes are Ignore nodes because the v6 mapgen doesn't know which node to place here (because the given node name was invalid or undefined).
If you are using the mapgen v6, you must make sure that the mapgen aliases are set to a valid value. See lua_api.md for a list.
My nodes don't propagate light properly until I dig around them
This is probably because they don't have paramtype="light" set. Depending on the node drawtype, this paramtype is required for the lighting to work correctly (see lua_api.md for details). Note this might not immediately fix existing worlds, try a new world for testing instead.
I have floating plants
If you have plant decorations that for some inexplicable reason float in the air, there are multiple possible reasons for this, but here are some of the common ones:
- The v6 mapgen is a little buggy
- Other decorations accidentally have plants on the floor and the schematic author overlooked them when saving the schematic
- ???
Tips
Making warnings visible in chat
By default, warnings are only seen in the debug log file and the program's console. For developers, it is very helpful to make all warnings visible in the chat as well so you won't miss them. Many warnings are about stuff like deprecated code, so it's a good idea to have them always highly visible.
Set the setting chat_log_level to warning to enable this.
Improving Lua mapgen memory performance
If you created a Lua mapgen, it is strongly recommended to make sure you optimize the memory performance, otherwise you could quickly run into OOM (out-of-memory) errors. See Mapgen memory optimisations.
More optimization tips
For more optimization tips, go to Lua Optimization Tips.
Checking if a mod exists
If you want to check if a mod named “example” is currently loaded and actively used, use this code:
local mod_exists = minetest.get_modpath("example") ~= nil
Now mod_exists will be true if the mod exists and false otherwise.
This works because minetest.get_modpath returns nil if the mod is not loaded.
Ensuring mod interopability
A good mod is one that still works when a lot of other mods are used. Read Mod_interoperability for a lot of useful hints.
Quality checklist
Here's a list of things to check in your game or mod to improve general quality and to avoid common pitfalls. Not all things might apply for your game, always use good judgement.
Note: Some of these can be checked quickly with QA-Block. See also: Development Tools.
Preventing crashes, exploits and bugs
- In
minetest.after, do you consider that any external variable or object might become nil or disappear in the meantime?[1] - In formspecs, did you check for all Time Of Check is not Time Of Use vulnerabilities?
- In formspecs, do you Never Trust User-Provided Data?
- In formspecs, do you enclose all variable, unpredictable text in
minetest.formspec_escape? [2] - Does the game behave properly when restarted?[3]
- Did you check if implementing mod security is necessary? If yes, did you implement it?
- For singleplayer games: Do you error out if someone tries to run your game in multiplayer?[4]
- Do you restrict detached inventories to players, where necessary?[5]
General code quality
- Does the game/mod avoid polluting the global namespace with tons of identifiers?[6]
- All deprecated code removed/replaced?[7]
- Are all APIs (that are intended for external use) documented?
Performance
- Do you use the “buffer” argument in the LuaVoxelManip and Perlin noise functions (like
get_dataorget_2d_map_flat)?[8] - Do you avoid re-creating the same Perlin noise over and over again?[9]
Entities/players
- Do all entities still behave properly when they unload, and then load again?[10]
- If you change player physics (
set_physics_override) anywhere, will it still work when another mod changes it?[11]
Items and nodes
- Is
is_ground_contentset to false for all nodes that the cavegen should not destroy?[12] - Do all nodes have appropriate sounds?[13]
- Do all nodes have appropriate selection boxes?[14]
- Do all items intented for use only in Creative Inventory have set the
not_in_creative_inventory=1group? - Do all crafts work?[15]
Game/mod metadata
- For games: Are all unsupported mapgens disabled in game.conf?
- Does your game/mod have a name?
- Is the name of the game/mod used consistently everywhere?
- For games: Name, icon, header present?[16]
Graphics, audio, text
- Are all positional sounds mono?[17]
- Does the UI still work in higher scaling/DPI?
- Are all required textures included?
- Do your leaves still look okay when simple leaves are used (
leaves_style = simple)[18] - Do all items that the player can legitimately get have
descriptionset? - Do all chat commands have
descriptionand parameter list set? - In the parameter list of chat commands, does it follow the format defined in
lua_api.md? - Do all items have unique descriptions (=no confusing duplicates, unless intentional for some reason)
- Is the writing style consistent across the entire game?
- No typos/grammar fails?
- Do you use
blank.pnginstead of a custom transparent image?[19] - Do all items have an appropriate item image that helps in keeping items apart?[20]
Translations
- Does the UI provide reasonably enough space for translations?
- Was at least one translation playtested?
- Do you avoid using string concatenation to include variable text?[21]
- Can all user-facing texts be translated?
- Have all in-game images with baked-in, untranslatable texts, been replaced with text?[22]
Footnotes
- ↑ For example, if minetest.after does anything on a player object that you got 5 seconds ago, it's possible the player has left in that time. If you do anything (besides checking for existence) on the player object, you trigger a crash
- ↑ Variable text, especially translations or user input, can potentially contain the magic characters that formspecs use, so if unescaped, they will break the formspec.
- ↑ Some game data might be accidentally reset or just not be persisted across restarts. For example, rainy weather might be reset to clear because it was not saved.
- ↑ Use
minetest.is_singleplayerto check. Use Lua'serrorfunction to error out, or just kick all players. - ↑ Detached inventories are sent to everyone unless you specify a name in the registration. So other players using a modified/hacked client could theoretically alter any detached inventory without an attached name.
- ↑ The keyword “
local” should be your new friend. Everything that does not need to be visible outside should be made local. This will avoid a lot of weird bugs caused by mods overwriting their global variables each other. As a rule of thumb, your mod should only have up to 1 global variable which is also the same name as the mod. Make this a table in which you include all global stuff. You can use QA-Block to find suspicious global variables. - ↑ See also: MT-replace-deprecated.sh
- ↑ See also Mapgen_memory_optimisations
- ↑ See also Mapgen_memory_optimisations
- ↑ Entities will forget most variables when they unload, which is easy to overlook for beginners. Make sure to make use of staticdata.
- ↑ If you don't apply any checks when overwriting player physics, this will very likely lead to very hilarious bugs if 2 mods want to change player physics directly, as they will constantly compete for “their” physics. This will likely screw up the player physics badly. To solve this, you should generally avoid setting player physics directly, unless you want to implement a physics interface yourselves. But for normal use, we highly recommend to use an Mod_interoperability#Player_physics API.
- ↑ Note this value is true by default, and can be forgotten easily.
- ↑ Of course, silence is also “appropriate” if that's what you intented.
- ↑ As a rule of thumb, try to match the graphics pixel-perfectly, if it makes sense. Selection boxes that are completely misplaced or just tiny are generally perceived as highly annoying by players.
- ↑ Use a craft guide to check
- ↑ The images just to help identifying the game in the game icon list in the main menu. Without an icon, your game is harder to find. At least draw a dummy image if you're in a hurry.
- ↑ See troubleshooting above.
- ↑ Luanti will use the color of the transparent pixels of the PNG file; check out your manual of your graphics program to learn how to set the color of transparent pixels
- ↑ blank.png is a fully transparent texture that is available by default. No need to create your own transparent texture.
- ↑ It's annoying if 2 very different items share the same icon
- ↑ If you don't understand this, review lua_api.md
- ↑ There might be possible exceptions, such as names and logos. But generally, all baked-in text should be avoided where possible.