Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@natsurainko
natsurainko authored Jan 27, 2024
1 parent b16e4bd commit 635af1c
Showing 1 changed file with 96 additions and 123 deletions.
219 changes: 96 additions & 123 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,116 +1,103 @@
# Natsurainko.FluentLauncher

<!-- PROJECT SHIELDS -->

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]

<!-- PROJECT LOGO -->
<br />

<p align="center">
<a>
<img src="docs/images/AppIcon.png" alt="Logo" width="80" height="80">
</a>

<h3 align="center">Natsurainko.FluentLauncher</h3>
<p align="center">
基于 WinUI 3 的 Minecraft: Java Edition 启动器
<br />
<p align="center">
简体中文 | English（暂无）
</p>
<p align="center">
<a href="https://github.com/Xcube-Studio/Natsurainko.FluentLauncher/releases">查看发行版</a>
·
<a href="https://github.com/Xcube-Studio/Natsurainko.FluentLauncher/issues">报告Bug</a>
·
<a href="https://github.com/Xcube-Studio/Natsurainko.FluentLauncher/issues">提出新特性</a>
</p>
</p>
</p>


## 目录
- [简介](#简介)
- [如何安装](#如何安装)
- [如何使用](#如何使用)
- [开发相关](#开发相关)
- [如何编译源代码](#如何编译源代码)
- [如何贡献该项目](#如何贡献该项目)
- [贡献者](#贡献者)
- [联系开发者](#联系开发者)
- [鸣谢](#鸣谢)

### 简介

**这是一款完全基于 WinUI3 技术开的一款 Fluent Design 的 Minecraft 启动器
我们的设计目标在于简洁、流畅的视觉体验**

<img src="docs/images/image3.png">

----------------------
#### 如何安装

+ 我们推荐你直接从 Microsoft Store 直接安装我们的应用，这应该是最省事的办法（但是可能存在更新不及时的问题）
[![Microsoft Store](https://get.microsoft.com/images/en-us%20dark.svg)](https://apps.microsoft.com/store/detail/natsuriankofluentlauncher/9p4nqqxq942p)
+ 从我们的提交的自动构建（Action）里面下载最近一次的 Build 的 msixbundle 安装包进行手动安装
# <img src="docs/images/AppIcon.png" alt="Logo" width="24" height="24"> Fluent Launcher
![](https://img.shields.io/badge/license-MIT-green)
![](https://img.shields.io/github/repo-size/Xcube-Studio/Natsurainko.FluentLauncher)
![](https://img.shields.io/github/stars/Xcube-Studio/Natsurainko.FluentLauncher)
![](https://img.shields.io/github/contributors/Xcube-Studio/Natsurainko.FluentLauncher)
![](https://img.shields.io/github/commit-activity/y/Xcube-Studio/Natsurainko.FluentLauncher)

基于 .NET 8 以及 WinUI3 技术开发的 Minecraft Java 版启动器
专为 Windows 11 设计的 Minecraft 启动器
提供简洁、流畅的视觉体验

>
> 下一次更新预告：
> 更新高频期预计在二月份，现在还在等着放寒假
> 具体的更新事项我会在 Project 的路线图中把所有问题列出来
> —— 2024.1.27
>
## 窗口截图 🪟
<img src="docs/images/image0.png">

## 未来路线计划 📝

| 功能 | 状态 |
| ---------------------------------------- | ------------------ |
| 升级到 CommunityToolkit 8.0 `[紧急]` | [ ] |
| 启动过程异步化 | [ ] |
| 游戏整合包导入 | [ ] |
| 皮肤管理与 3D 预览 (需要讨论?) | [ ] |
| Native AOT 支持 (需要讨论?) | [ ] |

## 功能列表 ✨

+ 基本功能
+ [x] 管理 .minecraft 中的游戏核心、安装游戏核心
+ [x] 特定游戏核心设置、版本隔离设置
+ [x] 管理特定游戏核心的模组
+ [x] 创建、启动、管理 Minecraft 进程
+ [x] 多线程高速补全游戏资源
+ [x] 查找已安装的 Java 运行时
+ [x] 任务栏快速启动游戏
+ [x] 支持第三方下载镜像源 [Bmclapi、Mcbbs](https://bmclapidoc.bangbang93.com/)
+ 多种验证方案的支持
+ [x] 微软验证
+ [x] Yggdrasil 验证 (外置验证)
+ [x] 离线验证
+ [ ] 统一通行证验证 (`需要讨论?`)
+ 多种加载器安装器的支持
+ [x] Forge 安装器 (NeoForge 暂用)
+ [x] Fabric 安装器
+ [x] OptiFine 安装器
+ [x] Quilt 安装器
+ [ ] LiteLoder (`已过时而未支持`)
+ 第三方资源下载的支持
+ [x] 下载 CurseForge 上的资源
+ [x] 下载 Modrinth 上的资源

## 安装本应用 ✈️

#### *一定需要安装 [.NET 8 运行时](https://dotnet.microsoft.com/zh-cn/download/dotnet/8.0) (不论是从哪种渠道安装)*


+ 从 Microsoft Store 获取我们的应用 <a><img src="https://get.microsoft.com/images/en-us%20dark.svg" alt="Logo" width="70" height="20"></a>
+ 从 Action 下载最近一次的 Build 的 msixbundle 安装包进行手动安装
+ [如何安装 Msixbundle 包 ?](https://github.com/Xcube-Studio/Natsurainko.FluentLauncher/wiki/%E5%A6%82%E4%BD%95%E5%AE%89%E8%A3%85-Msixbundle-%E5%8C%85)
+ 你可以 clone 这个仓库，从源码手动编译程序
+ 克隆本仓库，从源码手动编译程序

#### 如何使用
## 开发事宜 🔧

> 安装完后，第一次使用程序时会提供一个配置向导，来帮助你完成基础启动器配置，其他的高级设置需要你在设置中手动设置
> 剩下的你只需要像别的启动器一样操作就行
### 如何编译源代码

### 开发相关

#### 如何编译源代码

_编译前提：_
+ 安装好 .NET 7 SDK 的开发工具
+ 已经安装好 .NET 桌面开发的 Visual Studio 2022
+ 已经安装好 WindowsAppSDK 1.3 的开发环境和 VS 扩展
编译前提：
> + 安装 .NET 桌面开发的 Visual Studio 2022
> + 安装 .NET 8 SDK 的开发工具
> + 安装 WindowsAppSDK 1.4 的开发环境和 VS 扩展
准备好上述环境后

1. 克隆该仓库及其子模块 Natsurainko.FluentCore
1. 克隆该仓库及其子模块 Natsurainko.FluentCore、FluentLauncher.LocalizationPoroject
2. 确保代码完整后，在本地用 Visual Studio 打开
3. 在 Nuget 包管理器中添加 CommunityToolkit-Labs 的 Nuget 包源
https://pkgs.dev.azure.com/dotnet/CommunityToolkit/_packaging/CommunityToolkit-Labs/nuget/v3/index.json
https://pkgs.dev.azure.com/dotnet/CommunityToolkit/_packaging/CommunityToolkit-Labs/nuget/v3/index.json (升级到 CommunityToolkit 8.0 后将不需要)
4. F5 编译运行

#### 如何与本地化联立开发

1. 克隆项目 [FluentLauncher.LocalizationPoroject](https://github.com/Xcube-Studio/FluentLauncher.LocalizationPoroject) 并将其与本项目的仓库的目录并列在同一目录下

![image](https://github.com/Xcube-Studio/Natsurainko.FluentLauncher/assets/55646983/29d67f5d-d561-458a-a8c0-e0793036c8b4)
### 本地化调试开发

2. 在 Visual Studio 中正常编译即可
3. 对于 FluentLauncher.LocalizationPoroject 的修改，请在其仓库中提交pr
`本地化脚本目前有所改动，暂时先不列出`

调试本地化资源时，只需要修改 FluentLauncher.LocalizationPoroject 仓库下的 .csv 文件，Visual Studio 生成时会通过 `Localizer.bat` 自动生成 Strings 文件夹
#### 贡献本地化资源
详细见仓库 **[Xcube-Studio/FluentLauncher.LocalizationPoroject](https://github.com/Xcube-Studio/FluentLauncher.LocalizationPoroject)**

#### 如何贡献该项目
### 如何贡献该项目

1. 点击右上角 `Fork` ，再点击下方 `Create fork` 创建一份本仓库的分支
2. 创建你的内容分支：`git checkout -b feature/[your-feature]`
3. 提交你的更改：`git commit -m '[描述你的更改]'`
4. 将更改推送至远程分支：`git push origin feature/[your-feature]`
5. 创建拉取请求

#### 如何贡献本地化资源

详细见仓库 **[Xcube-Studio/FluentLauncher.LocalizationPoroject](https://github.com/Xcube-Studio/FluentLauncher.LocalizationPoroject)**

### 版本控制

该项目使用Git进行版本管理。您可以在 repository 参看当前可用版本。

### 贡献者
## 主要贡献者 🧑‍💻

* **natsurainko** - *启动核心 启动器*
* **gavinY** - *启动器 后端架构*
Expand All @@ -120,38 +107,24 @@ https://pkgs.dev.azure.com/dotnet/CommunityToolkit/_packaging/CommunityToolkit-L

*您也可以在贡献者名单中参看所有参与该项目的开发者。*

#### 联系开发者
## 与我们联系 ☕️

Xcube Studio 开发群(qq): 1138713376
Natsurainko 的邮箱: [email protected]

如果有任何项目代码的问题还是建议留 issues，各位贡献者都比较忙碌，不太有时间回复私信之类的

## 引用及鸣谢 🎉

#### 引用
+ 本篇 readme 模板引用自 [readme-template](https://github.com/iuricode/readme-template)

> natsurainko [email protected]
> Xcube Studio qq群:1138713376
#### 鸣谢
+ 首先感谢各位贡献者的共同努力
+ 感谢 bangbang93 以及 mcbbs 提供镜像站服务 如果支持他们的服务话 可以[赞助Bmclapi](https://afdian.net/@bangbang93)
+ 感谢 [Cloudflare CDN](https://www.cloudflare.com) 提供的云服务

### 版权说明
## 版权

该项目签署了MIT 授权许可，详情请参阅 [LICENSE](LICENSE)
Copyright (c) 2022-2023 Xcube Studio

### 鸣谢

- [Best_README_template 模板](https://github.com/shaojintian/Best_README_template)
- [bmclapi 下载源](https://bmclapidoc.bangbang93.com/)
- [mcbbs 下载源](https://download.mcbbs.net)
- [Cloudflare CDN](https://www.cloudflare.com)

## 这里是一只猫猫

<p align="center">
<img src="docs/images/70.png" height="150">
</p>

<!-- links -->
[your-project-path]:Xcube-Studio/Natsurainko.FluentLauncher
[contributors-shield]: https://img.shields.io/github/contributors/Xcube-Studio/Natsurainko.FluentLauncher.svg?style=flat-square
[contributors-url]: https://github.com/Xcube-Studio/Natsurainko.FluentLauncher/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Xcube-Studio/Natsurainko.FluentLauncher.svg?style=flat-square
[forks-url]: https://github.com/Xcube-Studio/Natsurainko.FluentLauncher/network/members
[stars-shield]: https://img.shields.io/github/stars/Xcube-Studio/Natsurainko.FluentLauncher.svg?style=flat-square
[stars-url]: https://github.com/Xcube-Studio/Natsurainko.FluentLauncher/stargazers
[issues-shield]: https://img.shields.io/github/issues/Xcube-Studio/Natsurainko.FluentLauncher.svg?style=flat-square
[issues-url]: https://img.shields.io/github/issues/Xcube-Studio/Natsurainko.FluentLauncher.svg
[license-shield]: https://img.shields.io/github/license/Xcube-Studio/Natsurainko.FluentLauncher.svg?style=flat-square
[license-url]: https://github.com/Xcube-Studio/Natsurainko.FluentLauncher/blob/master/LICENSE.txt
Copyright (c) 2022-2024 Xcube Studio

0 comments on commit 635af1c

Please sign in to comment.