diff --git a/INSTALLATION.md b/INSTALLATION.md new file mode 100644 index 0000000..982a285 --- /dev/null +++ b/INSTALLATION.md @@ -0,0 +1,77 @@ +# Installing BepInEx and Reactor + +# Table of Contents +- [Locating the Among Us game files directory](#locating-the-among-us-game-files-directory) +- [Installing BepInEx](#installing-bepinex) +- [Installing Reactor](#installing-reactor) + +## Locating the Among Us game files directory + +On steam, this can be achieved by right clicking Among Us in the steam +library then selecting `Manage > Browse local files`. + +## Installing BepInEx + +1. Download the latest release from the NuclearPowered/BepInEx + [releases](https://github.com/NuclearPowered/BepInEx/releases) page. +2. Unzip the files into the Among Us game files directory. It should + look something like this after you add BepInEx: + +``` +. +├── Among Us_Data +├── Among Us.exe +├── BepInEx +│   ├── core/ +│   └── unity-libs/ +├── changelog.txt +├── doorstop_config.ini +├── GameAssembly.dll +├── mono +│   ├── Managed/ +│   └── MonoBleedingEdge/ +├── UnityCrashHandler32.exe +├── UnityPlayer.dll +└── winhttp.dll +``` + +3. Launch the game so that BepInEx can generate the necessary files, + then close the game after. The Among Us game files should now look + something like this: + +``` +. +├── Among Us_Data +├── Among Us.exe +├── BepInEx +│   ├── cache/ +│   ├── config/ +│   ├── core/ +│   ├── patchers/ +│   ├── plugins/ +│   ├── unhollowed/ +│   └── unity-libs/ +├── changelog.txt +├── doorstop_config.ini +├── GameAssembly.dll +├── mono +│   ├── Managed/ +│   └── MonoBleedingEdge/ +├── UnityCrashHandler32.exe +├── UnityPlayer.dll +└── winhttp.dll +``` + +## Installing Reactor + +1. Go to the + [Reactor CI](https://github.com/NuclearPowered/Reactor/actions) + page. +2. Click on the top workflow run. +3. Download the `Reactor.dll` artifact. +4. Move the `Reactor.dll` file to the + `(Among Us game files)/BepInEx/plugins` folder. +5. Launch the game. The top left of the game menu should look + something like this: + +![Mod text](images/ModText.jpg) \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..906521c --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Unify + +An Among Us mod to add extra regions to the regions menu. + +![Regions menu](images/RegionsMenu.jpg) + +# Table of Contents +- [Features](#features) +- [Installation](#installation) + +## Features + +The following regions have been added: +- [skeld.net](https://skeld.net/) +- localhost *(for playing on a server running on your computer)* + +## Installation + +> **⚠ WARNING** +> +> This mod requires you to have BepInEx and Reactor installed. You can install BepInEx and Reactor by following [this guide](INSTALLATION.md) or by following the steps on the +> following two pages: https://docs.reactor.gg/docs/basic/install_bepinex and https://docs.reactor.gg/docs/basic/install_reactor. + +1. Ensure that BepInEx and Reactor are installed (more information above). +2. Download the latest mod on the [releases](https://github.com/DaemonBeast/Unify/releases) page. +3. Move the mod to the `(Among Us game files)/BepInEx/plugins` folder. +4. Launch the game. \ No newline at end of file diff --git a/images/ModText.jpg b/images/ModText.jpg new file mode 100644 index 0000000..767fa1f Binary files /dev/null and b/images/ModText.jpg differ diff --git a/images/RegionsMenu.jpg b/images/RegionsMenu.jpg new file mode 100644 index 0000000..0d169bd Binary files /dev/null and b/images/RegionsMenu.jpg differ