From 8a4133c9c517556cd16c2bbc1cd20bf4ee8f52f0 Mon Sep 17 00:00:00 2001 From: HsiangNianian Date: Sat, 28 Feb 2026 10:55:26 +0800 Subject: chore(docs): Update README file --- README.CN.md | 50 +++++++++++++++++++++++++------------------------- 1 file changed, 25 insertions(+), 25 deletions(-) (limited to 'README.CN.md') diff --git a/README.CN.md b/README.CN.md index 5017b66..a740055 100644 --- a/README.CN.md +++ b/README.CN.md @@ -14,7 +14,7 @@ DropOut 是一个现代的、可复现的、开发者级别的 Minecraft 启动器。 它不仅仅是为了启动 Minecraft 而设计的，而是将 Minecraft 环境作为确定性的、版本化的工作空间进行管理。 -DropOut 使用 Tauri v2 构建，DropOut 提供原生性能和最小资源使用，并配有现代响应式 Web UI（目前使用 Svelte 5，正在迁移到 React）。 +DropOut 使用 Tauri v2 构建，DropOut 提供原生性能和最小资源使用，并配有现代响应式 Web UI。 > Minecraft 环境是一个复杂的系统。 > DropOut 将它们视为软件项目。 @@ -29,20 +29,20 @@ DropOut 使用 Tauri v2 构建，DropOut 提供原生性能和最小资源使用 DropOut 专注于保持你的游戏稳定、可调试和可重现。 - 整合包昨天还能游玩，今天却坏了？ -→ DropOut 让它可追溯。 + → DropOut 让它可追溯。 - 分享模组包意味着压缩数 GB 的文件？ -→ DropOut 分享精确的依赖清单。 + → DropOut 分享精确的依赖清单。 - Java、加载器、模组、配置不同步？ -→ DropOut 将它们锁定在一起。 + → DropOut 将它们锁定在一起。 这个启动器是为重视控制、透明度和长期稳定性的玩家构建的。 ## 功能特性 - **高性能**：使用 Rust 和 Tauri 构建，实现最小资源使用和快速启动时间。 -- **现代工业 UI**：使用 **Svelte 5** 和 **Tailwind CSS 4** 设计的干净、无干扰界面。 +- **现代工业 UI**：使用 **React** 和 **Tailwind CSS 4** 设计的干净、无干扰界面。 - **Microsoft 认证**：通过官方 Xbox Live 和 Microsoft OAuth 流程（设备代码流程）提供安全登录支持。 - **模组加载器支持**： - **Fabric**：内置安装程序和版本管理。 @@ -58,14 +58,14 @@ DropOut 专注于保持你的游戏稳定、可调试和可重现。 ## 路线图 -- [X] **账户持久化** — 在会话之间保存登录状态 -- [X] **令牌刷新** — 自动刷新过期的 Microsoft 令牌 -- [X] **JVM 参数解析** — 完全支持 `arguments.jvm` 和 `arguments.game` 解析 -- [X] **Java 自动检测和下载** — 扫描系统并下载 Java 运行时 -- [X] **Fabric 加载器支持** — 使用 Fabric 安装和启动 -- [X] **Forge 加载器支持** — 使用 Forge 安装和启动 -- [X] **GitHub 发布集成** — 在应用内查看变更日志 -- [ ] **实例/配置文件系统** — 多个隔离的游戏目录，具有不同的版本/模组 +- [x] **账户持久化** — 在会话之间保存登录状态 +- [x] **令牌刷新** — 自动刷新过期的 Microsoft 令牌 +- [x] **JVM 参数解析** — 完全支持 `arguments.jvm` 和 `arguments.game` 解析 +- [x] **Java 自动检测和下载** — 扫描系统并下载 Java 运行时 +- [x] **Fabric 加载器支持** — 使用 Fabric 安装和启动 +- [x] **Forge 加载器支持** — 使用 Forge 安装和启动 +- [x] **GitHub 发布集成** — 在应用内查看变更日志 +- [ ] **[WIP]实例/配置文件系统** — 多个隔离的游戏目录，具有不同的版本/模组 - [ ] **多账户支持** — 在多个账户之间无缝切换 - [ ] **自定义游戏目录** — 允许用户选择游戏文件位置 - [ ] **启动器自动更新** — 通过 Tauri 更新插件的自更新机制 @@ -76,21 +76,21 @@ DropOut 专注于保持你的游戏稳定、可调试和可重现。 从 [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` | +| 平台 | 文件 | +| -------------- | ------------------- | +| 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. **Node.js** 和 **pnpm**：用于前端依赖。 +1. **系统依赖**：按照您的操作系统遵循 [Tauri 先决条件](https://v2.tauri.app/start/prerequisites/)。 ### 步骤 @@ -101,7 +101,7 @@ DropOut 专注于保持你的游戏稳定、可调试和可重现。 cd DropOut ``` -2. **安装前端依赖** +1. **安装前端依赖** ```bash cd ui @@ -109,14 +109,14 @@ DropOut 专注于保持你的游戏稳定、可调试和可重现。 cd .. ``` -3. **运行开发模式** +1. **运行开发模式** ```bash # 这将启动前端服务器和 Tauri 应用窗口 cargo tauri dev ``` -4. **构建发布版本** +1. **构建发布版本** ```bash cargo tauri build -- cgit v1.2.3-70-g09d2 From 8217588547bf5568dd959df87027c3e44b7397f3 Mon Sep 17 00:00:00 2001 From: Natsuu Date: Sat, 28 Feb 2026 19:58:23 +0800 Subject: chore: update describtion of front-end in readme (#113) ## Summary by Sourcery Update README documentation to reflect the current React-based frontend stack and simplify dependency installation steps. Documentation: - Update English and Chinese READMEs to describe the frontend as built with React 19, Shadcn UI, and Tailwind CSS 4 instead of Svelte 5. - Simplify setup instructions in both READMEs by generalizing the dependency installation step without changing into a separate UI directory. --- README.CN.md | 8 +++----- README.md | 8 +++----- 2 files changed, 6 insertions(+), 10 deletions(-) (limited to 'README.CN.md') diff --git a/README.CN.md b/README.CN.md index a740055..c6f64a0 100644 --- a/README.CN.md +++ b/README.CN.md @@ -14,7 +14,7 @@ DropOut 是一个现代的、可复现的、开发者级别的 Minecraft 启动器。 它不仅仅是为了启动 Minecraft 而设计的，而是将 Minecraft 环境作为确定性的、版本化的工作空间进行管理。 -DropOut 使用 Tauri v2 构建，DropOut 提供原生性能和最小资源使用，并配有现代响应式 Web UI。 +DropOut 使用 Tauri v2 构建，DropOut 提供原生性能和最小资源使用，并配有现代响应式 Web UI（基于 React 19、shadcn/ui 和 Tailwind CSS 4 构建）。 > Minecraft 环境是一个复杂的系统。 > DropOut 将它们视为软件项目。 @@ -42,7 +42,7 @@ DropOut 专注于保持你的游戏稳定、可调试和可重现。 ## 功能特性 - **高性能**：使用 Rust 和 Tauri 构建，实现最小资源使用和快速启动时间。 -- **现代工业 UI**：使用 **React** 和 **Tailwind CSS 4** 设计的干净、无干扰界面。 +- **现代工业 UI**：使用 **React 19**、**shadcn/ui** 和 **Tailwind CSS 4** 设计的干净、无干扰界面。 - **Microsoft 认证**：通过官方 Xbox Live 和 Microsoft OAuth 流程（设备代码流程）提供安全登录支持。 - **模组加载器支持**： - **Fabric**：内置安装程序和版本管理。 @@ -101,12 +101,10 @@ DropOut 专注于保持你的游戏稳定、可调试和可重现。 cd DropOut ``` -1. **安装前端依赖** +2. **安装依赖** ```bash - cd ui pnpm install - cd .. ``` 1. **运行开发模式** diff --git a/README.md b/README.md index 4a0172a..de4e26c 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ English | [中文](README.CN.md) DropOut is a modern, reproducible, and developer-grade Minecraft launcher. It is designed not just to launch Minecraft, but to manage Minecraft environments as deterministic, versioned workspaces. -Built with Tauri v2 and Rust, DropOut delivers native performance and minimal resource usage, paired with a modern reactive web UI. +Built with Tauri v2, DropOut delivers native performance and minimal resource usage, paired with a modern reactive web UI built with React 19, shadcn/ui, and Tailwind CSS 4. > Minecraft environments are complex systems. > DropOut treats them like software projects. @@ -42,7 +42,7 @@ This launcher is built for players who value control, transparency, and long-ter ## Features - **High Performance**: Built with Rust and Tauri for minimal resource usage and fast startup times. -- **Modern Industrial UI**: A clean, distraction-free interface designed with **React** and **Tailwind CSS 4**. +- **Modern Industrial UI**: A clean, distraction-free interface designed with **React 19**, **shadcn/ui**, and **Tailwind CSS 4**. - **Microsoft Authentication**: Secure login support via official Xbox Live & Microsoft OAuth flows (Device Code Flow). - **Mod Loader Support**: - **Fabric**: Built-in installer and version management. @@ -103,12 +103,10 @@ Download the latest release for your platform from the [Releases](https://github cd DropOut ``` -1. **Install Frontend Dependencies** +2. **Install Dependencies** ```bash - cd ui pnpm install - cd .. ``` 1. **Run in Development Mode** -- cgit v1.2.3-70-g09d2