Skip to content

Documentation Updates #254

Open
Open
@Qubus0

Description

@Qubus0
Topic Status Documentation
ModLoader API ✔️
- Add Methods Overview table to ModLoaderUserProfile ✔️ ➡️
ModLoaderMod ✔️ ➡️
- Update API Method description ✔️ ➡️
- Update moved methods from ModLoaderMod to ModLoaderModManager ✔️ ➡️
ModConfigs ✔️ ➡️
- Writing configs ✔️ ➡️
- Defining configs via json schema ✔️ ➡️
- Supported types (can this be found in the schema docs? if not, maybe it should be there instead) ✔️ ➡️
- New API methods ✔️ ➡️
- Example config editor repo ✔️ ➡️
ModUserProfiles ✔️ ➡️
- Explain profiles ✔️
- What does the user set ✔️
- What does the dev set ✔️
ModLoader Options ✔️ ➡️
- Explain available option ✔️ ➡️
- Explain profiles ✔️ ➡️
- Explain Feature Flag overrides ✔️ ➡️
Guides
- Guide on publishing a mod ✔️ ➡️
- Guide on how to enable steam workshop support
- Create a guide on how to create mod configs ✔️ ➡️
Examples
- Update the example Mod ➡️
Godot Project Setup ✔️ ➡️
- Explain JSON_Schema_Validator ✔️
- ModLoaderStore Autoload ✔️
Mod Structure ✔️ ➡️
- Add a tip to use the Dev Tool to package the mod zip ✔️ ➡️
Mod Files ✔️ ➡️
- Update the manifest example ✔️ ➡️
- Remove ModLoader argument from _init() function examples Edit: This requires code changes as well. - Done in #324 ✔️ ➡️
Logging ➡️
- Add default log file path ➡️
- Remove the Methods section - link to the ModLoaderLog API Section instead ✔️ ➡️
- Add a section on how to set the verbosity via options.tres ✔️ ➡️

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions