From a3e8dce871ae89cd09a23e4f1ed51c13b06d6be1 Mon Sep 17 00:00:00 2001 From: rubenwardy Date: Mon, 3 Jul 2023 22:36:25 +0100 Subject: [PATCH] Update game support docs --- app/flatpages/help/game_support.md | 35 +++++++++++++++++++----------- 1 file changed, 22 insertions(+), 13 deletions(-) diff --git a/app/flatpages/help/game_support.md b/app/flatpages/help/game_support.md index 47738027..bc47f137 100644 --- a/app/flatpages/help/game_support.md +++ b/app/flatpages/help/game_support.md @@ -6,27 +6,29 @@ title: Supported Games ## Why? -The supported/compatible games feature allows mods to specify the games that they work with, which improves -user experience. +The supported/compatible games feature allows mods to specify the games that +they work with, which improves user experience. ## Support sources ### mod.conf / texture_pack.conf -You can use `supported_games` to specify games that your mod is compatible with. +You can use `supported_games` to specify games that your mod/modpack/texture +pack is compatible with. -You can use `unsupported_games` to specify games that your mod doesn't work with, which is useful for overriding -ContentDB's automatic detection. +You can use `unsupported_games` to specify games that your package doesn't work +with, which is useful for overriding ContentDB's automatic detection. -Both of these are comma-separated lists of game technical ids. Any `_game` suffixes are ignored, just like in Minetest. +Both of these are comma-separated lists of game technical ids. Any `_game` +suffixes are ignored, just like in Minetest. supported_games = minetest_game, repixture unsupported_games = lordofthetest, nodecore, whynot -If your package supports all games by default, you can put "*" in supported_games. -You can still use unsupported_games to mark games as unsupported. -You can also specify games that you've tested in supported_games. +If your package supports all games by default, you can put "*" in +supported_games. You can still use unsupported_games to mark games as +unsupported. You can also specify games that you've tested in supported_games. # Should work with all games but I've only tested using Minetest Game: supported_games = *, minetest_game @@ -36,12 +38,19 @@ You can also specify games that you've tested in supported_games. ### Dependencies -ContentDB will analyse hard dependencies and work out which games a mod supports. +ContentDB will analyse hard dependencies and work out which games a mod +supports. -This uses a recursive algorithm that works out whether a dependency can be installed independently, or if it requires -a certain game. +This uses a recursive algorithm that works out whether a dependency can be +installed independently, or if it requires a certain game. + +### On ContentDB + +You can define supported games on ContentDB, but using .conf is recommended +instead. ## Combining all the sources -mod.conf will override anything ContentDB detects. +.conf will override anything ContentDB detects. The manual override on ContentDB +overrides .conf and dependencies.