Skip to content
This repository was archived by the owner on Apr 8, 2026. It is now read-only.

README_EN.md

Latest commit

 

History

History
203 lines (167 loc) · 7.67 KB

README_EN.md

File metadata and controls

203 lines (167 loc) · 7.67 KB

icon ColorMC

A cross-platform Minecraft PC launcher

Built with .NET 10 as the runtime environment, XAML as the frontend language using MVVM pattern, and C# as the backend language

QQ Group: 571239090

More Languages: 中文

User Manual - Changelog - Join Multi-language Translation(Please help)

Window Screenshots 🪟

Supported Platforms

  • Windows (zip)
  • Linux (provides deb, pkg, rpm packages, also available on Spark Store or AUR)
  • macOS (zip, dmg)

Note: ARM64 platform compatibility is not guaranteed
Due to the complexity of Linux distributions, compatibility varies across different computers. If the launcher fails to start, you may need to resolve issues yourself. I only test startup in my own virtual machine, and driver compatibility issues are beyond my consideration scope.

Installation

Download the pre-built packages/installers from Releases - Official Releases or Actions - Beta Releases
Extract (zip) / Install (msi, deb, pkg) / or run directly (appimage)

Launching

  • Launch after installation
    On Windows/MacOS, extract and double-click to launch
    On Linux, after installation, you can double-click to launch or use the terminal command:
$ ColorMC.Launcher
  • Launch from source code (requires .NET 10 SDK installation)
$ git clone https://github.com/Coloryr/ColorMC.git
$ cd ColorMC
$ git submodule update --init --recursive
$ cd src/ColorMC.Launcher
$ dotnet run

Building from Source

You can build ColorMC from source code and run it
After building, you can get all binary files in the built_out folder

Building windows binaries

Requires Windows system with git and dotnet-10-sdk installed

git clone https://github.com/Coloryr/ColorMC.git
cd ColorMC

@REM Update source code
.\build\update.cmd

@REM Build
.\build\build-windows.cmd

Building linux binaries

Requires Linux system with git and dotnet-10-sdk installed

$ git clone https://github.com/Coloryr/ColorMC.git
$ cd ColorMC
$ chmod a+x ./build/update.sh
$ chmod a+x ./build/build-linux.sh

Update source code

$ ./build/update.sh

Build

$ ./build/build-linux.sh

Packaging Linux-related installation images

  • Package Ubuntu image
    Requires Ubuntu system
$ chmod a+x ./build/build-ubuntu.sh
$ ./build/build-ubuntu.sh
  • Package rpm image
    Requires Ubuntu system
$ chmod a+x ./build/build-rpm.sh
$ ./build/build-rpm.sh
  • Package Arch image
    Requires Arch system
$ chmod a+x ./build/build-arch.sh
$ ./build/build-arch.sh

Building macos binaries

Requires macOS system with git and dotnet-10-sdk installed

$ git clone https://github.com/Coloryr/ColorMC.git
$ cd ColorMC
$ chmod a+x ./build/update.sh
$ chmod a+x ./build/build-macos.sh

Update source code

$ ./build/update.sh

Build

$ ./build/build-macos.sh
  • Package Dmg image Requires macOS system
$ ./build/build-dmg.sh

Secondary Development

First clone the code

$ git clone https://github.com/Coloryr/ColorMC.git
$ git submodule update --init --recursive

./src/ColorMC.sln is the root project

Using ColorMC Launcher Core

Use ColorMC Launcher Core to develop your own launcher

Project Description

Module Description
ColorMC.Core Launcher core
ColorMC.CustomGui Custom launcher interface Tutorial
ColorMC.Cmd Command line mode (deprecated)
ColorMC.Gui GUI mode
ColorMC.Launcher Launcher main program
ColorMC.Test For launcher testing
ColorMC.Setup.Wix For building Windows msi installer

Dependencies/Referenced Projects

Name Description Link
AvaloniaUI Cross-platform UI framework GitHub
Ae.Dns DNS client GitHub
HtmlAgilityPack HTML parser GitHub
Jint JS parser/executor GitHub
DialogHost.Avalonia Dialog library GitHub
CommunityToolkit.Mvvm MVVM tools GitHub
Svg.Skia Svg image display GitHub
SkiaSharp Skia image library GitHub
Silk.NET High-performance low-level library interface GitHub
DotNetty Asynchronous communication framework GitHub
Tomlyn TOML parser GitHub
ForgeWrapper Forge launcher GitHub
OptifineWrapper Optifine launcher GitHub
ColorMCASM For ColorMC to communicate with in-game GitHub
K4os.Compression.LZ4 LZ4 decompression GitHub
sharpcompress Archive decompression GitHub
Markdig MarkDown processing tool GitHub
MinecraftSkinRender Minecraft skin renderer GitHub

Open Source License

Apache 2.0

Copyright 2024 coloryr

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Subsidiary open source licenses: MIT, BSD

IDE Development Tools Used