UltimMC: Improve README

This commit is contained in:
Neptune
2024-03-07 19:18:59 -05:00
committed by GitHub
parent 82df3ac9ac
commit 17a06d8eab

View File

@@ -1,40 +1,53 @@
# UltimMC
<p align="center">
## This is a "cracked" version of a popular Minecraft launcher that lets you play the game without a Microsoft account
<img width="150" src="https://github.com/UltimMC/Launcher/assets/62727185/48d60c15-23ae-4d48-84b8-813f72db6cdd">
## This software is not related to MultiMC developers and provided without any warranty. Please don't bomb MultiMC developers if something gets wrong using this launcher
<p align="center">UltimMC is a custom launcher for Minecraft which allows you to manage multiple instances and use offline ("cracked") accounts while keeping as close as possible to the original.</p>
## Pre-built binaries
</p>
- Windows / Linux / MacOS: <https://nightly.link/UltimMC/Launcher/workflows/main/develop>
> [!IMPORTANT]
> This project is a **fork** of MultiMC. </br> </br>
> This software is provided without any warranty, so please don't contact the main
> MultiMC developers in case anything goes wrong using this launcher. </br> </br>
> Nonetheless, feel free to create an issue within this repository
> in case you face an issue specific to UltimMC.
*Windows:* Download [mmc-cracked-win32](https://nightly.link/UltimMC/Launcher/workflows/main/develop/mmc-cracked-win32.zip).
## Downloading
*Linux:* Download [mmc-cracked-lin64](https://nightly.link/UltimMC/Launcher/workflows/main/develop/mmc-cracked-lin64.zip).
- All the available downloads can be found [here](https://nightly.link/UltimMC/Launcher/workflows/main/develop). These builds are directly taken from our [GitHub Actions](https://github.com/UltimMC/Launcher/actions).
*macOS (10.14 and newer):* Download [mmc-cracked-osx64](https://nightly.link/UltimMC/Launcher/workflows/main/develop/mmc-cracked-osx64.zip).
Direct downloads for specific platforms can be found below.
In the case you're using macOS then another additional step is to make `UltimMC` an executable by running the command `chmod +x UltimMC.app/Contents/MacOS/UltimMC` in the terminal.
- *[Windows \(32-bit and 64-bit\)](https://nightly.link/UltimMC/Launcher/workflows/main/develop/mmc-cracked-win32.zip)*.
- *[Linux (64-bit)](https://nightly.link/UltimMC/Launcher/workflows/main/develop/mmc-cracked-lin64.zip)*.
- *[macOS (10.14 and newer)](https://nightly.link/UltimMC/Launcher/workflows/main/develop/mmc-cracked-osx64.zip)*.
> [!NOTE]
> In the case you're using macOS then another additional step you might need to do
> is to make `UltimMC` an executable by running the command `chmod +x UltimMC.app/Contents/MacOS/UltimMC` in the terminal.
There's additionally a [.deb package](https://nightly.link/UltimMC/ultimmc-deb/workflows/ci/master/UltimMC.zip) for Debian/Ubuntu distributions.
And an AUR package as [ultimmc-bin](https://aur.archlinux.org/packages/ultimmc-bin).
And an AUR package as [ultimmc-bin](https://aur.archlinux.org/packages/ultimmc-bin). [![ultimmc-bin](https://img.shields.io/badge/ultimmc--bin-1793D1?logo=archlinux&logoColor=white&label=AUR)](https://aur.archlinux.org/packages/ultimmc-bin)
## Installing and Using
1. Pick the correct download for your system.
2. Uncompress it in your desired directory.
3. Launch `UltimMC`.
4. Go to account settings.
6. A. Pick "Add Local" and you will be requested to use the username you desire, this can be anything.
7. B. Pick "Add Premium" and add your Ely.by account by putting your email and password.
8. Save it.
9. Now enjoy the Launcher.
To remove "localhost:nnnn" or "Ely.by" from the Minecraft main menu and F3, add `-Dauthlibinjector.noShowServerName` to the Java arguments in the UltimMC settings.
## Updating
To update the launcher replace all replaceable files and folders with the newer ones from any of the links listed above.
A better update system is in the works.
## How to install and use
1. Download pre-built binaries for your system.
2. Unpack them in your desired directory.
3. Launch `UltimMC`.
4. Go to account settings.
5. A. Pick "Add Local" and you will be requested to use the username you desire, this can be anything.
5. B. Pick "Add Premium" and add your Ely.by account by putting your email and password.
6. Save it.
7. Now enjoy the Launcher.
To remove "localhost:nnnn" or "Ely.by" from the Minecraft main menu and F3, add `-Dauthlibinjector.noShowServerName` to the Java arguments in the UltimMC settings.