|
1 | 1 | # LeviLauncher |
2 | 2 |
|
3 | | -A launcher specifically developed for Minecraft Bedrock Edition GDK version. |
| 3 | +[Language: English | 中文](./README.zh-CN.md) |
4 | 4 |
|
5 | | -## Project Status |
| 5 | +[](https://github.com/LiteLDev/LeviLauncher/releases) [](https://github.com/LiteLDev/LeviLauncher) [](https://github.com/LiteLDev/LeviLauncher/issues) [](https://github.com/LiteLDev/LeviLauncher) [](https://www.microsoft.com/windows) |
6 | 6 |
|
7 | | -🚧 **Under Development** - This project is currently in active development. Features are not yet complete and instability may occur. |
| 7 | +[](https://discord.gg/v5R5P4vRZk) [](https://qm.qq.com/q/1z791rJgJG) |
8 | 8 |
|
9 | | -## Issue Reporting |
| 9 | +A desktop launcher for Minecraft Bedrock Edition (GDK) on Windows. |
10 | 10 |
|
11 | | -If you encounter any problems or have suggestions for improvement, please report them by: |
| 11 | +Supports installing, managing, and launching Release/Preview builds. Provides version isolation, content management (worlds/resource packs/behavior packs/skin packs), mod management, and world backup tools. Frontend uses React + Vite + Tailwind; backend uses Go with Wails v3. |
12 | 12 |
|
13 | | -1. Visiting the project's [Issues page](https://github.com/LiteLDev/LeviLauncher/issues) |
14 | | -2. Clicking the "New Issue" button |
15 | | -3. Providing a detailed description of the problem or suggestion |
| 13 | +**Project Status** |
| 14 | +- 🚧 Actively under development; features may be incomplete and unstable. |
16 | 15 |
|
17 | | -### When submitting an issue, please provide: |
18 | | -- Operating system version |
19 | | -- Launcher version number |
20 | | -- Detailed description of the problem |
21 | | -- Steps to reproduce (if applicable) |
22 | | -- Error logs or screenshots (if available) |
| 16 | +**Scope** |
| 17 | +- Targets Minecraft GDK (Windows). Does not provide cracking or bypassing official checks. |
| 18 | + |
| 19 | +**Repository** |
| 20 | +- https://github.com/LiteLDev/LeviLauncher |
| 21 | + |
| 22 | +**Downloads** |
| 23 | +- GitHub Releases: https://github.com/LiteLDev/LeviLauncher/releases |
| 24 | +- Lanzou Cloud: https://levimc.lanzoue.com/b016ke39hc (Password: `levi`) |
| 25 | + |
| 26 | +**Issue Reporting** |
| 27 | +- Open issues at https://github.com/LiteLDev/LeviLauncher/issues |
| 28 | +- Include OS version, launcher version, repro steps, and logs/screenshots. |
| 29 | + |
| 30 | +**Features** |
| 31 | +- Version management: install, delete, rename, quick launch; supports Release and Preview. |
| 32 | +- Version isolation: redirect game data to `versions/<name>/Minecraft Bedrock (Preview)`, separate from AppData. |
| 33 | +- Content management: count and manage worlds/resource/behavior/skin packs; quick open and drag-and-drop import. |
| 34 | +- Mods: import `.zip`/`.dll`, enable/disable/delete; auto prepare dependencies and preloader. |
| 35 | +- World tools: backup to `.mcworld`, edit `level.dat` fields and world name. |
| 36 | +- Downloads & mirrors: built-in mirror latency test and selection; local installer import; progress view. |
| 37 | +- Shortcuts: create desktop shortcut for a version; custom icon support. |
| 38 | +- Updates: check, download, install updates; elevate when necessary. |
| 39 | +- Languages: English and Simplified Chinese. |
| 40 | + |
| 41 | +**Requirements** |
| 42 | +- OS: Windows 10/11. |
| 43 | +- Required components: Microsoft Gaming Services, Microsoft GameInput (guided on first run). |
| 44 | +- WebView2 Runtime: provided by installer or system. |
| 45 | + |
| 46 | +**Quick Start (Dev)** |
| 47 | +- Dependencies: |
| 48 | + - Go `1.24+` (see `go.mod`). |
| 49 | + - Node.js `18+` (for frontend). |
| 50 | + - Wails v3 CLI: `go install github.com/wailsapp/wails/v3/cmd/wails3@latest` |
| 51 | +- Dev mode: |
| 52 | + - From project root: `wails3 dev -config ./build/config.yml -port 1145` |
| 53 | + - Or run frontend separately: `cd frontend && npm install && npm run dev` |
| 54 | +- Build: |
| 55 | + - `wails3 task build` |
| 56 | + - Windows specific: `wails3 task windows:build` |
| 57 | +- Run: |
| 58 | + - `wails3 task run` |
| 59 | + |
| 60 | +**Packaging (Windows)** |
| 61 | +- NSIS installer: `wails3 task windows:package` (default `FORMAT=nsis`) |
| 62 | +- MSIX: |
| 63 | + - Tools: `wails3 task windows:install:msix:tools` |
| 64 | + - Build: `wails3 task windows:package FORMAT=msix` |
| 65 | + |
| 66 | +**Structure (Overview)** |
| 67 | +- `frontend/`: React + Vite app (`package.json`, `src/`, `assets/locales/`). |
| 68 | +- `internal/`: backend logic (versions, content, update, registry, etc.). |
| 69 | +- `build/`: cross-platform packaging and Taskfiles. |
| 70 | +- `main.go`: entry point; embeds frontend assets and creates the window. |
| 71 | + |
| 72 | +**CLI Args** |
| 73 | +- `--launch=<version_name>`: launch the specified version and exit. |
| 74 | +- `--self-update=<current_version>`: start elevated self-update when the install dir is not writable. |
| 75 | + |
| 76 | +**Community** |
| 77 | +- Discord: `https://discord.gg/v5R5P4vRZk` |
| 78 | +- QQ Group: `458083875` (`https://qm.qq.com/q/1z791rJgJG`) |
| 79 | + |
| 80 | +**FAQ** |
| 81 | +- Missing GameInput: install `GameInputRedist.msi` when prompted. |
| 82 | +- Missing Gaming Services: install via Microsoft Store. |
| 83 | +- Isolation & inherit: enable isolation during install; copy data from same-type isolated version or GDK directory. |
| 84 | +- Non-writable directory: change base content path in Settings or install/update with elevation. |
| 85 | +- Language switch: Settings supports English/zh-CN. |
| 86 | + |
| 87 | +**Contributing** |
| 88 | +- PRs and issues are welcome. |
| 89 | + |
| 90 | +**Acknowledgements** |
| 91 | +- Thanks to the community for support and contributions. |
0 commit comments