diff --git a/README.md b/README.md index a68a70d..686753e 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,63 @@ -# EZPPLauncher Tauri +# EZPPLauncher -Trying to recode this shit with tauri, kms +**EZPPLauncher** is a custom launcher for the private osu! server [EZPPFarm](https://ez-pp.farm), built with **Rust** and **Svelte** using the [Tauri](https://tauri.app) framework. +It enhances the osu! experience with quality-of-life features and integration specifically designed for the EZPPFarm community. + +--- + +## 🖼️ Preview + +![EZPPLauncher Preview](./assets/EZPPLauncher-preview.png) + +--- + +## 🚀 Features + +- [x] Automatically updates osu! before launching +- [x] Automatic ingame login +- [x] Patches the osu! client to show misses in Relax and Autopilot +- [x] Displays your EZPPFarm stats in the launcher +- [x] Shows the number of imported beatmapsets +- [x] Shows the number of imported skins +- [x] Displays ping to the EZPPFarm server +- [ ] Discord Rich Presence (planned and in development) + +--- + +## 🛠 Build From Source + +### Requirements + +- **Rust** (installed via [rustup](https://rustup.rs/) – recommended for Windows) +- **Cargo** (comes with rustup) +- **[Bun](https://bun.sh/)** (JavaScript runtime) + +### Steps + +```bash +# Install all dependencies +bun i + +# Build the project +bun run build +``` + +After building, the launcher executable will be located at: + +``` +src-tauri/target/release/ezpplauncher.exe +``` + +--- + +## 📁 Project Structure (Simplified) + +``` +├── src/ # Frontend (Svelte) +├── src-tauri/ # Backend (Rust) +│ ├── tauri.conf.json # Tauri configuration +├── assets/ # Static assets (screenshots, icons, etc.) +│ └── screenshot.png +├── package.json # Bun project config +└── README.md +``` diff --git a/assets/EZPPLauncher-preview.png b/assets/EZPPLauncher-preview.png new file mode 100644 index 0000000..c61d920 Binary files /dev/null and b/assets/EZPPLauncher-preview.png differ