GodotModding / GodotModding/godot-mod-loader

Documentation Updates

Open
#254 4 comments 0 reactions 2 assignees Claimed by @ithinkandicode View on GitHub
documentation
Dominant language
GDScript
Stars
675
Forks
54
Avg merge
2m
Merged PRs (30d)
2

Description

> [!NOTE]
> Docs moved to https://github.com/GodotModding/gmlwiki

| **Topic** | **Status** | **Documentation** |
|----------------------------|------------|------------------|
| **ModLoader API** | ✔️ | |
| - Add **Methods Overview** table to [ModLoaderUserProfile](https://github.com/GodotModding/godot-mod-loader/wiki/modloaderuserprofile) | ✔️ | [➡️](https://github.com/GodotModding/godot-mod-loader/wiki/modloaderuserprofile) |
| | | |
| **ModLoaderMod** | ✔️ | [➡️](https://github.com/GodotModding/godot-mod-loader/wiki/modloadermod) |
| - Update API Method description | ✔️ | [➡️](https://github.com/GodotModding/godot-mod-loader/wiki/modloadermod) |
| - Update moved methods from `ModLoaderMod` to `ModLoaderModManager` | ✔️ | [➡️](https://github.com/GodotModding/godot-mod-loader/wiki/ModLoaderModManager) |
| | | |
| **ModConfigs** | ✔️ | [➡️](https://github.com/GodotModding/godot-mod-loader/wiki/config-json) |
| - Writing configs | ✔️ | [➡️](https://github.com/GodotModding/godot-mod-loader/wiki/config-json) |
| - Defining configs via json schema | ✔️ | [➡️](https://github.com/GodotModding/godot-mod-loader/wiki/config-json#json-schema) |
| - Supported types (can this be found in the schema docs? if not, maybe it should be there instead) | ✔️ | [➡️](https://github.com/GodotModding/godot-mod-loader/wiki/config-json#unsupported-keys) |
| - New API methods | ✔️ | [➡️](https://github.com/GodotModding/godot-mod-loader/wiki/modloaderconfig) |
| - Example config editor repo | ✔️ | [➡️](https://github.com/GodotModding/godot-mod-loader/wiki/config-json#creating-configs) |
| | | |
| **ModUserProfiles** | ✔️ | [➡️](https://wiki.godotmodding.com/guides/integration/user_profiles/) |
| - Explain profiles | ✔️ | |
| - What does the user set | ✔️ | |
| - What does the dev set | ✔️ | |
| | | |
| **ModLoader Options** | ✔️ | [➡️](https://github.com/GodotModding/godot-mod-loader/wiki/Mod-Loader-Options) |
| - Explain available option | ✔️ | [➡️](https://github.com/GodotModding/godot-mod-loader/wiki/Mod-Loader-Options#available-options) |
| - Explain profiles | ✔️ | [➡️](https://github.com/GodotModding/godot-mod-loader/wiki/Mod-Loader-Options#profiles) |
| - Explain Feature Flag overrides | ✔️ | [➡️](https://github.com/GodotModding/godot-mod-loader/wiki/Mod-Loader-Options#feature-override-options-feature-flags) |
| | | |
| **Guides** | ❌ | |
| - Guide on publishing a mod | ✔️ | [➡️](https://wiki.godotmodding.com/guides/modding/distributing_mods/) |
| - Guide on how to enable steam workshop support | ❌ | |
| - Create a guide on how to create mod configs | ✔️ | [➡️](https://github.com/GodotModding/godot-mod-loader/wiki/Mod-Configs) |
| | | |
| **Examples** | ❌ | |
| - Update the [example Mod](https://github.com/GodotModding/godot-mod-loader-examples) | ❌ | [➡️](https://github.com/GodotModding/godot-mod-loader-examples) |
| | | |
| **Godot Project Setup** | ✔️ | [➡️](https://github.com/GodotModding/godot-mod-loader/wiki/Godot-Project-Setup) |
| - Explain JSON_Schema_Validator | ✔️ | |
| - ModLoaderStore Autoload | ✔️ | |
| | | |
| **Mod Structure** | ✔️ | [➡️](https://github.com/GodotModding/godot-mod-loader/wiki/Mod-Structure) |
| - Add a tip to use the [Dev Tool](https://github.com/GodotModding/godot-mod-tool) to package the mod zip | ✔️ | [➡️](https://wiki.godotmodding.com/guides/modding/tools/mod_tool/#exporting) |
| | | |
| **Mod Files** | ✔️ | [➡️](https://github.com/GodotModding/godot-mod-loader/wiki/Mod-Files) |
| - Update the manifest example | ✔️ | [➡️](https://github.com/GodotModding/godot-mod-loader/wiki/Mod-Files#manifestjson) |
| - Remove `ModLoader` argument from `_init()` function examples *Edit: This requires code changes as well.* - Done in #324 | ✔️ | [➡️](https://github.com/GodotModding/godot-mod-loader/wiki/Mod-Files#mod_maingd) |
| | | |
| **Logging** | ❌ | [➡️](https://github.com/GodotModding/godot-mod-loader/wiki/Logging) |
| - Add default log file path |❌ | [➡️](https://wiki.godotmodding.com/guides/modding/testing_debugging/#logging-and-other-handy-options) |
| - Remove the Methods section - link to the [ModLoaderLog API Section](https://github.com/GodotModding/godot-mod-loader/wiki/modloaderlog) instead | ✔️ | [➡️](https://wiki.godotmodding.com/api/mod_loader_log/) |
| - Add a section on how to set the verbosity via options.tres | ✔️ | [➡️](https://wiki.godotmodding.com/guides/modding/testing_debugging/#logging-and-other-handy-options) |

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.