From 73b7e330ea2573b28b3e6ff14faa232da15729f9 Mon Sep 17 00:00:00 2001 From: Kevin Nobel Date: Sun, 8 Jan 2023 14:30:20 +0100 Subject: [PATCH] Add project info and build instructions --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/README.md b/README.md index d7f06ed..be1d596 100644 --- a/README.md +++ b/README.md @@ -1 +1,36 @@ # BetaFix +BetaFix lets you enjoy Minecraft Beta 1.7.3 with working authentication, skins +and capes! BetaFix does not rely on a third party proxy, everything is fixed +client-side. + +The bigest drawback of methods that rely on third party proxies is that you as +a user do not have control over the proxy. With BetaFix you can verify and +build the mod yourself! + +## Ingame screenshot +![Ingame screenshot with working skin and cape.](https://sweetcraft.net/files/github-assets/betafix/ingame-screenshot.png) + +## Build instructions +To build the mod from scratch, simply run: +```shell +./build.sh +``` + +## Installation instructions +BetaFix can easily be installed in [MultiMC](https://multimc.org/#Download). + +Assuming you have created a clean Minecraft Beta 1.7.3 instance and build the +mod yourself or grabbed the ZIP-file from the latest release, follow these +instructions: +1. On the right-hand-side, click on `Edit Instance`. +2. On the right-hand-side, click on `Add to Minecraft.jar`. +3. Navigate to the `BetaFix.zip` file and open it. +4. BetaFix is now installed as a JAR-mod, the `Version` tab should look like +this: + +![MultiMC Version tab with BetaFix installed.](https://sweetcraft.net/files/github-assets/betafix/multimc-screenshot.png) + +## Acknowledgements +The creation of this fix was made very easy thanks to the +[RetroMCP-Java](https://github.com/MCPHackers/RetroMCP-Java) tool and +[wiki.vg](https://wiki.vg/Main_Page)!