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.md | 56 ++++++++++++++++++++++++++++---------------------------- 1 file changed, 28 insertions(+), 28 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 6d0eac0..4a0172a 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 (currently Svelte 5, migrating to React). +Built with Tauri v2 and Rust, DropOut delivers native performance and minimal resource usage, paired with a modern reactive web UI. > Minecraft environments are complex systems. > DropOut treats them like software projects. @@ -28,21 +28,21 @@ Built with Tauri v2 and Rust, DropOut delivers native performance and minimal re Most Minecraft launchers focus on getting you into the game. DropOut focuses on keeping your game stable, debuggable, and reproducible. -- Your instance worked yesterday but broke today? -→ DropOut makes it traceable. +- Your instance worked yesterday but broke today?\ + → DropOut makes it traceable. -- Sharing a modpack means zipping gigabytes? -→ DropOut shares exact dependency manifests. +- Sharing a modpack means zipping gigabytes?\ + → DropOut shares exact dependency manifests. -- Java, loader, mods, configs drift out of sync? -→ DropOut locks them together. +- Java, loader, mods, configs drift out of sync?\ + → DropOut locks them together. This launcher is built for players who value control, transparency, and long-term stability. ## 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 **Svelte 5** and **Tailwind CSS 4**. +- **Modern Industrial UI**: A clean, distraction-free interface designed with **React** 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. @@ -60,14 +60,14 @@ This launcher is built for players who value control, transparency, and long-ter Check our full roadmap at: -- [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 -- [X] **Java Auto-detection & Download** — Scan system and download Java runtimes -- [X] **Fabric Loader Support** — Install and launch with Fabric -- [X] **Forge Loader Support** — Install and launch with Forge -- [X] **GitHub Releases Integration** — View changelogs in-app -- [ ] **Instance/Profile System** — Multiple isolated game directories with different versions/mods +- [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 +- [x] **Java Auto-detection & Download** — Scan system and download Java runtimes +- [x] **Fabric Loader Support** — Install and launch with Fabric +- [x] **Forge Loader Support** — Install and launch with Forge +- [x] **GitHub Releases Integration** — View changelogs in-app +- [ ] **[WIP]Instance/Profile System** — Multiple isolated game directories with different versions/mods - [ ] **Multi-account Support** — Switch between multiple accounts seamlessly - [ ] **Custom Game Directory** — Allow users to choose game files location - [ ] **Launcher Auto-updater** — Self-update mechanism via Tauri updater plugin @@ -78,21 +78,21 @@ Check our full roadmap at: Download the latest release for your platform from the [Releases](https://github.com/HsiangNianian/DropOut/releases) page. -| Platform | Files | -| -------------- | ----------------------- | -| Linux x86_64 | `.deb`, `.AppImage` | -| Linux ARM64 | `.deb`, `.AppImage` | -| macOS ARM64 | `.dmg` | -| Windows x86_64 | `.msi`, `.exe` | -| Windows ARM64 | `.msi`, `.exe` | +| Platform | Files | +| -------------- | ------------------- | +| Linux x86_64 | `.deb`, `.AppImage` | +| Linux ARM64 | `.deb`, `.AppImage` | +| macOS ARM64 | `.dmg` | +| Windows x86_64 | `.msi`, `.exe` | +| Windows ARM64 | `.msi`, `.exe` | ## Building from Source ### Prerequisites 1. **Rust**: Install from [rustup.rs](https://rustup.rs/). -2. **Node.js** & **pnpm**: Used for the frontend dependencies. -3. **System Dependencies**: Follow the [Tauri Prerequisites](https://v2.tauri.app/start/prerequisites/) for your OS. +1. **Node.js** & **pnpm**: Used for the frontend dependencies. +1. **System Dependencies**: Follow the [Tauri Prerequisites](https://v2.tauri.app/start/prerequisites/) for your OS. ### Steps @@ -103,7 +103,7 @@ Download the latest release for your platform from the [Releases](https://github cd DropOut ``` -2. **Install Frontend Dependencies** +1. **Install Frontend Dependencies** ```bash cd ui @@ -111,14 +111,14 @@ Download the latest release for your platform from the [Releases](https://github cd .. ``` -3. **Run in Development Mode** +1. **Run in Development Mode** ```bash # This will start the frontend server and the Tauri app window cargo tauri dev ``` -4. **Build Release Version** +1. **Build Release Version** ```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.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 From e356ab996ad3ef4ad5fb9c90d4a4b4e61ff3342d Mon Sep 17 00:00:00 2001 From: 简律纯 Date: Fri, 13 Mar 2026 17:16:37 +0800 Subject: chore(docs): Add Repology package availability badge to README (#120) Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- README.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index de4e26c..bd37c53 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,8 @@ English | [中文](README.CN.md) [![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 package status on Repology + 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. -- cgit v1.2.3-70-g09d2