Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Modpack load fixes #1579

Merged
merged 3 commits into from
Oct 17, 2023
Merged

Modpack load fixes #1579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9926ce4
doc: Clarify version field usage in modpack info.
heinezen Oct 10, 2023
bd17e3a
convert: Fix directory access in API export CLI.
heinezen Oct 10, 2023
88180ad
gamestate: Do not substr on double wildcard.
heinezen Oct 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
29 changes: 16 additions & 13 deletions doc/media/openage/modpack_definition_file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,22 @@ The following parameters have to be specified.

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

| Parameter | Data Type | Optional | Description |
| ------------------ | ------------- | -------- | ------------------------------------------------------------------------ |
| `packagename` | String | No | Name of the modpack. |
| `version` | String | No | Internal version number. Must have [semver](https://semver.org/) format. |
| `versionstr` | String | Yes | Human-readable version string. |
| `repo` | String | Yes | Name of the repo where the package is hosted. |
| `alias` | String | Yes | Alias of the modpack. Aliases can be used for replacing other modpacks. |
| `title` | String | Yes | Title used in UI. |
| `description` | String | Yes | Path to a file with a short description (max 500 chars). |
| `long_description` | String | Yes | Path to a file with a detailed description. |
| `url` | String | Yes | Link to the modpack's website. |
| `license` | Array[String] | Yes | License(s) of the modpack. |

| Parameter | Data Type | Optional | Description |
| ------------------ | ------------- | -------- | ----------------------------------------------------------------------- |
| `packagename` | String | No | Name of the modpack. |
| `version`\* | String | No | The modpack's internal version number. Must use [semver] format. |
| `versionstr`\* | String | Yes | Human-readable version string. |
| `repo` | String | Yes | Name of the repo where the package is hosted. |
| `alias` | String | Yes | Alias of the modpack. Aliases can be used for replacing other modpacks. |
| `title` | String | Yes | Title used in UI. |
| `description` | String | Yes | Path to a file with a short description (max 500 chars). |
| `long_description` | String | Yes | Path to a file with a detailed description. |
| `url` | String | Yes | Link to the modpack's website. |
| `license` | Array[String] | Yes | License(s) of the modpack. |

[semver]: https://semver.org/

\* `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.

## [assets] Section

Expand Down
5 changes: 3 additions & 2 deletions libopenage/gamestate/game.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,12 @@ void Game::load_data(const std::shared_ptr<assets::ModManager> &mod_manager) {
recursive = true;
if (parts.size() == 1) {
// include = "**"
search = include.substr(0, include.size() - 2);
// start in root directory
search = "";
}
else {
// include = "path/to/somewhere/**"
// remove the slash '/' too
// remove the wildcard '**' and the slash '/'
search = include.substr(0, include.size() - 3);
}
}
Expand Down
2 changes: 1 addition & 1 deletion openage/convert/tool/api_export.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ def main(args, error):
del error # unused

path = Union().root
path.mount(Directory(args.dir))
path.mount(Directory(args.dir).root)

export_api(path)

Expand Down