Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
91faf3b
docs: add Chinese README documentation
NtskwK Jan 19, 2026
c281777
docs: update terminology in README
NtskwK Jan 19, 2026
c792c62
feat(docs): add React Router docs with Fumadocs
NtskwK Jan 21, 2026
42b1141
chore(docs): Add roadmap link to README
HsiangNianian Jan 21, 2026
85382b4
Merge branch 'main' into docs/readme
HsiangNianian Jan 21, 2026
9ebcd9e
docs: add chinese readme and docs website (#76)
HsiangNianian Jan 21, 2026
192abdf
Delete CNAME
HsiangNianian Jan 21, 2026
10c560f
Initial plan
Copilot Jan 21, 2026
6db4a3b
docs: add comprehensive documentation for DropOut launcher
Copilot Jan 21, 2026
8254559
docs: add Chinese translations for documentation
Copilot Jan 21, 2026
fe0cb04
docs: configure i18n support and update documentation README
Copilot Jan 21, 2026
2ff4c75
docs: fix meta.json structure and build configuration for i18n
Copilot Jan 21, 2026
63707fa
docs: redesign home page with launcher showcase and fix routing
Copilot Jan 21, 2026
fa70f6f
Update packages/docs/content/docs/en/features/index.mdx
HsiangNianian Jan 22, 2026
6fdf5d2
Update packages/docs/content/docs/zh/troubleshooting.mdx
HsiangNianian Jan 22, 2026
d8e2571
Update packages/docs/content/docs/zh/troubleshooting.mdx
HsiangNianian Jan 22, 2026
d3b5ea2
Update packages/docs/content/docs/en/troubleshooting.mdx
HsiangNianian Jan 22, 2026
17f6e83
Update packages/docs/content/docs/en/troubleshooting.mdx
HsiangNianian Jan 22, 2026
ee8b60d
chore: Update favicon.ico in public directory
HsiangNianian Jan 22, 2026
a87268d
fix: update navigation title from 'React Router' to 'DropOut'
HsiangNianian Jan 22, 2026
c309904
feat(docs): enhance error boundary UI and add 404 page
NtskwK Jan 29, 2026
2f4f8a3
docs: fix relative links and image paths in documentation
NtskwK Jan 29, 2026
9627912
docs: remove emojis from documentation and home page
Copilot Jan 30, 2026
b27777b
feat(i18n): add multi-language support for docs
NtskwK Feb 3, 2026
ac7a7bc
docs: restructure documentation files
NtskwK Feb 3, 2026
f656803
docs: comprehensive documentation overhaul with i18n support (English…
HsiangNianian Feb 4, 2026
5bb2c66
docs: update language links and improve formatting in README files (#88)
NtskwK Feb 9, 2026
d249331
Refine Chinese getting-started docs game launch instruction (#90)
NtskwK Feb 10, 2026
e651760
Merge branch 'dev' into main
HsiangNianian Feb 10, 2026
ea138c1
Merge branch 'dev' into main
HsiangNianian Feb 10, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"MD013": false,
"MD033": false,
"MD041": false
}
1 change: 0 additions & 1 deletion CNAME

This file was deleted.

147 changes: 147 additions & 0 deletions README.CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
# Drop*O*ut

[English](README.md) | 中文

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut.svg?type=small)](https://app.fossa.com/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut?ref=badge_small)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/HsiangNianian/DropOut/main.svg)](https://results.pre-commit.ci/latest/github/HsiangNianian/DropOut/main)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![CodeQL Advanced](https://github.com/HydroRoll-Team/DropOut/actions/workflows/codeql.yml/badge.svg?branch=main)](https://github.com/HydroRoll-Team/DropOut/actions/workflows/codeql.yml)
[![Dependabot Updates](https://github.com/HydroRoll-Team/DropOut/actions/workflows/dependabot/dependabot-updates/badge.svg)](https://github.com/HydroRoll-Team/DropOut/actions/workflows/dependabot/dependabot-updates)
[![Semifold CI](https://github.com/HydroRoll-Team/DropOut/actions/workflows/semifold-ci.yaml/badge.svg)](https://github.com/HydroRoll-Team/DropOut/actions/workflows/release.yml)
[![Test & Build](https://github.com/HydroRoll-Team/DropOut/actions/workflows/test.yml/badge.svg)](https://github.com/HydroRoll-Team/DropOut/actions/workflows/test.yml)

DropOut 是一个现代的、可复现的、开发者级别的 Minecraft 启动器。
它不仅仅是为了启动 Minecraft 而设计的,而是将 Minecraft 环境作为确定性的、版本化的工作空间进行管理。

使用 Tauri v2 和 Rust 构建,DropOut 提供原生性能和最小资源使用,并配有现代响应式 Web UI(目前使用 Svelte 5,正在迁移到 React)。

> Minecraft 环境是一个复杂的系统。
> DropOut 将它们视为软件项目。

<div align="center">
<img width="700" src="assets/image.png" alt="DropOut Launcher Interface" />
</div>

## 为什么选择 DropOut?

大多数 Minecraft 启动器专注于让你进入游戏。
DropOut 专注于保持你的游戏稳定、可调试和可重现。

- 整合包昨天还能游玩,今天却坏了?
→ DropOut 让它可追溯。

- 分享模组包意味着压缩数 GB 的文件?
→ DropOut 分享精确的依赖清单。

- Java、加载器、模组、配置不同步?
→ DropOut 将它们锁定在一起。

这个启动器是为重视控制、透明度和长期稳定性的玩家构建的。

## 功能特性

- **高性能**:使用 Rust 和 Tauri 构建,实现最小资源使用和快速启动时间。
- **现代工业 UI**:使用 **Svelte 5** 和 **Tailwind CSS 4** 设计的干净、无干扰界面。
- **Microsoft 认证**:通过官方 Xbox Live 和 Microsoft OAuth 流程(设备代码流程)提供安全登录支持。
- **模组加载器支持**:
- **Fabric**:内置安装程序和版本管理。
- **Forge**:支持安装和启动 Forge 版本。
- **Java 管理**:
- 自动检测已安装的 Java 版本。
- 内置 Adoptium JDK/JRE 下载器。
- **GitHub 集成**:直接从启动器主页查看最新的项目更新和变更日志。
- **游戏管理**:
- 完整的版本隔离。
- 高效的并发资产和库下载。
- 可自定义的内存分配和分辨率设置。

## 路线图

- [X] **账户持久化** — 在会话之间保存登录状态
- [X] **令牌刷新** — 自动刷新过期的 Microsoft 令牌
- [X] **JVM 参数解析** — 完全支持 `arguments.jvm` 和 `arguments.game` 解析
- [X] **Java 自动检测和下载** — 扫描系统并下载 Java 运行时
- [X] **Fabric 加载器支持** — 使用 Fabric 安装和启动
- [X] **Forge 加载器支持** — 使用 Forge 安装和启动
- [X] **GitHub 发布集成** — 在应用内查看变更日志
- [ ] **实例/配置文件系统** — 多个隔离的游戏目录,具有不同的版本/模组
- [ ] **多账户支持** — 在多个账户之间无缝切换
- [ ] **自定义游戏目录** — 允许用户选择游戏文件位置
- [ ] **启动器自动更新** — 通过 Tauri 更新插件的自更新机制
- [ ] **模组管理器** — 直接在启动器中启用/禁用模组
- [ ] **从其他启动器导入** — MultiMC/Prism 配置的迁移工具

## 安装

从 [Releases](https://github.com/HsiangNianian/DropOut/releases) 页面下载适用于您平台的最新版本。
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion (typo): Slight grammatical adjustment: "您平台" → "您的平台".

可以改为:“从 [Releases] 页面下载适用于您的平台的最新版本。” 或更通用地写成“下载适用于各个平台的最新版本”。

Suggested change
[Releases](https://github.com/HsiangNianian/DropOut/releases) 页面下载适用于您平台的最新版本
[Releases](https://github.com/HsiangNianian/DropOut/releases) 页面下载适用于您的平台的最新版本


| 平台 | 文件 |
| -------------- | ----------------------- |
| Linux x86_64 | `.deb`, `.AppImage` |
| Linux ARM64 | `.deb`, `.AppImage` |
| macOS ARM64 | `.dmg` |
| Windows x86_64 | `.msi`, `.exe` |
| Windows ARM64 | `.msi`, `.exe` |

## 从源码构建

### 先决条件

1. **Rust**:从 [rustup.rs](https://rustup.rs/) 安装。
2. **Node.js** 和 **pnpm**:用于前端依赖。
3. **系统依赖**:按照您的操作系统遵循 [Tauri 先决条件](https://v2.tauri.app/start/prerequisites/)。

### 步骤

1. **克隆仓库**

```bash
git clone https://github.com/HsiangNianian/DropOut.git
cd DropOut
```

2. **安装前端依赖**

```bash
cd ui
Copy link

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

构建步骤里写的是 cd ui,但仓库实际前端目录是 packages/ui(同一仓库其他文档也使用 packages/ui)。建议修正文档以免新人按步骤执行时找不到目录。

Suggested change
cd ui
cd packages/ui

Copilot uses AI. Check for mistakes.
pnpm install
cd ..
```

3. **运行开发模式**

```bash
# 这将启动前端服务器和 Tauri 应用窗口
cargo tauri dev
```

4. **构建发布版本**

```bash
cargo tauri build
```

可执行文件将位于 `src-tauri/target/release/`。

## 贡献

DropOut 以长期可维护性为目标构建。
欢迎贡献,尤其在这些领域:

- 实例系统设计
- 模组兼容性工具
- UI/UX 改进
- 跨启动器迁移工具

标准的 GitHub 工作流程适用:
fork → 功能分支 → 拉取请求。

## 许可证

根据 MIT 许可证分发。有关更多信息,请参见 `LICENSE`。

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut?ref=badge_shield&issueType=license)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut.svg?type=shield&issueType=security)](https://app.fossa.com/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut?ref=badge_shield&issueType=security)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut?ref=badge_large)
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Drop*O*ut

English | [中文](README.CN.md)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut.svg?type=small)](https://app.fossa.com/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut?ref=badge_small)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/HsiangNianian/DropOut/main.svg)](https://results.pre-commit.ci/latest/github/HsiangNianian/DropOut/main)
Expand Down Expand Up @@ -56,6 +58,8 @@ This launcher is built for players who value control, transparency, and long-ter

## Roadmap

Check our full roadmap at: <https://roadmap.sh/r/minecraft-launcher-dev>

- [X] **Account Persistence** — Save login state between sessions
- [X] **Token Refresh** — Auto-refresh expired Microsoft tokens
- [X] **JVM Arguments Parsing** — Full support for `arguments.jvm` and `arguments.game` parsing
Expand Down Expand Up @@ -98,19 +102,22 @@ Download the latest release for your platform from the [Releases](https://github
git clone https://github.com/HsiangNianian/DropOut.git
cd DropOut
```

2. **Install Frontend Dependencies**

```bash
cd ui
pnpm install
cd ..
```

3. **Run in Development Mode**

```bash
# This will start the frontend server and the Tauri app window
cargo tauri dev
```

4. **Build Release Version**

```bash
Expand All @@ -123,6 +130,7 @@ Download the latest release for your platform from the [Releases](https://github

DropOut is built with long-term maintainability in mind.
Contributions are welcome, especially in these areas:

- Instance system design
- Mod compatibility tooling
- UI/UX improvements
Expand All @@ -131,12 +139,11 @@ Contributions are welcome, especially in these areas:
Standard GitHub workflow applies:
fork → feature branch → pull request.


## License

Distributed under the MIT License. See `LICENSE` for more information.

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut?ref=badge_shield&issueType=license)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut.svg?type=shield&issueType=security)](https://app.fossa.com/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut?ref=badge_shield&issueType=security)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2FHsiangNianian%2FDropOut?ref=badge_large)

Distributed under the MIT License. See `LICENSE` for more information.
7 changes: 7 additions & 0 deletions packages/docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.DS_Store
/node_modules/

# React Router
/.react-router/
/build/
.source
Loading
Loading