Skip to content

Coloryr/ColorMC

Repository files navigation

icon ColorMC

一个全平台Minecraft PC启动器

使用.NET8作为运行环境,XAML作为前端语言,C#作为后端语言

QQ交流群: 571239090

More Languages: English

用户手册 - 更新日志 - 加入多语言翻译(帮帮忙)

窗口截图 🪟

演示动画

支持平台

  • Linux(提供deb pkg rpm)
  • Windows
  • macOs

注意:ARM64平台不能保证其兼容性
由于Linux发行版过于复杂,每个人的电脑兼容性都不一样,如果打不开可以需要自行解决,我只在自己的虚拟机内测试启动,若有驱动兼容性问题不在我的考虑范围内

安装

Releases或者Actions里面下载构建好的压缩包/安装包
解压(zip)\安装(msi,deb,pkg)\或直接运行(appimage)即可

Windows下,可以使用winget安装

winget install colormc

默认安装在C:\Program Files\ColorMC

启动

  • 安装完成后启动
    在Windows/MacOS下解压后双击启动
    Linux下可以双击启动,也可以
ColorMC.Launcher
  • 从源码启动(需要安装.NET8 SDK)
git clone https://github.com/Coloryr/ColorMC.git
cd ColorMC/src/ColorMC.Launcher
dotnet run

从源码构建

  • 构建windows的二进制文件
    需要在Windows系统中构建,并安装git与dotnet-8-sdk
git clone https://github.com/Coloryr/ColorMC.git
cd ColorMC

@REM 更新源码
.\build\update.cmd

@REM 构建
.\build\build-windows.cmd
  • 构建linux的二进制文件
    需要在Linux系统中构建,并安装git与dotnet-8-sdk
git clone https://github.com/Coloryr/ColorMC.git
cd ColorMC
chmod a+x ./build/update.sh
chmod a+x ./build/build-linux.sh

# 更新源码
./build/update.sh

# 构建
./build/build-linux.sh

打包Ubuntu镜像
需要在Ubuntu系统中操作

chmod a+x ./build/build-ubuntu.sh

./build/build-ubuntu.sh

打包rpm镜像
需要在Ubuntu系统中操作

chmod a+x ./build/build-rpm.sh

./build/build-rpm.sh

打包Arch镜像
需要在Arch系统中操作

chmod a+x ./build/build-arch.sh

./build/build-arch.sh
  • 构建macos的二进制文件
    需要在Ubuntu系统或MacOS系统中构建,并安装git与dotnet-8-sdk
git clone https://github.com/Coloryr/ColorMC.git
cd ColorMC
chmod a+x ./build/update.sh
chmod a+x ./build/build-macos.sh

# 更新源码
./build/update.sh

# 构建
./build/build-macos.sh

此时可以在built_out文件夹获取所有二进制文件

二次开发

首先克隆代码

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

git submodule update --init --recursive

./src/ColorMC.sln为根工程

使用ColorMC启动器核心

使用ColorMC启动器核心来开发自己的启动器

项目说明

模块 说明
ColorMC.Core 启动器核心
ColorMC.CustomGui 自定义启动器界面 教程
ColorMC.Cmd 命令行模式 (已弃用)
ColorMC.Gui Gui模式
ColorMC.Launcher 启动器本体
ColorMC.Test 用于启动器测试
ColorMC.Setup 用于构建windows的msi安装包

依赖/引用的项目

名称 描述 链接
AvaloniaUI 跨平台UI框架 GitHub
DialogHost.Avalonia 弹窗库 GitHub
CommunityToolkit.Mvvm MVVM工具 GitHub
Svg.Skia Svg图像显示 GitHub
SkiaSharp Skia图像库 GitHub
Silk.NET 高性能底层库接口 GitHub
Heijden.Dns DNS解析 GitHub
HtmlAgilityPack HTML解析器 官网
Jint JS解析执行器 GitHub
DotNetty 异步通信框架 GitHub
Newtonsoft.Json JSON解析器 官网
SharpZipLib 压缩包处理 GitHub
Tomlyn TOML解析器 GitHub
ForgeWrapper Forge启动器 GitHub
Live2DCSharpSDK Live2d渲染框架 GitHub
OptifineWrapper Optifine启动器 GitHub
ColorMCASM 用于ColorMC与游戏内通信 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.

附属的开源协议: MIT, BSD

使用的IDE开发工具