Version: v1.5.1 Last Updated: May 2026
- End-User Guide — Installation, configuration, UI usage, troubleshooting
- FAQ & Troubleshooting — Common problems and solutions
- System Requirements — Hardware and software requirements
- Mod Creator Guide — Creating and publishing mods
- Example Manifests — Ready-to-use metadata templates
- Dependency Management — How to declare mod dependencies
- Publishing to datacentermods.com — Release workflow
- Contributor Guide — Setup, coding standards, testing, contributing
- Architecture Overview — Project structure and design
- Build Instructions — How to build locally
- Testing Guide — Unit testing and validation
- PR Workflow — Creating pull requests
- README.md — Project overview and quick links
- RELEASENOTE.md — Version history and changelog
- EXTERNAL_DEPENDENCIES.md — Third-party library inventory
- AGENTS.md — System architecture and agent instructions
- LICENSE — MIT license
| Topic | Link | Audience |
|---|---|---|
| Windows installation | End-User Guide § Windows | End Users |
| Linux installation | End-User Guide § Linux | End Users |
| First-run setup | End-User Guide § First-Run Setup | End Users |
| Development environment | Contributor Guide § Setup | Contributors |
| Topic | Link | Audience |
|---|---|---|
| Build script reference | Contributor Guide § Build System | Contributors |
| Release workflow | Contributor Guide § Release Process | Maintainers |
| Packaging (installer, portable, Linux) | build.ps1 source | Contributors |
| Topic | Link | Audience |
|---|---|---|
| Package types overview | Mod Creator Guide § Modding Ecosystem | Creators |
| Creating game mods | Mod Creator Guide § Game Mods | Creators |
| Creating MelonLoader plugins | Mod Creator Guide § MelonLoader Plugins | Creators |
| gregCore mods and extensions | Mod Creator Guide § gregCore | Creators |
| UserLibs / shared libraries | Mod Creator Guide § UserLibs | Creators |
| Dependency declarations | Mod Creator Guide § Dependencies | Creators |
| Manifest format reference | Mod Creator Guide § Manifests | Creators |
| Topic | Link | Audience |
|---|---|---|
| UI overview | End-User Guide § User Interface | End Users |
| Managing games | End-User Guide § Managing Games | End Users |
| Managing mods | End-User Guide § Managing Mods | End Users |
| Mod profiles | End-User Guide § Profiles | End Users |
| Topic | Link | Audience |
|---|---|---|
| Common errors | End-User Guide § Troubleshooting | End Users |
| Log file locations | End-User Guide § Reading Logs | End Users |
| Reporting bugs | End-User Guide § Reporting Issues | End Users |
| Debugging code | Contributor Guide § Debugging | Contributors |
| Topic | Link | Audience |
|---|---|---|
| Architecture | Contributor Guide § Architecture | Contributors |
| Coding standards | Contributor Guide § Coding Standards | Contributors |
| Testing | Contributor Guide § Testing | Contributors |
| Contributing workflow | Contributor Guide § PR Workflow | Contributors |
| Localization | Contributor Guide § Localization | Contributors |
Located in docs/examples/manifests/:
| File | Type | Use Case |
|---|---|---|
01_simple_mod.json |
Game Mod | No dependencies, basic mod |
02_gregcore_mod_with_deps.json |
gregCore Mod | Complex dependencies, multiple requirements |
03_universal_plugin.json |
MelonLoader Plugin | Works with any game |
04_game_specific_plugin.json |
MelonLoader Plugin | Game-specific optimization |
05_gregcore_extension.json |
gregCore Extension | Extends gregCore services |
06_userlib.json |
UserLib | Shared library with versioning |
How to use: Copy an example manifest, modify fields for your mod, then validate and publish.
Located in docs/examples/mods/ (to be populated with working examples)
- datacentermods.com — Central mod repository
- gregframework.eu — gregCore/gregFramework API documentation
- melonwiki.xyz — MelonLoader documentation and plugins
- Avalonia UI — Cross-platform UI framework used
- .NET Documentation — .NET 9 API reference
- Inno Setup — Installer scripting language
- GitHub Issues — Bug reports and feature requests
- GitHub Discussions — General questions and ideas
- GitHub Releases — Download releases
The wiki/ folder is a Git submodule pointing to gregModmanager.wiki.
To update wiki:
# Navigate to wiki submodule
cd wiki
# Make changes (using GitHub web or local editor)
git add .
git commit -m "docs: update [topic]"
git push origin main
# Return to main repo and commit submodule update
cd ..
git add wiki
git commit -m "chore: update wiki submodule"
git push origin mainThe docs/ folder contains generated/supplementary documentation:
01_END_USER_GUIDE.md— User-facing guide02_MOD_CREATOR_GUIDE.md— Modding documentation03_CONTRIBUTOR_GUIDE.md— Developer/contributor guideexamples/— Code examples and templatesINDEX.md— This file
To update docs:
# Edit .md files directly
git add docs/
git commit -m "docs: update [topic]"
git push origin mainWant to improve the docs? Here's how:
- Identify the gap: Missing info, outdated section, unclear explanation?
- Create an issue: GitHub Issues with label
documentation - Fork and edit: Edit the relevant
.mdfile - Submit PR: Include a clear description of changes
- Review: Maintainers will review for clarity and accuracy
Documentation style guide:
- Use clear, concise language
- Include code examples where relevant
- Link to related sections
- Add screenshots for UI-heavy topics
- Test any instructions you add
This documentation is for:
- gregModmanager v1.5.1
- .NET 9.0+
- Avalonia UI 11.2+
- MelonLoader 0.6.0+
- gregCore 2.0.0+
Documentation for other versions:
- v1.5.0: See releases/tag/v1.5.0
- Older versions: Refer to Git history
Last Updated: May 2026 Next Review: November 2026