Skip to content

Commit 9926ce4

Browse files
committed
doc: Clarify version field usage in modpack info.
1 parent 401f6a0 commit 9926ce4

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

doc/media/openage/modpack_definition_file.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -31,19 +31,22 @@ The following parameters have to be specified.
3131

3232
`[info]` contains general information about the modpack.
3333

34-
| Parameter | Data Type | Optional | Description |
35-
| ------------------ | ------------- | -------- | ------------------------------------------------------------------------ |
36-
| `packagename` | String | No | Name of the modpack. |
37-
| `version` | String | No | Internal version number. Must have [semver](https://semver.org/) format. |
38-
| `versionstr` | String | Yes | Human-readable version string. |
39-
| `repo` | String | Yes | Name of the repo where the package is hosted. |
40-
| `alias` | String | Yes | Alias of the modpack. Aliases can be used for replacing other modpacks. |
41-
| `title` | String | Yes | Title used in UI. |
42-
| `description` | String | Yes | Path to a file with a short description (max 500 chars). |
43-
| `long_description` | String | Yes | Path to a file with a detailed description. |
44-
| `url` | String | Yes | Link to the modpack's website. |
45-
| `license` | Array[String] | Yes | License(s) of the modpack. |
46-
34+
| Parameter | Data Type | Optional | Description |
35+
| ------------------ | ------------- | -------- | ----------------------------------------------------------------------- |
36+
| `packagename` | String | No | Name of the modpack. |
37+
| `version`\* | String | No | The modpack's internal version number. Must use [semver] format. |
38+
| `versionstr`\* | String | Yes | Human-readable version string. |
39+
| `repo` | String | Yes | Name of the repo where the package is hosted. |
40+
| `alias` | String | Yes | Alias of the modpack. Aliases can be used for replacing other modpacks. |
41+
| `title` | String | Yes | Title used in UI. |
42+
| `description` | String | Yes | Path to a file with a short description (max 500 chars). |
43+
| `long_description` | String | Yes | Path to a file with a detailed description. |
44+
| `url` | String | Yes | Link to the modpack's website. |
45+
| `license` | Array[String] | Yes | License(s) of the modpack. |
46+
47+
[semver]: https://semver.org/
48+
49+
\* `version` is used by the engine to determine the most recent version of a modpack. Therefore, it should be bumped when something in the modpack changes (e.g. whenever a new version gets published). `versionstr` is what is displayed to the user and can contain any string, so it can be used to represent any sensible version format.
4750

4851
## [assets] Section
4952

0 commit comments

Comments
 (0)