update readme and divised them in mutliple files in a news directory names `docs` with two folder for localized versions, added nix flake and removed obseleted scripts
5.3 KiB
LCE Qt Launcher
Warning
This launcher is work in progress and its feature could be changes or remove at any time. PR are more than welcome to fix or add features. Just be compliant with the GPLv3 license and the Code of Respect
About
This is a custom Minecraft LCE Launcher written in Python and Qt with Freedom and with GNU/Linux support in mind.
Why LCE Qt Launcher ?
- Made in Python with Qt 6 : bloat free and integrate with GNU/Linux Plasma 6/Qt 6 Theme
- Customisation with Themes and laters modules/plugins
- Integration with Community Tools
- GNU/Linux first class support
- Licensed via copyleft licensing (GPLv3), so big tech free
- Free as Freedom Launcher
- Minecraft Themed by default
Features
- Command Line interface (CLI)
- Multiple Instances support (Work in progress)
- Pre-Configured ones :
- MCLCE/MinecraftConsoles (previously smartcmd/MinecraftConsoles)
- LegacyEvolved (will be removed soon as was replaced with NeoLegacy)
- NeoLegacy
- LCE-Revelations
- Pre-Configured ones :
- Marketplaces :
- in-app news
Long Term Goal / Roadmap
- Accessibility
- Modding Support
- Launcher Plugins
- Skin support
- GNU/Linux compatibility
- Windows support
- Experimental FreeBSD and Nix/NixOS support
- Localisations support
- Focus on being the main hub for Minecraft LCE on GNU/Linux
Compiling
Running/Debugging
How to get
Tag Release
In the GitHub Release page of this repo page you will found tagged Release like Beta 0.0.1.1. Right now it is just source code but next version , it will have installer and packages for Windows and Linux and instruction for FreeBSD Ports and Nix package.
Flatpak (Coming Soon)
Soon, they will be a flatpak repo with instruction here.
Nigthly Build
Note
This branch is not stable and changes are made almost daily so this branch can sometimes break. Also, MacOS is not avaiable in the Nigthly Build due to Apple restriction and that I do now own a mac.
In this GitHub Release page you will found Nighly Build which are made automatically via GitHub Action when change are made in the nightly branch
Via Git
You can also, downloading this repo with the command git clone https://github.com/xgui4/lce-qt-launcher.git and then compiling (see docs/en/COMPILING.md for more info how) anually or running in a .venv (see docs/en/RUNNING.md for more info how).
Software Requirement
- Python 3.11 (For FreeBSD) to Python 3.12 (GNU/Linux, Windows and MacOS)
- with a virtual env with the required library install (specified in the readme and
pyproject.toml)
- with a virtual env with the required library install (specified in the readme and
- PySide6
- Monocraft Font installed
- For UNIX like system
- A display server or compositor (Except on MacOS where it use its own proprietary one)
- Bash (normally pre-installed on Linux but often demand installation in *BSD and MacOS)
Python Library and Tools Used
- PySide 6
- platformdirs
- rich
- hatch
- uv
Compatible Operating System
Golden Support
Platform Tested Regurlaly and with completed implemation/patch
- Windows 10 and later
- GNU/Linux
Experimental Support
Plattform tested with work in progress implemation
- NixOS
- FreeBSD
Partly Supported Platform
Platform not tested yet, but with implementation
- Flatpak
Unsupported OS
These platform are not tested and may work or not at all
- Other *BSD system, as Minecraft LCE is not supported on those and Wine is not available.
- Minecraft LCE on Android is currently quite laggy and buggy
- macOS: LCE Qt Launcher does not officially support MacOS and is not tested during PRs, but POISX compatibility should allow its use.
Special Thank to
- Prism Launcher for certain UI elements and ui files
- MCLCE/MinecraftConsoles for the port of the game for PC
- pieeebot/neoLegacy for backporting updates for the PC port
- LCE Hub for the Marketplace/Workshop
- MinecraftLegacy Community to include my lancher in their list
- Miracode Font
- HellishEnds - now dcma, so it is removed/unaivable for now
- 360Revived - now dcma, so it is removed/unaivable for now

