diff --git a/README.md b/README.md index 2c684be..654a9ae 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,23 @@ # UnionPatcher -A tool for LittleBigPlanet that patches the server urls to a custom url. +A commandline tool that will take the official EBOOT of a LittleBIGPlanet title and replace the server URLs with the ones specified -# Downloading -You can download UnionPatcher by going [here](https://github.com/LBPUnion/UnionPatcher/actions), clicking the top link, and choosing a download for your platform at the bottom. -Mac will have to be self-compiled for now, but it does work. +## Prerequisites +* For running the console application, you will need the [.NET 6 Runtime](https://dotnet.microsoft.com/en-us/download/dotnet/6.0/runtime?utm_source=getdotnetcore&utm_medium=referral) +* You will need to know the server URL you wish to use +* Basic commandline knowledge + +## Getting the latest build +Access the [CI builds for UnionPatcher](https://github.com/LBPUnion/UnionPatcher/actions), then, in the "workflow runs" grid, select the first in the list with a green check mark (✔️). Scroll to the bottom of this build and find the correct zip for your platform + +## Building manually (Required for MacOS) +You will need the [.NET 6 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) + +```bash +git clone https://github.com/LBPUnion/UnionPatcher +cd UnionPatcher +dotnet build UnionPatcher.sln +#Running +cd UnionPatcher/bin/Debug/net6.0/ +./LBPUnion.UnionPatcher +```