chore: update readme
This commit is contained in:
parent
3dc62a060e
commit
3e63d7527e
64
README.md
64
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
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
## 🚀 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
|
||||
```
|
||||
|
BIN
assets/EZPPLauncher-preview.png
Normal file
BIN
assets/EZPPLauncher-preview.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 81 KiB |
Loading…
x
Reference in New Issue
Block a user