Skip to content

Commit af313f5

Browse files
authored
.conf file: Add cross-references (#663)
References to relevant parts for easier understanding, and should avoid duplication in the future.
1 parent db8665e commit af313f5

2 files changed

Lines changed: 8 additions & 5 deletions

File tree

app/flatpages/help/game_support.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,5 @@ instead.
5050

5151
.conf will override anything ContentDB detects. The manual override on ContentDB
5252
overrides .conf and dependencies.
53+
54+
See also: [Package Configuration: .conf files](/help/package_config/#conf-files)

app/flatpages/help/package_config.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ this to your advantage.
1010

1111
### What is a content .conf file?
1212

13-
Every type of content can have a `.conf` file that contains the metadata.
13+
Every type of content should have a `.conf` file that contains the metadata.
14+
This file is also used by the Luanti engine, see [lua_api.md, section "Games" and "Mods"](https://github.com/luanti-org/luanti/blob/master/doc/lua_api.md) for details.
1415

1516
The filename of the `.conf` file depends on the content type:
1617

@@ -48,8 +49,8 @@ ContentDB understands the following information:
4849
and for mods only:
4950

5051
* `name` - the mod technical name.
51-
* `supported_games` - List of supported game technical names.
52-
* `unsupported_games` - List of not supported game technical names. Useful to override game support detection.
52+
* `supported_games` - List of supported games, see [Supported Games](/help/game_support/).
53+
* `unsupported_games` - List of known not supported games, see [Supported Games](/help/game_support/).
5354

5455

5556
## .cdb.json
@@ -69,13 +70,13 @@ It should be a JSON dictionary with one or more of the following optional keys:
6970
* `tags`: List of tag names, see [/api/tags/](/api/tags/).
7071
* `content_warnings`: List of content warning names, see [/api/content_warnings/](/api/content_warnings/).
7172
* `license`: A license name, see [/api/licenses/](/api/licenses/).
72-
* `media_license`: A license name.
73+
* `media_license`: A license name, see [/api/licenses/](/api/licenses/).
7374
* `long_description`: Long markdown description.
7475
* `repo`: Source repository (eg: Git).
7576
* `website`: Website URL.
7677
* `issue_tracker`: Issue tracker URL.
7778
* one of:
78-
* `forums`: forum topic ID, an integer, ex: 20174.
79+
* `forums`: forum topic ID, an integer, ex: `20174`.
7980
* `forum_url`: forum URL, a string. Must link to the official forums. Ex: `https://forum.luanti.org/viewtopic.php?t=20174`
8081
* `video_url`: URL to a video.
8182
* `donate_url`: URL to a donation page.

0 commit comments

Comments
 (0)