Skip to content

๐Ÿฟ๏ธ A next-generation Minecraft instance manager that thinks differently about game management

License

Notifications You must be signed in to change notification settings

d3ara1n/Polymerium

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

1,048 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Polymerium

Polymerium

A next-generation Minecraft instance manager that thinks differently about game management.

License: MIT .NET 10.0 Avalonia C# zread

Codacy Badge CodeFactor

๐ŸŒ ไธญๆ–‡ไป‹็ป โ€ข ๐Ÿ“ฅ Download โ€ข ๐Ÿ“– Documentation โ€ข ๐Ÿ› Report Bug โ€ข ๐Ÿ’ก Request Feature


๐ŸŽฎ Experience Polymerium in Action

Screenshot

From launch to gameplay in seconds โšก


๐ŸŒŸ What Makes Polymerium Different

Traditional Minecraft launchers manage files. Polymerium manages experiences.

๐Ÿš€ The Evolution of Minecraft Launchers

Generation Management Focus Representative Approach
1st Gen ๐Ÿ“ Versions "Version Isolation" mechanism
2nd Gen ๐Ÿ“ฆ Instances Isolated game environments with copied resources
3rd Gen ๐Ÿงฌ Metadata Declarative configuration with on-demand deployment

Polymerium is a third-generation launcher. Instead of copying and storing thousands of mod files for each instance, Polymerium describes your game setup as lightweight metadata and builds the actual game files on-demand. This revolutionary approach brings several game-changing benefits:

๐ŸŽฏ Smart Resource Management

  • Zero Duplication: Multiple instances sharing the same mods? Only one copy exists on disk
  • Symlink Magic: Files are intelligently linked, not copied, saving gigabytes of storage
  • Instant Switching: Change between completely different modpacks in seconds

๐Ÿ“ฆ Portable Game Experiences

  • Metadata-Driven: Your entire game setup fits in a tiny configuration file
  • Version Control Ready: Use Git to collaborate on modpack development
  • True Portability: Share your exact game experience with a simple file transfer

๐Ÿ”ง Effortless Maintenance

  • Integrity Guaranteed: Every deployment validates file completeness and correctness
  • Dependency Resolution: Automatically handles mod dependencies and conflicts
  • One-Click Updates: Upgrade individual mods or entire modpacks seamlessly

๐ŸŽฎ Player-Focused Design

  • No Java Hunting: Configure Java once, works everywhere
  • Account Flexibility: Multiple accounts, each linked to specific instances
  • Clean Uninstall: Remove Polymerium completely by deleting two folders

โœจ Key Features

๐Ÿ—๏ธ Modern Architecture

  • ๐ŸŽจ Avalonia UI: Beautiful, responsive interface that works across platforms
  • ๐Ÿ“‹ Metadata Engine: Lightweight instance descriptions that rebuild perfectly every time
  • ๐Ÿš€ Deployment System: Intelligent file management with integrity checking
  • ๐Ÿ”— Resource Pooling: Shared file storage with symlink distribution

๐ŸŒ Platform Integration

  • ๐ŸŽŸ๏ธ CurseForge & Modrinth: Native integration with major mod repositories
  • ๐Ÿ“ฆ Modpack Publishing: Export your instances as distributable modpacks
  • ๐Ÿ“ Automatic Changelogs: Generated documentation for your modpack versions

๐Ÿ‘จโ€๐Ÿ’ป Developer Experience

  • ๐Ÿ“ธ Instance Snapshots: Save and restore complete game states
  • ๐Ÿ“œ Layered Configuration: Separate user settings from core game data
  • ๐Ÿ”„ Build Reproducibility: Identical deployments from the same metadata

Getting Started

Prerequisites

Important

Windows Developer Mode Required

Polymerium uses symbolic links for efficient file management. Enable Developer Mode to allow symlink creation without administrator privileges.

๐Ÿ“‹ How to Enable Developer Mode

Windows 11
Settings โ†’ System โ†’ For developers โ†’ Developer Mode
Windows 10
Settings โ†’ Update & Security โ†’ For developers โ†’ Developer Mode
Windows 7/8
Upgrade to Windows 10+ first ๐Ÿ’ฅ

๐Ÿ“ฅ Installation

Note

Polymerium is currently in active development. Features and UI may change between releases.

๐Ÿ“ฅ Download โ†’ ๐Ÿ“‚ Extract โ†’ ๐Ÿš€ Run โ†’ โš™๏ธ Setup

  1. Download the latest release from GitHub Releases
  2. Run installer Polymerium-[arch]-Setup.exe
  3. Follow the setup wizard to configure your first instance

๐Ÿš€ Quick Start

๐ŸŽฎ Create โ†’ ๐Ÿ“ฆ Add Content โ†’ ๐Ÿ”ง Deploy โ†’ โ–ถ๏ธ Play

  1. Create Instance: Define your Minecraft version and mod loader
  2. Add Content: Browse and install mods from CurseForge or Modrinth
  3. Deploy: Let Polymerium build your game files
  4. Play: Launch directly or export as a modpack

๐Ÿ—๏ธ Architecture Overview

๐Ÿ› ๏ธ Technology ๐Ÿ“‹ Purpose ๐Ÿ”— Integration
.NET 10.0 Latest runtime with C# preview features Core platform
Avalonia 11 Cross-platform XAML UI framework Presentation layer
MVVM Pattern Clean separation of concerns Architecture pattern
Dependency Injection Modular, testable architecture Service management
Reactive Extensions Responsive data handling Data flow

๐Ÿ“ Project Structure

Polymerium/
โ”œโ”€โ”€ ๐Ÿ“š docs/                   # Documentation
โ”œโ”€โ”€ ๐ŸŽจ src/Polymerium.App/     # UI application layer
โ”œโ”€โ”€ ๐Ÿ”— submodules/             # Shared components
โ””โ”€โ”€ ๐Ÿ“ฆ Releases/               # Build artifacts

Development

๐Ÿ”จ Building from Source

# Clone with submodules
git clone --recursive https://github.com/d3ara1n/Polymerium.git
cd Polymerium

# Build the solution
dotnet build

# Run in development mode
./Development.ps1

๐Ÿ› ๏ธ Development Commands

# Development mode
./Development.ps1

# Production mode
./Production.ps1

# Build and publish
./Publish.ps1

# Get version info
dotnet gitversion

# Generate changelog
git cliff

๐Ÿค Contributing

We welcome contributions! Please ensure your code follows the established patterns:

Aspect Requirement
๐Ÿ—๏ธ Architecture MVVM pattern with clear separation of concerns
๐Ÿ’‰ Dependency Injection Use constructor injection throughout
๐Ÿ”ฅ Modern C# Leverage latest language features and patterns
โœจ Code Style Follow the .editorconfig guidelines

We use resx for localization. If you want to contribute to the translation, you can edit the Resources.resx file in src/Polymerium.App/Properties and add your language file in the same directory. Rider and Visual Studio have built-in editors for resx files.


๐Ÿ–ฅ๏ธ Platform Support

Platform Status
Windows โœ… Stable
Linux โœ… Stable
macOS ๐Ÿ“‹ Planned

Privacy & Security

Polymerium respects your privacy:

  • Minor Telemetry: Collect least necessary data for debugging
  • Local Storage: All data stays on your machine
  • Minimal Footprint: Clean uninstall leaves no traces
  • Open Source: Transparent, auditable codebase

License

This project is licensed under the MIT License - see the LICENSE file for details.


๐Ÿ“Š Project Statistics

Star History Chart

Repobeats Analytics

๐Ÿ“š References & Acknowledgments

๐Ÿ”— Technical References

๐Ÿ™ Special Thanks

  • Minecraft Community - For the incredible modding ecosystem
  • Avalonia Team - For the excellent cross-platform UI framework
  • API Providers - CurseForge and Modrinth for their public APIs
  • Contributors - Everyone who helps make Polymerium better

๐Ÿ“„ License

FOSSA Status

This project is licensed under the MIT License - see the LICENSE file for details.


Polymerium: Rethinking Minecraft instance management for the modern era โœจ

Made with โค๏ธ by the Polymerium team

About

๐Ÿฟ๏ธ A next-generation Minecraft instance manager that thinks differently about game management

Topics

Resources

License

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •