From a3ef27f83c57270e66fbe8f1015923671617b243 Mon Sep 17 00:00:00 2001 From: CommitMastery Date: Tue, 10 Mar 2026 20:25:37 -0400 Subject: [PATCH] docs: overhaul README --- README.md | 220 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 150 insertions(+), 70 deletions(-) diff --git a/README.md b/README.md index fe514ad..68ea29f 100644 --- a/README.md +++ b/README.md @@ -1,107 +1,185 @@ +
+ # LegacyLauncher A custom launcher for Minecraft Legacy Console Edition. -image - + + + + +
+ LegacyLauncher Interface +
+ The interface of Legacy Launcher v3.0.1 +
## Features -- **Minecraft-style GUI**: Authentic pixelated interface with Minecraft font and styling -- **Automatic Updates**: Fetches latest releases from GitHub repositories -- **Cross-platform Support**: Works on Windows and Linux -- **Profiles**: Save your username and track playtime -- **Custom Launch Options**: Configure IP, port, and server mode + + + + + + + + + +
+ 🔄 Automatic Updates
+

Fetches and installs the latest releases directly from GitHub repositories.

+ 		+ 💻 Multi-Platform Support
+

Compatible with Windows 10 64-bit+, Linux, and macOS Big Sur+.

+
+ 👤 Profile Management
+

Persistent storage for usernames and automated playtime tracking.

+ 		+ ⚙️ Advanced Launch
+

Control over connection parameters, IPs, ports, and headless server mode.

+
-## Installation +
-### From Source -1. Clone or download this repository -2. Install dependencies: - ```bash - npm install - ``` -3. Run the launcher: - ```bash - npm start - ``` +--- +## Getting Started -## Building + + + + + +
+ 🚀 Standard Download
+

+ Visit the Latest Releases page and download the appropriate package for your system: +

+
    +
  • Windows 10 64-bit+: LegacyLauncher.Setup.(version).exe
    • +
  • Linux: LegacyLauncher-(version).AppImage
    • +
  • macOS Big Sur+: LegacyLauncher-(version)-arm64.dmg
    • +
+ 		+ 🛠️ Development & Contribution
+

+ To build from source or contribute to the project, ensure you have Node.js installed and follow these steps: +

+
    +
  1. Clone the repository
    2. +
  2. Run npm install
    3. +
  3. Run npm start to test
    4. +
+
-### Linux AppImage -```bash -npm run dist -``` +### Compiling Executables -### Windows Installer -```bash -npm run dist:win -``` +If you wish to package the launcher yourself, use the following commands based on your target platform: -## Configuration +| Platform | Command | Output Format | +| :---: | :---: | :---: | +| **Windows 10 64-bit+** | `npm run dist:win` | `.exe` Setup | +| **Linux** | `npm run dist` | `.AppImage` Binary | +| **macOS Big Sur+** | `npm run dist:mac` | `.dmg` Disk Image | -### Repository Source -By default, the launcher fetches releases from `smartcmd/MinecraftConsoles`. You can change this in the Options menu. +
-### Launch Options -- **GitHub Repository**: Source repository for game releases -- **Client Executable**: Name of the executable file (default: `Minecraft.Client.exe`) -- **Compatibility Layer**: For Linux users - choose between direct execution, Wine, or Proton -- **Connect/Bind IP**: Optional IP address for multiplayer -- **Port**: Optional port number -- **Server Mode**: Launch as headless server +--- -### Profile Settings -- **Username**: Your in-game player name -- **Playtime Tracking**: Automatically tracks total playtime +## Launcher Options + +

Customize your experience via the Options menu within the launcher.

+ +| Setting | Description | +| :--- | :--- | +| **Installation Directory** | The local path where game files are stored | +| **GitHub Repository Source** | The repository used to fetch game updates | +| **Client Executable Name** | The specific filename the launcher attempts to execute | +| **Launcher Music Volume** | Adjust the background audio level of the launcher | +| **Connect/Bind IP** | Specify a custom IP address for network connections | +| **Port** | Define the network port for multiplayer sessions | +| **Launch as Headless Server (-server)** | Launch the client without a GUI for server hosting | +| **Use Classic Minecraft Launcher UI** | Replaces the modern GUI with a layout inspired by the 2013 launcher | + +
+ +--- ## System Requirements -- **Windows**: Direct execution of Windows executables -- **Linux**: Wine or Proton for running Windows executables -- **Internet**: Required for downloading game updates + + + + + + +
+ Windows
+ Windows 10 64-bit or Windows 11 + 		+ Linux
+ Wine is required to run Windows binaries + 		+ macOS
+ macOS Big Sur or newer (Apple Silicon) +
-## Compatibility Layers (Linux) +### Linux Setup +The `.AppImage` is designed to work across all distributions. To run Windows binaries, you must install the **Wine** compatibility layer using your package manager: -The launcher supports several compatibility options for Linux: +| Distribution | Command | +| :--- | :--- | +| **Ubuntu / Debian / Mint** | `sudo apt install wine` | +| **Fedora** | `sudo dnf install wine` | +| **Arch / Manjaro** | `sudo pacman -S wine` | +| **openSUSE** | `sudo zypper install wine` | -- **Direct**: Run native Linux executables (if available) -- **Wine**: Wine compatibility layer -- **Proton**: Steam's Proton compatibility layer +
-## Dependencies +--- -- **Electron**: Cross-platform desktop app framework -- **discord-rpc**: Discord Rich Presence integration -- **extract-zip**: ZIP archive extraction -- **Tailwind CSS**: UI styling (via CDN) +## Technical Stack -## Development +**Built With:** +`Electron` • `Node.js` • `Tailwind CSS` • `Discord RPC` -The launcher is built with: -- **Frontend**: HTML, CSS, JavaScript -- **Backend**: Electron with Node.js -- **Styling**: Custom CSS with Minecraft theme + Tailwind CSS -- **Build**: Electron Builder +**Development Components:** +`HTML5` • `CSS3` • `JavaScript` • `Electron Builder` + +
+ +--- ## Troubleshooting -### Common Issues + + + + + +
+ Common Solutions: +
    +
  • Repository Error: Verify the name in Options
    • +
  • Executable Error: Check if filename matches download
    • +
  • Launch Failure: Verify Wine is installed on your system
    • +
  • Discord Error: Ensure Discord is open with RPC enabled
    • +
+ 		+ Linux Specifics: +
    +
  • Wine Check: Run wine --version to verify install
    • +
  • AppImage Permissions: chmod +x LegacyLauncher-*.AppImage
    • +
+
-1. **Repository not found**: Check the repository name in Options -2. **Executable not found**: Verify the executable name matches the downloaded file -3. **Launch failures**: Try different compatibility layers on Linux -4. **Discord RPC issues**: Ensure Discord is running and RPC is enabled - -### Linux Specific -- Install Wine: `sudo apt install wine` (Ubuntu/Debian) -- For Proton: Requires Steam installation -- AppImage permissions: `chmod +x LegacyLauncher-*.AppImage` +
## Contributing -Feel free to submit issues and pull requests for improvements. +Feel free to submit **Issues** and **Pull Requests** to help improve the launcher! + +
## Star History @@ -112,3 +190,5 @@ Feel free to submit issues and pull requests for improvements. Star History Chart + +