mirror of
https://github.com/LCE-Hub/LCE-Emerald-Launcher.git
synced 2026-07-15 23:10:48 +00:00
docs: overhaul README
This commit is contained in:
journ3ym3n
102
README.md
102
README.md
@@ -1,81 +1,69 @@
|
||||
# Emerald Legacy Launcher
|
||||
|
||||
**The official community-driven hub for Legacy Console Edition (LCE) preservation.**
|
||||
|
||||
Emerald Legacy Launcher is the result of a collaboration between developers who shared a common goal: moving away from bloated Electron-based launchers to create the fastest, most faithful LCE experience. Now the core project of our organization, Emerald centralizes the effort to preserve the nostalgic console experience on modern hardware
|
||||
**A free and open-source Minecraft Legacy Console Edition launcher, built with Rust and Tauri.**
|
||||
|
||||
---
|
||||
|
||||
# Open Source & Collaborative
|
||||
|
||||
Emerald is an **Open Source** project. By unifying multiple launcher initiatives into this single repository, we ensure transparency, long-term preservation, and a faster development cycle. We welcome contributions from anyone passionate about the prime minecraft era !
|
||||
<p align="left">
|
||||
<a href="https://ko-fi.com/kayjann">
|
||||
<img src="https://img.shields.io/badge/ko--fi-Donate%20to%20the%20Project-grey?style=for-the-badge&logo=kofi&logoColor=white&labelColor=FF5E5B" alt="Donate to the Project">
|
||||
</a>
|
||||
<a href="https://discord.gg/ycYvGjWmhu">
|
||||
<img src="https://img.shields.io/badge/discord-Join%20the%20Community-grey?style=for-the-badge&logo=discord&logoColor=white&labelColor=5865F2" alt="Join the Community">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
## Performance Comparison
|
||||
|
||||
Emerald is built with **Rust** and **Tauri**, making it significantly faster and lighter than traditional launchers based on Electron.
|
||||
|
||||
| Feature | Emerald (Tauri/Rust) | Legacy Launcher (Electron) |
|
||||
| --- | --- | --- |
|
||||
| **RAM Usage** | **~15 MB** | ~200 MB |
|
||||
| **Install Size** | **Ultra Light** | Heavy |
|
||||
| **Background Impact** | **Near Zero** | Significant |
|
||||
> [!IMPORTANT]
|
||||
> **Emerald Legacy Launcher is currently in Alpha.**
|
||||
> Expect bugs, frequent updates, and features that are still being polished as we work toward a stable release.
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
* **Faithful Experience:** Authentic console-style optimized UI and original audios for total immersion.
|
||||
* **One-Click Installation:** Instant setup for **TU19** and **TU24** (more versions coming soon).
|
||||
* **Extreme Efficiency:** Built for performance, ensuring the launcher never interferes with your game.
|
||||
* **Customization:** Easily change your in-game username directly from the launcher.
|
||||
|
||||
## Roadmap (Upcoming Features)
|
||||
|
||||
Our team is working hard to make Emerald the definitive LCE tool.
|
||||
|
||||
* [ ] Linux and macOS support
|
||||
* [ ] Mod Manager & Faucet Integration
|
||||
* [ ] Save Game Backups
|
||||
* [ ] Custom Themes
|
||||
* [ ] Cross-platform Multiplayer
|
||||
* [ ] More downloadable instances
|
||||
* [ ] Skin manager
|
||||
|
||||
*(Note: These features are in active development by our team.)*
|
||||
### PROJECT OVERVIEW
|
||||
Emerald Legacy Launcher started as a solo project to create a better way to play Legacy Console Edition. Over time, other developers joined the effort, bringing expertise from various preservation projects into one place. By combining these efforts into a single unified launcher, we aim to build the best possible experience for Legacy Console Edition on PC.
|
||||
|
||||
---
|
||||
|
||||
## Installlation
|
||||
### CORE FEATURES
|
||||
|
||||
1. Download the latest `.msi` from the **[Releases](https://github.com/KayJannOnGit/Emerald-Legacy-Launcher/releases)** section.
|
||||
2. **Windows SmartScreen:** Since this is an independent community project, Windows may show a warning. Click **"More info"** then **"Run anyway"** to proceed.
|
||||
|
||||
## Support the Project
|
||||
|
||||
We are dedicated to making Emerald the best it can be. If you'd like to support our development team and LCE preservation, consider supporting us!
|
||||
|
||||
* **Ko-fi:** [Support the Team on Ko-fi](https://ko-fi.com/kayjann)
|
||||
* **Discord:** [Join the Emerald Community](https://discord.gg/nzbxB8Hxjh)
|
||||
<table width="100%" style="border-collapse: collapse;">
|
||||
<tr>
|
||||
<td style="padding: 20px; border: 1px solid #333;">
|
||||
<b>EASY SETUP</b><br>
|
||||
An automated installation process for TU19 and TU24, with more versions coming in future updates.
|
||||
</td>
|
||||
<td style="padding: 20px; border: 1px solid #333;">
|
||||
<b>RUST BACKEND</b><br>
|
||||
A memory-safe backend that handles all file operations and game execution with minimal overhead.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td style="padding: 20px; border: 1px solid #333;">
|
||||
<b>EASY CONFIGURATION</b><br>
|
||||
An integrated settings menu to change your username and manage game parameters directly through the launcher.
|
||||
</td>
|
||||
<td style="padding: 20px; border: 1px solid #333;">
|
||||
<b>TAURI FRONTEND</b><br>
|
||||
A lightweight frontend that handles the user interface and configuration management via webview.
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
---
|
||||
|
||||
## Credits & Acknowledgments
|
||||
|
||||
Emerald Legacy Launcher stands on the shoulders of giants!
|
||||
|
||||
* **The Emerald Team:** All the developers who brought their expertise to unify this project
|
||||
* **4J Studios & Mojang:** For creating the original Minecraft: Legacy Console Edition
|
||||
* **smartcmd & The LCE Community:** For the preservation of the **Nightly Builds** and providing the foundations for modern LCE play on PC
|
||||
* **Tauri & Rust Teams:** For the incredible engine that makes Emerald ultra-lightweight
|
||||
|
||||
Special thanks to all the preservationists keeping the LCE spirit alive!!!
|
||||
### [DEVELOPMENT ROADMAP](https://github.com/orgs/Emerald-Legacy-Launcher/projects/2)
|
||||
Click the heading above to track progress, view active tasks, and see upcoming launcher features.
|
||||
|
||||
---
|
||||
|
||||
*Proudly developed by a passionate team from the LCE community.*
|
||||
> ### ACKNOWLEDGMENTS
|
||||
> * <sub style="color: grey;">**The Emerald Team:** Technical development and maintenance.</sub>
|
||||
> * <sub style="color: grey;">**4J Studios & Mojang:** Original creators of Legacy Console Edition.</sub>
|
||||
> * <sub style="color: grey;">**smartcmd & The LCE Community:** Research and foundations for Legacy Console Edition on PC.</sub>
|
||||
> * <sub style="color: grey;">**Tauri & Rust:** Core technologies.</sub>
|
||||
|
||||
---
|
||||
|
||||
***This project is licensed under the GNU GPL v3 License - see the LICENSE file for details.***
|
||||
*Developed by The Emerald Team and the Legacy Console Edition Community.*
|
||||
|
||||
Reference in New Issue
Block a user