Warning: the following content is translated by ChatGPT
A cross-platform Minecraft PC launcher.
Built with .NET8, UI use the XAML with MVVM, and C# as the backend language.
QQ Group: 571239090
More Languages: Chinese
User Manual -
Changelog -
Join Translation Efforts (Need Help!)
Demo Animation
- Linux (deb, pkg, rpm, also can be install with spark-storeorAUR)
- Windows
- macOS
Note: ARM64 platform compatibility is not guaranteed.
Due to the complexity of Linux distributions, compatibility varies between devices. If it doesn’t work, you may need to troubleshoot it yourself. I have only tested the launcher in my own virtual machine. Driver compatibility issues are not within my scope of support.
Download the pre-built compressed files/installers from Releases or Actions-Beta.
Extract (zip)/Install (msi, deb, pkg)/or run directly (appimage).
- After installation:
On Windows/macOS, double-click the extracted file to run.
On Linux, double-click to run, or use this command in terminal:
$ ColorMC.Launcher
- Run from source (requires .NET8 SDK):
$ git clone https://github.com/Coloryr/ColorMC.git
$ cd ColorMC/src/ColorMC.Launcher
$ dotnet run
You can build ColorMC from the source code and run it.
After the construction is completed, all binary files can be obtained in the built_out folder
Must be built on Windows with git and dotnet-8-sdk installed.
git clone https://github.com/Coloryr/ColorMC.git
cd ColorMC
@REM Update source code
.\build\update.cmd
@REM Build binary
.\build\build-windows.cmd
Must be built on Linux with git and dotnet-8-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 binary
./build/build-linux.sh
- Packaging Ubuntu Images
Need to operate on Ubuntu system
$ chmod a+x ./build/build-ubuntu.sh
$ ./build/build-ubuntu.sh
- Packaging RPM Images
Need to operate on Ubuntu system
$ chmod a+x ./build/build-rpm.sh
$ ./build/build-rpm.sh
- Packaging Arch Images
Need to operate on Arch system
$ chmod a+x ./build/build-arch.sh
$ ./build/build-arch.sh
Must be built on Ubuntu or macOS with git and dotnet-8-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 binary
./build/build-macos.sh
Clone the repository:
$ git clone https://github.com/Coloryr/ColorMC.git
$ git submodule update --init --recursive
The main solution file is ./src/ColorMC.sln.
How to develop your own launcher using ColorMC Core
| Module | Description |
|---|---|
| ColorMC.Core | Launcher core |
| ColorMC.CustomGui | Custom launcher UI Tutorial |
| ColorMC.Cmd | Command-line mode (Deprecated) |
| ColorMC.Gui | GUI mode |
| ColorMC.Launcher | Launcher main application |
| ColorMC.Test | For launcher testing |
| ColorMC.Setup | For building Windows msi installer |
| 名称 | 描述 | 链接 |
|---|---|---|
| AvaloniaUI | .NET UI | GitHub |
| DialogHost.Avalonia | AvaloniaUI dialog control | GitHub |
| CommunityToolkit.Mvvm | .NET Community Toolkit | GitHub |
| Svg.Skia | An SVG rendering library | GitHub |
| SkiaSharp | 2D graphics API | GitHub |
| Silk.NET | bindings library | GitHub |
| HtmlAgilityPack | HTML parser | GitHub |
| Jint | Javascript Interpreter for .NET | GitHub |
| DotNetty | a port of netty | GitHub |
| Newtonsoft.Json | JSON framework for .NET | GitHub |
| SharpZipLib | Zip Tool | GitHub |
| Tomlyn | TOML parser | GitHub |
| ForgeWrapper | Forge Launcher for Minecraft | GitHub |
| Live2DCSharpSDK | Live2d Render | GitHub |
| OptifineWrapper | Optifine Launcher for Minecraft | GitHub |
| ColorMCASM | ColorMC with game channel | GitHub |
| K4os.Compression.LZ4 | LZ4/LH4HC compression | GitHub |
| Ae.Dns | DNS clients | GitHub |
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.
