Skip to content

Commit c06a841

Browse files
committed
docs: update README with latest features
1 parent 193de99 commit c06a841

File tree

2 files changed

+187
-15
lines changed

2 files changed

+187
-15
lines changed

README.md

Lines changed: 99 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,106 @@
1-
# LeviLauncher
1+
<p align="center">
2+
<img src="build/appicon.png" alt="LeviLauncher" width="96">
3+
</p>
4+
<h1 align="center">LeviLauncher</h1>
5+
<p align="center">Minecraft Bedrock Edition GDK Launcher for Windows</p>
26

3-
A launcher specifically developed for Minecraft Bedrock Edition GDK version.
7+
<p align="center">
8+
<a href="https://github.com/LiteLDev/LeviLauncher/releases"><img alt="GitHub Release" src="https://img.shields.io/github/v/release/LiteLDev/LeviLauncher?style=flat-square&color=blue"></a>
9+
<a href="https://github.com/LiteLDev/LeviLauncher"><img alt="License" src="https://img.shields.io/github/license/LiteLDev/LeviLauncher"></a>
10+
<a href="https://github.com/LiteLDev/LeviLauncher/issues"><img alt="Issues" src="https://img.shields.io/github/issues/LiteLDev/LeviLauncher?style=flat-square&color=red"></a>
11+
<a href="https://github.com/LiteLDev/LeviLauncher"><img alt="Stars" src="https://img.shields.io/github/stars/LiteLDev/LeviLauncher?style=flat-square&color=yellow"></a>
12+
<a href="https://www.microsoft.com/windows"><img alt="Windows 10/11" src="https://img.shields.io/badge/Windows-10%2F11-green?style=flat-square&logo=windows"></a>
13+
</p>
414

5-
## Project Status
15+
<p align="center">
16+
<a href="https://discord.gg/v5R5P4vRZk"><img alt="Discord" src="https://img.shields.io/discord/849252980430864384?style=for-the-badge&logo=discord"></a>
17+
<a href="https://qm.qq.com/q/1z791rJgJG"><img alt="QQ Group 458083875" src="https://img.shields.io/badge/458083875-red?style=for-the-badge&logo=qq"></a>
18+
</p>
619

7-
🚧 **Under Development** - This project is currently in active development. Features are not yet complete and instability may occur.
20+
<p align="center">
21+
<sup>🌐 Language: <b>English</b> • <a href="./README.zh-CN.md">中文</a></sup>
22+
</p>
823

9-
## Issue Reporting
24+
A desktop launcher for Minecraft Bedrock Edition (GDK) on Windows.
1025

11-
If you encounter any problems or have suggestions for improvement, please report them by:
26+
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.
1227

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
28+
**Project Status**
29+
- 🚧 Actively under development; features may be incomplete and unstable.
1630

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)
31+
**Scope**
32+
- Targets Minecraft GDK (Windows). Does not provide cracking or bypassing official checks.
33+
34+
**Repository**
35+
- https://github.com/LiteLDev/LeviLauncher
36+
37+
**Downloads**
38+
- GitHub Releases: https://github.com/LiteLDev/LeviLauncher/releases
39+
- Lanzou Cloud: https://levimc.lanzoue.com/b016ke39hc (Password: `levi`)
40+
41+
**Issue Reporting**
42+
- Open issues at https://github.com/LiteLDev/LeviLauncher/issues
43+
- Include OS version, launcher version, repro steps, and logs/screenshots.
44+
45+
**Features**
46+
- Version management: install, delete, rename, quick launch; supports Release and Preview.
47+
- Version isolation: redirect game data to `versions/<name>/Minecraft Bedrock (Preview)`, separate from AppData.
48+
- Content management: count and manage worlds/resource/behavior/skin packs; quick open and drag-and-drop import.
49+
- Mods: import `.zip`/`.dll`, enable/disable/delete; auto prepare dependencies and preloader.
50+
- World tools: backup to `.mcworld`, edit `level.dat` fields and world name.
51+
- Downloads & mirrors: built-in mirror latency test and selection; local installer import; progress view.
52+
- Shortcuts: create desktop shortcut for a version; custom icon support.
53+
- Updates: check, download, install updates; elevate when necessary.
54+
- Languages: English and Simplified Chinese.
55+
56+
**Requirements**
57+
- OS: Windows 10/11.
58+
- Required components: Microsoft Gaming Services, Microsoft GameInput (guided on first run).
59+
- WebView2 Runtime: provided by installer or system.
60+
61+
**Quick Start (Dev)**
62+
- Dependencies:
63+
- Go `1.24+` (see `go.mod`).
64+
- Node.js `18+` (for frontend).
65+
- Wails v3 CLI: `go install github.com/wailsapp/wails/v3/cmd/wails3@latest`
66+
- Dev mode:
67+
- From project root: `wails3 dev -config ./build/config.yml -port 1145`
68+
- Or run frontend separately: `cd frontend && npm install && npm run dev`
69+
- Build:
70+
- `wails3 task build`
71+
- Windows specific: `wails3 task windows:build`
72+
- Run:
73+
- `wails3 task run`
74+
75+
**Packaging (Windows)**
76+
- NSIS installer: `wails3 task windows:package` (default `FORMAT=nsis`)
77+
- MSIX:
78+
- Tools: `wails3 task windows:install:msix:tools`
79+
- Build: `wails3 task windows:package FORMAT=msix`
80+
81+
**Structure**
82+
- `frontend/`: React + Vite app (`package.json`, `src/`, `assets/locales/`).
83+
- `internal/`: backend logic (versions, content, update, registry, etc.).
84+
- `build/`: cross-platform packaging and Taskfiles.
85+
- `main.go`: entry point; embeds frontend assets and creates the window.
86+
87+
**CLI Args**
88+
- `--launch=<version_name>`: launch the specified version and exit.
89+
- `--self-update=<current_version>`: start elevated self-update when the install dir is not writable.
90+
91+
**Community**
92+
- Discord: `https://discord.gg/v5R5P4vRZk`
93+
- QQ Group: `458083875` (`https://qm.qq.com/q/1z791rJgJG`)
94+
95+
**FAQ**
96+
- Missing GameInput: install `GameInputRedist.msi` when prompted.
97+
- Missing Gaming Services: install via Microsoft Store.
98+
- Isolation & inherit: enable isolation during install; copy data from same-type isolated version or GDK directory.
99+
- Non-writable directory: change base content path in Settings or install/update with elevation.
100+
- Language switch: Settings supports English/zh-CN.
101+
102+
**Contributing**
103+
- PRs and issues are welcome.
104+
105+
**Acknowledgements**
106+
- Thanks to the community for support and contributions.

README.zh-CN.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
<p align="center">
2+
<img src="build/appicon.png" alt="LeviLauncher" width="96">
3+
</p>
4+
<h1 align="center">LeviLauncher</h1>
5+
<p align="center">Minecraft Bedrock Edition GDK 启动器(Windows)</p>
6+
7+
<p align="center">
8+
<a href="https://github.com/LiteLDev/LeviLauncher/releases"><img alt="GitHub Release" src="https://img.shields.io/github/v/release/LiteLDev/LeviLauncher?style=flat-square&color=blue"></a>
9+
<a href="https://github.com/LiteLDev/LeviLauncher"><img alt="License" src="https://img.shields.io/github/license/LiteLDev/LeviLauncher"></a>
10+
<a href="https://github.com/LiteLDev/LeviLauncher/issues"><img alt="Issues" src="https://img.shields.io/github/issues/LiteLDev/LeviLauncher?style=flat-square&color=red"></a>
11+
<a href="https://github.com/LiteLDev/LeviLauncher"><img alt="Stars" src="https://img.shields.io/github/stars/LiteLDev/LeviLauncher?style=flat-square&color=yellow"></a>
12+
<a href="https://www.microsoft.com/windows"><img alt="Windows 10/11" src="https://img.shields.io/badge/Windows-10%2F11-green?style=flat-square&logo=windows"></a>
13+
</p>
14+
15+
<p align="center">
16+
<a href="https://discord.gg/v5R5P4vRZk"><img alt="Discord" src="https://img.shields.io/discord/849252980430864384?style=for-the-badge&logo=discord"></a>
17+
<a href="https://qm.qq.com/q/1z791rJgJG"><img alt="QQ 群 458083875" src="https://img.shields.io/badge/458083875-red?style=for-the-badge&logo=qq"></a>
18+
</p>
19+
20+
<p align="center">
21+
<sup>🌐 语言: <a href="./README.md">English</a> • <b>中文</b></sup>
22+
</p>
23+
24+
一个专为 Minecraft Bedrock Edition GDK 版本打造的桌面启动器。
25+
26+
支持在 Windows 上安装、管理和启动正式版与预览版,提供版本隔离、内容管理(世界/资源包/行为包/皮肤包)、模组管理与世界备份等功能。前端基于 React + Vite + Tailwind,后端使用 Go 与 Wails v3。
27+
28+
## 项目状态
29+
- 🚧 仍在积极开发中,功能持续完善,可能存在不稳定情况。
30+
31+
## 问题反馈
32+
- 使用 GitHub Issues 提交问题或建议:https://github.com/LiteLDev/LeviLauncher/issues
33+
- 提交时请附带操作系统版本、启动器版本、复现步骤与日志/截图。
34+
35+
## 下载地址
36+
- GitHub Releases:https://github.com/LiteLDev/LeviLauncher/releases
37+
- 蓝奏云:https://levimc.lanzoue.com/b016ke39hc(密码:`levi`)
38+
39+
## 主要特性
40+
- 版本管理:安装、删除、重命名与快速启动,支持正式版与预览版。
41+
- 版本隔离:将游戏数据重定向到 `versions/<名称>/Minecraft Bedrock(Preview)`,避免与系统 AppData 混淆。
42+
- 内容管理:统计并管理世界、资源包、行为包、皮肤包,支持一键打开对应目录与拖拽导入。
43+
- 模组管理:导入 `.zip`/`.dll`,启用/禁用、删除模组,自动准备依赖与预加载器。
44+
- 世界工具:备份世界为 `.mcworld`,编辑 `level.dat` 字段与世界名称。
45+
- 下载与镜像:内置镜像测速与选择,支持本地安装包导入与安装进度展示。
46+
- 快捷方式:为指定版本创建桌面快捷方式,支持自定义图标。
47+
- 更新机制:检测新版、下载并安装更新,必要时请求管理员权限。
48+
- 多语言:内置英文与简体中文。
49+
50+
## 系统要求
51+
- 操作系统:Windows 10/11。
52+
- 必备组件:Microsoft Gaming Services、Microsoft GameInput(首次运行可引导安装)。
53+
- WebView2 Runtime:随安装包引导安装或由系统提供。
54+
55+
## 快速开始(开发者)
56+
- 安装依赖:
57+
- Go `1.24`(或更高,见 `go.mod`)。
58+
- Node.js `18+`(用于前端构建)。
59+
- 安装 Wails v3 CLI:`go install github.com/wailsapp/wails/v3/cmd/wails3@latest`
60+
- 开发模式:
61+
- 在项目根目录执行:`wails3 dev -config ./build/config.yml -port 1145`
62+
- 或分步启动前端:`cd frontend && npm install && npm run dev`
63+
- 构建:
64+
- `wails3 task build`(按当前平台构建)
65+
- Windows 专用:`wails3 task windows:build`
66+
- 运行:
67+
- `wails3 task run`
68+
69+
## 目录结构
70+
- `frontend/`:React + Vite 前端(`package.json``src/``assets/locales/`)。
71+
- `internal/`:后端逻辑(版本管理、内容处理、更新等)。
72+
- `build/`:跨平台打包配置与 Taskfile 集合。
73+
- `main.go`:应用入口,嵌入前端静态资源并创建窗体。
74+
75+
## 命令行参数
76+
- `--launch=<版本名称>`:启动指定版本并退出启动器。
77+
- `--self-update=<当前版本>`:以管理员权限启动更新流程(用于无写权限目录)。
78+
79+
## 常见问题
80+
- 启动提示缺少 GameInput:按照引导下载并安装 `GameInputRedist.msi` 后重试。
81+
- 提示缺少 Gaming Services:打开 Microsoft Store 安装后重试。
82+
- 版本隔离与继承:可在下载/安装时启用隔离,并从同类型隔离版本或 GDK 目录复制数据。
83+
- 目录不可写:在设置中变更内容根目录,或以管理员方式安装/更新。
84+
- 语言切换:设置页支持英文/简体中文切换。
85+
86+
## 参与贡献
87+
- 欢迎通过 Issue 与 Pull Request 参与贡献。
88+
- 在提交前请尽量复现问题并附带必要信息。

0 commit comments

Comments
 (0)