diff options
| author | 2026-01-13 19:53:38 +0800 | |
|---|---|---|
| committer | 2026-01-13 19:53:38 +0800 | |
| commit | 566ff57877e03d905547856063b00eb4d35977b3 (patch) | |
| tree | 10c871ce99fd6dc5babed966a615fefa927f8252 | |
| parent | ea2e121f1c13db073a53bfc342baf063f9eeba4c (diff) | |
| download | DropOut-566ff57877e03d905547856063b00eb4d35977b3.tar.gz DropOut-566ff57877e03d905547856063b00eb4d35977b3.zip | |
docs: update README to enhance project description and installation instructions
| -rw-r--r-- | README.md | 83 |
1 files changed, 54 insertions, 29 deletions
@@ -1,44 +1,69 @@ -# DropOut - NextGeneration Minecraft Launcher +# DropOut - Next Generation Minecraft Launcher -This is a new Minecraft launcher that is currently in development. It is designed to be a modern, fast and efficient launcher for Minecraft. It is written in Pure -Rust. +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. ## Features -- **Modern UI**: DropOut has a modern and clean UI that is easy to use. -- **Fast**: DropOut is designed to be fast and efficient. -- **Cross-Platform**: DropOut is designed to work on Windows, macOS and Linux. -- **Pure Rust**: DropOut is written in pure Rust. -- **Open Source**: DropOut is open source and contributions are welcome. -- **Customizable**: DropOut is highly customizable. -- **Secure**: DropOut is designed to be secure. -- **No Ads**: DropOut is free and open source, and will never have ads. -- **No Tracking**: DropOut does not track you. +- **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. +- **Game Management**: + - Version isolation and management + - Efficient asset and library downloading + - Custom Java arguments support -## Screenshots +## Installation -Not Yet. :{ +*(Pre-built binaries coming soon to the [Releases](https://github.com/HsiangNianian/DropOut/releases) page)* -## Installation +## Building from Source + +### Prerequisites + +1. **Rust**: Install from [rustup.rs](https://rustup.rs/). +2. **Node.js** & **pnpm**: Used for the frontend. +3. **System Dependencies**: Follow the [Tauri Prerequisites](https://v2.tauri.app/start/prerequisites/) for your OS. + +### Steps + +1. **Clone the repository** + + ```bash + git clone https://github.com/HsiangNianian/DropOut.git + cd DropOut + ``` +2. **Install Frontend Dependencies** + + ```bash + cd ui + pnpm install + cd .. + ``` +3. **Run in Development Mode** + + ```bash + # This will start the frontend server and the Tauri app window + cargo tauri dev + ``` +4. **Build Release Version** -You can download the latest version of DropOut from the [Releases](https://github.com/HsiangNianian/DropOut/releases) page. + ```bash + cargo tauri build + ``` -### Build from Source + The executable will be located in `src-tauri/target/release/`. -Prerequisites: -- [Rust](https://www.rust-lang.org/tools/install) -- [Tauri Prerequisites](https://v2.tauri.app/start/prerequisites/) +## Contributing -```bash -git clone https://github.com/HsiangNianian/DropOut -cd DropOut -# Install frontend dependencies (if any) -# npm install +Contributions are welcome! Please feel free to submit a Pull Request. -# Build the application -cargo tauri build -``` +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request ## License -DropOut is licensed under the [MIT License](LICENSE). +Distributed under the MIT License. See `LICENSE` for more information. |