contentdb/app/flatpages/help/game_support.md

53 lines
1.6 KiB
Markdown
Raw Normal View History

2022-06-25 01:32:32 +02:00
title: Supported Games
## Why?
2023-07-03 23:36:25 +02:00
The supported/compatible games feature allows mods to specify the games that
they work with, which improves user experience.
2022-06-25 01:32:32 +02:00
## Support sources
### mod.conf / texture_pack.conf
2022-06-25 01:32:32 +02:00
2023-07-03 23:36:25 +02:00
You can use `supported_games` to specify games that your mod/modpack/texture
pack is compatible with.
2022-06-25 01:32:32 +02:00
2023-07-03 23:36:25 +02:00
You can use `unsupported_games` to specify games that your package doesn't work
with, which is useful for overriding ContentDB's automatic detection.
2022-06-25 01:32:32 +02:00
2023-07-03 23:36:25 +02:00
Both of these are comma-separated lists of game technical ids. Any `_game`
suffixes are ignored, just like in Minetest.
2022-06-25 01:32:32 +02:00
supported_games = minetest_game, repixture
unsupported_games = lordofthetest, nodecore, whynot
2023-07-03 23:36:25 +02:00
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:
2023-06-23 13:11:21 +02:00
supported_games = *, minetest_game
# But doesn't work in capturetheflag
unsupported_game = capturetheflag
2022-06-25 01:32:32 +02:00
### Dependencies
2023-07-03 23:36:25 +02:00
ContentDB will analyse hard dependencies and work out which games a mod
supports.
2022-06-25 01:32:32 +02:00
2023-07-03 23:36:25 +02:00
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.
2022-06-25 01:32:32 +02:00
## Combining all the sources
2023-07-03 23:36:25 +02:00
.conf will override anything ContentDB detects. The manual override on ContentDB
overrides .conf and dependencies.