Skip to content

mleem97/gregModmanager

Repository files navigation

gregModmanager

Version .NET Avalonia Platform License Steam

Build & Release Linux Packages

Current Version: v1.6.0

Cross-platform desktop Mod Manager for the gregFramework ecosystem.

Note

gregModmanager is an independent community project developed by the author. The project name and any related domains (e.g. gregmodmanager.eu) are not owned by the author. Official hubs of the ecosystem are gregframework.eu and datacentermods.com.

What is gregModmanager?

gregModmanager is a modern, user-friendly application that simplifies installing, managing, and publishing mods for MelonLoader-based games. It supports Windows and Linux (macOS coming soon), integrates with Steam, and provides an intuitive interface for:

  • Browse & Install mods from datacentermods.com or local files
  • Manage Load Order and resolve dependencies automatically
  • Handle Profiles for different gameplay configurations
  • Update Mods with one click
  • Publish Your Own mods and plugins

πŸ“š Documentation

πŸ‘‰ New users? Start with the End-User Guide πŸ“¦ Creating mods? See the Mod Creator Guide πŸ”§ Want to contribute? Read the Contributor Guide πŸ“– Full index: docs/INDEX.md

πŸš€ Quick Start

For Users

Download and run:

  • Windows (Recommended): Download the Smart Online Installer from Releases. It automatically installs required VC++ Runtimes.
  • Windows (Portable): Download the .zip archive. Ensure VC++ 2015-2022 Redist is installed.
  • Linux: wget https://github.com/mleem97/gregModmanager/releases/download/v1.6.0/gregModmanager-v1.6.0-Linux.tar.gz && tar -xzf *.tar.gz && ./GregModmanager

For Developers

Build locally:

# Clone repository
git clone https://github.com/mleem97/gregModmanager.git
cd gregModmanager

# Install dependencies
dotnet restore GregModmanager.sln

# Build
dotnet build GregModmanager.sln -c Release

# Run
dotnet run --project GregModmanager.Avalonia

Or use the convenience script:

.\scripts\run.ps1

πŸ“‹ System Requirements

Platform Minimum Recommended
Windows Windows 10 v1909, .NET 9 Windows 11, 4+ GB RAM
Linux Debian 11+, Ubuntu 20.04 LTS+ Fedora 36+, 4+ GB RAM
macOS Planned Q3 2026 β€”

See System Requirements for details.

πŸ—οΈ Project Structure

gregModmanager.sln
β”œβ”€β”€ GregModmanager.Core/              # Core business logic
β”œβ”€β”€ GregModmanager.Avalonia/          # Avalonia UI (Windows, Linux)
β”œβ”€β”€ SubDirectoryFixer/                # Helper utility
β”œβ”€β”€ GregModmanager.Tests/             # Unit tests
β”œβ”€β”€ scripts/                          # Build and deployment scripts
β”œβ”€β”€ installer/                        # Inno Setup installer script
β”œβ”€β”€ docs/                             # User and developer documentation
└── wiki/                             # Documentation wiki (Git submodule)

✨ Features

  • βœ… Mod Management β€” Install, enable, disable, update, manage profiles
  • βœ… Dependency Resolution β€” Automatic conflict detection and installation
  • βœ… Steam Integration β€” Auto-detect library, launch via Steam, Workshop support
  • βœ… Smart Installer β€” Automatically downloads and installs required VC++ runtimes
  • βœ… Health Monitoring β€” Built-in crash reporting and performance telemetry
  • βœ… Cross-Platform β€” Windows, Linux, macOS (coming soon)
  • βœ… Localization β€” English, German, Spanish (community translations welcome)

πŸ—οΈ Architecture

  • Framework: Avalonia UI 11.2 (cross-platform)
  • Runtime: .NET 9.0
  • Pattern: Layered architecture with clean Core/UI separation
  • Integration: Steam API, gregCore/gregFramework, datacentermods.com

πŸ”¨ Build & Release

Full Build (Windows + Linux)

.\scripts\build.ps1

Produces:

  • Windows installer (.exe)
  • Windows portable (.zip)
  • Linux AppImage, .deb, .rpm, .tar.gz

Quick Build

.\scripts\run.ps1              # Build & run locally
.\scripts\builder.ps1          # Interactive CLI menu

πŸ“¦ External Integrations

  • datacentermods.com β€” Central mod repository and modding community
  • gregframework.eu β€” gregCore / gregFramework ecosystem documentation
  • melonwiki.xyz β€” MelonLoader documentation
  • Steam API β€” Game library detection and workshop

🀝 Contributing

We welcome contributions! See CONTRIBUTING.md for:

  • Development environment setup
  • Coding standards and conventions
  • Testing requirements
  • Pull request workflow
  • Localization guidelines

Code of Conduct: Be respectful. All contributors are valued.

πŸ”’ Privacy & Telemetry

gregModmanager includes an optional telemetry system to help us improve the application and fix startup issues.

  • What we collect: Anonymized crash reports, startup success/failure, and sync performance metrics.
  • What we DON'T collect: Your name, mod files, or any personal data.
  • Opt-out: You can disable telemetry at any time in the Settings menu.
  • Transparency: All telemetry requests use a secure connection to our self-hosted Loki instance at telemetry.datacentermods.com.

πŸ“„ License

MIT License β€” See LICENSE

🎯 Support

Related Repositories

  • gregCore β€” Game framework
  • gregStore β€” Asset distribution
  • gregBot β€” Discord bot integration
  • Wiki β€” Documentation (submodule)

Maintainers

  • teamGreg / mleem97