aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
author简律纯 <i@jyunko.cn>2026-01-15 17:49:26 +0800
committerGitHub <noreply@github.com>2026-01-15 17:49:26 +0800
commit32a9aceee42a2261b64f9e6effda522639576a5e (patch)
tree4cae8d216c3093421addaa0450bc8004c537e373 /README.md
parentce4b0c2053d5d16f7091d74840d4a502401f1a4e (diff)
parent31077dbd39a25eecd24a1dca0f8c9d1879265277 (diff)
downloadDropOut-32a9aceee42a2261b64f9e6effda522639576a5e.tar.gz
DropOut-32a9aceee42a2261b64f9e6effda522639576a5e.zip
Merge pull request #30 from HsiangNianian/main
Diffstat (limited to 'README.md')
-rw-r--r--README.md49
1 files changed, 23 insertions, 26 deletions
diff --git a/README.md b/README.md
index c64db3d..d702fe9 100644
--- a/README.md
+++ b/README.md
@@ -1,45 +1,42 @@
# DropOut
-DropOut is a modern, fast, and efficient Minecraft launcher built with the latest web and system technologies. It leverages **Tauri v2** to deliever a lightweight application with a robust **Rust** backend and a reactive **Svelte 5** frontend.
+DropOut is a modern, minimalist, and efficient Minecraft launcher built with the latest web and system technologies. It leverages **Tauri v2** to deliver a lightweight application with a robust **Rust** backend and a reactive **Svelte 5** frontend.
<div align="center">
- <img width="500" src="assets/image.jpg" />
+ <img width="700" src="assets/image.png" alt="DropOut Launcher Interface" />
</div>
## Features
-- **High Performance**: Built with Rust and Tauri for minimal resource usage.
-- **Microsoft Authentication**: Secure login support via official Xbox Live & Microsoft OAuth flows.
-- **Cross-Platform**: Native support for **Windows**, **Linux**, and **macOS**.
-- **Modern UI**: Clean and responsive interface built with Svelte 5 and Tailwind CSS 4.
+- **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**.
+- **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.
+ - **Forge**: Support for installing and launching Forge versions.
+- **Java Management**:
+ - Automatic detection of installed Java versions.
+ - Built-in downloader for Adoptium JDK/JRE.
+- **GitHub Integration**: View the latest project updates and changelogs directly from the launcher home screen.
- **Game Management**:
- - Version isolation and management
- - Efficient asset and library downloading
- - Custom Java arguments support.
-
-## Supported Platforms
-
-- [X] **Linux** `x86_64`
-- [X] **macOS** `ARM64 (Apple Silicon)`
-- [X] **Windows** `x86_64`
-- [X] **Windows** `ARM64`
+ - Complete version isolation.
+ - Efficient concurrent asset and library downloading.
+ - Customizable memory allocation and resolution settings.
## Roadmap
- [X] **Account Persistence** — Save login state between sessions
- [X] **Token Refresh** — Auto-refresh expired Microsoft tokens
-- [X] **JVM Arguments Parsing** — Parse `arguments.jvm` from version.json for Mac M1/ARM support
-- [X] **Java Auto-detection** — Scan common paths for Java installations
-- [ ] **Fabric Loader Support** — Install and launch with Fabric
-- [ ] **Forge Loader Support** — Install and launch with Forge
+- [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
-- [ ] **Version Filtering** — Filter by release/snapshot/old_beta in UI
-- [ ] **Multi-account Support** — Switch between multiple accounts
+- [ ] **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
-- [ ] **Mods Manager** — Enable/disable mods without deletion
-- [ ] **Resource Packs Manager** — Browse and manage resource packs
-- [ ] **Quilt Loader Support** — Install and launch with Quilt
+- [ ] **Mods Manager** — Enable/disable mods directly in the launcher
- [ ] **Import from Other Launchers** — Migration tool for MultiMC/Prism profiles
## Installation
@@ -59,7 +56,7 @@ Download the latest release for your platform from the [Releases](https://github
### Prerequisites
1. **Rust**: Install from [rustup.rs](https://rustup.rs/).
-2. **Node.js** & **pnpm**: Used for the frontend.
+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.
### Steps