55![ ] ( https://img.shields.io/github/contributors/Coloryr/ColorMC )
66![ ] ( https://img.shields.io/github/commit-activity/y/Coloryr/ColorMC )
77
8- ** Warning: the following content is translated by ChatGPT **
8+ A cross-platform Minecraft PC launcher
99
10- A cross-platform Minecraft PC launcher.
11-
12- Built with .NET8, UI use the XAML with MVVM, and C# as the backend language.
10+ Built with .NET 10 as the runtime environment, XAML as the frontend language using MVVM pattern, and C# as the backend language
1311
1412QQ Group: 571239090
1513
16- More Languages: [ Chinese ] ( README_EN .md)
14+ More Languages: [ 中文 ] ( README .md)
1715
18- [ User Manual] ( https://github.com/Coloryr/ColorMC_Pic/blob/master/guide/Main .md ) -
19- [ Changelog] ( log.md ) -
20- [ Join Translation Efforts ] ( https://crowdin.com/project/colormc ) (Need Help! )
16+ [ User Manual] ( https://github.com/Coloryr/ColorMC_Pic/blob/master/guide/README .md ) -
17+ [ Changelog] ( log.md ) -
18+ [ Join Multi-language Translation ] ( https://crowdin.com/project/colormc ) (Please help )
2119
2220## Window Screenshots 🪟
23- ![ ] ( /docs/images/run .png )
21+ ![ ] ( /docs/images/image .png )
2422
2523** Demo Animation**
2624
27- ![ ] ( /docs/images/GIF.gif )
25+ https://github.com/user-attachments/assets/4b3b1207-58a9-46e8-a99c-b9f1a64761be
2826
2927## Supported Platforms
30- - Linux (deb, pkg, rpm, also can be install with [ spark-store ] ( https://www.spark-app.store/ ) or [ AUR ] ( https://aur.archlinux.org/ ) )
31- - Windows
32- - macOS
28+ - Windows (zip )
29+ - Linux (provides deb, pkg, rpm packages, also available on [ Spark Store ] ( https://www.spark-app.store/ ) or [ AUR ] ( https://aur.archlinux.org/ ) )
30+ - macOS (zip, dmg)
3331
34- ** Note: ARM64 platform compatibility is not guaranteed.
35- 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 .**
32+ ** Note: ARM64 platform compatibility is not guaranteed
33+ 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 .**
3634
3735## Installation
38- Download the pre-built compressed files /installers from [ Releases] ( https://github.com/Coloryr/ColorMC/releases ) or [ Actions- Beta] ( https://github.com/Coloryr/ColorMC/actions ) .
39- Extract (zip)/ Install (msi, deb, pkg)/ or run directly (appimage).
36+ Download the pre-built packages /installers from [ Releases - Official Releases ] ( https://github.com/Coloryr/ColorMC/releases ) or [ Actions - Beta Releases ] ( https://github.com/Coloryr/ColorMC/actions )
37+ Extract (zip) / Install (msi, deb, pkg) / or run directly (appimage)
4038
41- ## Launch
39+ ## Launching
4240
43- - After installation:
44- On Windows/macOS, double-click the extracted file to run.
45- On Linux, double-click to run, or use this command in terminal:
41+ - Launch after installation
42+ On Windows/MacOS, extract and double-click to launch
43+ On Linux, after installation, you can double-click to launch or use the terminal command :
4644```
4745$ ColorMC.Launcher
4846```
4947
50- - Run from source (requires .NET8 SDK):
48+ - Launch from source code (requires .NET 10 SDK installation)
5149```
5250$ git clone https://github.com/Coloryr/ColorMC.git
53- $ cd ColorMC/src/ColorMC.Launcher
51+ $ cd ColorMC
52+ $ git submodule update --init --recursive
53+ $ cd src/ColorMC.Launcher
5454$ dotnet run
5555```
5656
57- ## Build from Source
57+ ## Building from Source
5858
59- You can build ColorMC from the source code and run it.
60- After the construction is completed, all binary files can be obtained in the ` built_out ` folder
59+ You can build ColorMC from source code and run it
60+ After building, you can get all binary files in the ` built_out ` folder
6161
62- ### Build Windows Binary
63- ** Must be built on Windows with git and dotnet-8 -sdk installed. **
62+ ### Building ` windows ` binaries
63+ ** Requires Windows system with git and dotnet-10 -sdk installed**
6464
6565```
6666git clone https://github.com/Coloryr/ColorMC.git
@@ -69,12 +69,12 @@ cd ColorMC
6969@REM Update source code
7070.\build\update.cmd
7171
72- @REM Build binary
72+ @REM Build
7373.\build\build-windows.cmd
7474```
7575
76- ### Build Linux Binary
77- ** Must be built on Linux with git and dotnet-8 -sdk installed. **
76+ ### Building ` linux ` binaries
77+ ** Requires Linux system with git and dotnet-10 -sdk installed**
7878```
7979$ git clone https://github.com/Coloryr/ColorMC.git
8080$ cd ColorMC
@@ -83,36 +83,36 @@ $ chmod a+x ./build/build-linux.sh
8383```
8484Update source code
8585```
86- ./build/update.sh
86+ $ ./build/update.sh
8787```
88- Build binary
88+ Build
8989```
90- ./build/build-linux.sh
90+ $ ./build/build-linux.sh
9191```
9292
93- ### Package Linux Images
93+ ### Packaging Linux-related installation images
9494
95- - Packaging Ubuntu Images
96- ** Need to operate on Ubuntu system**
95+ - Package Ubuntu image
96+ ** Requires Ubuntu system**
9797```
9898$ chmod a+x ./build/build-ubuntu.sh
9999$ ./build/build-ubuntu.sh
100100```
101- - Packaging RPM Images
102- ** Need to operate on Ubuntu system**
101+ - Package rpm image
102+ ** Requires Ubuntu system**
103103```
104104$ chmod a+x ./build/build-rpm.sh
105105$ ./build/build-rpm.sh
106106```
107- - Packaging Arch Images
108- ** Need to operate on Arch system**
107+ - Package Arch image
108+ ** Requires Arch system**
109109```
110110$ chmod a+x ./build/build-arch.sh
111111$ ./build/build-arch.sh
112112```
113113
114- ### Build macOS Binary
115- ** Must be built on Ubuntu or macOS with git and dotnet-8 -sdk installed. **
114+ ### Building ` macos ` binaries
115+ ** Requires macOS system with git and dotnet-10 -sdk installed**
116116```
117117$ git clone https://github.com/Coloryr/ColorMC.git
118118$ cd ColorMC
@@ -121,58 +121,64 @@ $ chmod a+x ./build/build-macos.sh
121121```
122122Update source code
123123```
124- ./build/update.sh
124+ $ ./build/update.sh
125125```
126- Build binary
126+ Build
127127```
128- ./build/build-macos.sh
128+ $ ./build/build-macos.sh
129+ ```
130+ - Package Dmg image
131+ ** Requires macOS system**
132+ ```
133+ $ ./build/build-dmg.sh
129134```
130135
131- ## Development
136+ ## Secondary Development
132137
133- Clone the repository:
138+ First clone the code
134139```
135140$ git clone https://github.com/Coloryr/ColorMC.git
136141$ git submodule update --init --recursive
137142```
138143
139- The main solution file is ` ./src/ColorMC.sln ` .
144+ ` ./src/ColorMC.sln ` is the root project
140145
141146### Using ColorMC Launcher Core
142147
143- [ How to develop your own launcher using ColorMC Core ] ( Core.md )
148+ [ Use ColorMC Launcher Core to develop your own launcher] ( docs/ Core.md)
144149
145- ### Project Modules Overview
146- | Module | Description |
147- | -------------------| ------- --------------------------------------|
148- | ColorMC.Core | Launcher core |
149- | ColorMC.CustomGui | Custom launcher UI [ Tutorial] ( CustomGui.md ) |
150- | ColorMC.Cmd | Command- line mode (Deprecated) |
151- | ColorMC.Gui | GUI mode |
152- | ColorMC.Launcher | Launcher main application |
153- | ColorMC.Test | For launcher testing |
154- | ColorMC.Setup | For building Windows msi installer |
150+ ### Project Description
151+ | Module | Description |
152+ | ----------------------| --------------------------------------|
153+ | ColorMC.Core | Launcher core |
154+ | ColorMC.CustomGui | Custom launcher interface [ Tutorial] ( docs/ CustomGui.md) |
155+ | ColorMC.Cmd | Command line mode (deprecated) |
156+ | ColorMC.Gui | GUI mode |
157+ | ColorMC.Launcher | Launcher main program |
158+ | ColorMC.Test | For launcher testing |
159+ | ColorMC.Setup.Wix | For building Windows msi installer |
155160
156161## Dependencies/Referenced Projects
157- | 名称 | 描述 | 链接 |
158- | -----------------------| -----------------| ----------------------------------------------------------------|
159- | AvaloniaUI | .NET UI | [ GitHub] ( https://github.com/AvaloniaUI/Avalonia ) |
160- | DialogHost.Avalonia | AvaloniaUI dialog control | [ GitHub] ( https://github.com/AvaloniaUtils/DialogHost.Avalonia ) |
161- | CommunityToolkit.Mvvm | .NET Community Toolkit | [ GitHub] ( https://github.com/CommunityToolkit/dotnet ) |
162- | Svg.Skia | An SVG rendering library | [ GitHub] ( https://github.com/wieslawsoltes/Svg.Skia ) |
163- | SkiaSharp | 2D graphics API | [ GitHub] ( https://github.com/mono/SkiaSharp ) |
164- | Silk.NET | bindings library | [ GitHub] ( https://github.com/dotnet/Silk.NET ) | |
165- | HtmlAgilityPack | HTML parser | [ GitHub] ( https://github.com/zzzprojects/html-agility-pack ) |
166- | Jint | Javascript Interpreter for .NET | [ GitHub] ( https://github.com/sebastienros/jint ) |
167- | DotNetty | a port of netty | [ GitHub] ( https://github.com/Azure/DotNetty ) |
168- | Newtonsoft.Json | JSON framework for .NET | [ GitHub] ( https://github.com/JamesNK/Newtonsoft.Json ) |
169- | SharpZipLib | Zip Tool | [ GitHub] ( https://github.com/icsharpcode/SharpZipLib ) |
170- | Tomlyn | TOML parser | [ GitHub] ( https://github.com/xoofx/Tomlyn ) |
171- | ForgeWrapper | Forge Launcher for Minecraft | [ GitHub] ( https://github.com/Coloryr/ForgeWrapper ) | |
172- | OptifineWrapper | Optifine Launcher for Minecraft | [ GitHub] ( https://github.com/coloryr/OptifineWrapper ) |
173- | ColorMCASM | ColorMC with game channel | [ GitHub] ( https://github.com/Coloryr/ColorMCASM ) |
174- | K4os.Compression.LZ4 | LZ4/LH4HC compression | [ GitHub] ( https://github.com/MiloszKrajewski/K4os.Compression.LZ4 ) |
175- | Ae.Dns | DNS clients | [ GitHub] ( https://github.com/alanedwardes/Ae.Dns ) |
162+ | Name | Description | Link |
163+ | -------------------------| -----------------------| ------------------------------------------------------------------|
164+ | AvaloniaUI | Cross-platform UI framework | [ GitHub] ( https://github.com/AvaloniaUI/Avalonia ) |
165+ | Ae.Dns | DNS client | [ GitHub] ( https://github.com/alanedwardes/Ae.Dns ) |
166+ | HtmlAgilityPack | HTML parser | [ GitHub] ( https://github.com/zzzprojects/html-agility-pack ) |
167+ | Jint | JS parser/executor | [ GitHub] ( https://github.com/sebastienros/jint ) |
168+ | DialogHost.Avalonia | Dialog library | [ GitHub] ( https://github.com/AvaloniaUtils/DialogHost.Avalonia ) |
169+ | CommunityToolkit.Mvvm | MVVM tools | [ GitHub] ( https://github.com/CommunityToolkit/dotnet ) |
170+ | Svg.Skia | Svg image display | [ GitHub] ( https://github.com/wieslawsoltes/Svg.Skia ) |
171+ | SkiaSharp | Skia image library | [ GitHub] ( https://github.com/mono/SkiaSharp ) |
172+ | Silk.NET | High-performance low-level library interface | [ GitHub] ( https://github.com/dotnet/Silk.NET ) |
173+ | DotNetty | Asynchronous communication framework | [ GitHub] ( https://github.com/Azure/DotNetty ) |
174+ | Tomlyn | TOML parser | [ GitHub] ( https://github.com/xoofx/Tomlyn ) |
175+ | ForgeWrapper | Forge launcher | [ GitHub] ( https://github.com/PrismLauncher/ForgeWrapper ) |
176+ | OptifineWrapper | Optifine launcher | [ GitHub] ( https://github.com/coloryr/OptifineWrapper ) |
177+ | ColorMCASM | For ColorMC to communicate with in-game | [ GitHub] ( https://github.com/Coloryr/ColorMCASM ) |
178+ | K4os.Compression.LZ4 | LZ4 decompression | [ GitHub] ( https://github.com/MiloszKrajewski/K4os.Compression.LZ4 ) |
179+ | sharpcompress | Archive decompression | [ GitHub] ( https://github.com/adamhathcock/sharpcompress ) |
180+ | Markdig | MarkDown processing tool | [ GitHub] ( https://github.com/xoofx/markdig ) |
181+ | MinecraftSkinRender | Minecraft skin renderer | [ GitHub] ( https://github.com/Coloryr/MinecraftSkinRender ) |
176182
177183## Open Source License
178184Apache 2.0
@@ -193,7 +199,9 @@ See the License for the specific language governing permissions and
193199limitations under the License.
194200```
195201
196- ### Development Tools
202+ Subsidiary open source licenses: MIT, BSD
203+
204+ ## IDE Development Tools Used
197205- [ Visual Studio Code] ( https://code.visualstudio.com/ )
198206- [ Visual Studio 2022] ( https://visualstudio.microsoft.com/ )
199207- ![ dotMemory logo] ( https://resources.jetbrains.com/storage/products/company/brand/logos/dotMemory_icon.svg )
0 commit comments