Merge pull request #29 from MoltenMods/2021

Tidied code, fixed bugs, and added IP and port under custom region names in regions menu

.idea/.idea.Unify/.idea/indexLayout.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project version="4">
-  <component name="ContentModelUserStore">
+  <component name="UserContentModel">
     <attachedFolders />
     <explicitIncludes />
     <explicitExcludes />

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)

README.md

@@ -0,0 +1,65 @@
+# Unify
+
+An Among Us mod to add extra regions to the regions menu.
+
+![Regions menu](images/RegionsMenu.png)
+
+# Table of Contents
+- [Features](#features)
+- [Installation](#installation)
+- [Configuration](#configuration)
+
+## Features
+
+The following regions have been added:
+- [skeld.net](https://skeld.net/)
+- localhost *(for playing on a server running on your computer)*
+- matux.fr
+
+Regions can be connected to directly using an IP address.
+
+Custom regions can be added as detailed below in the
+[configuration](#configuration) section.
+
+Other mods can add regions via the
+`AddRegion(string name, string ip, ushort port)` method.
+
+## Installation
+
+> **⚠ WARNING**
+>
+> This mod only has compiled releases for the steam release of the game.
+
+> If you are still using 2020.12.9s and Reactor fails to load, try using the Reactor version located
+> here: https://github.com/NuclearPowered/Reactor/actions/runs/593649307.
+
+> If you are still using 2021.3.5s and Reactor fails to load, try using the Reactor version located
+> here: https://github.com/NuclearPowered/Reactor/actions/runs/636023321.
+
+1. Ensure that BepInEx and Reactor (Reactor is not required for pre releases) are installed
+   ([installation guide](INSTALLATION.md)).
+2. Download the latest mod on the [releases](https://github.com/DaemonBeast/Unify/releases) page
+   for the version of Among Us you are using.
+3. Move the mod to the `(Among Us game files)/BepInEx/plugins` folder.
+4. Launch the game.
+
+## Configuration
+
+> **⚠ WARNING**
+>
+> The configuration file will be generated when loading the mod for
+> the first time. If the configuration file is not there, try
+> launching the game and closing it to see if the configuration
+> file creates itself.
+
+The configuration file is located at
+`(Among Us game files)/BepInEx/config/daemon.unify.cfg`.
+
+### Custom regions
+
+Custom regions can be added by modifying the `[Region 1]`,
+`[Region 2]` ... `[Region 9]` sections of the configuration file.
+You can modify the display name of the region,
+the IP address of the region and the port of the region.
+
+If the IP field is left empty, the region will not show up in game.

Unify/Patches/Regions.cs

@@ -1,31 +1,158 @@
 using System;
+using System.Collections.Generic;
+using BepInEx.Configuration;
 using HarmonyLib;
+using Reactor.Extensions;
+using UnityEngine;
+using UnityEngine.UI;
+using Object = UnityEngine.Object;
+using String = System.String;
 
 namespace Unify.Patches
 {
-    [HarmonyPatch]
     public static class RegionsPatch
     {
+        private static IRegionInfo[] _oldRegions { get; } = ServerManager.DefaultRegions;
+
+        private static IRegionInfo[] _newRegions { get; } = new IRegionInfo[]
+        {
+            new DnsRegionInfo("192.241.154.115", "skeld.net", StringNames.NoTranslation, "192.241.154.115", 22023)
+                .Cast<IRegionInfo>(),
+            new DnsRegionInfo("localhost", "localhost", StringNames.NoTranslation, "127.0.0.1", 22023)
+                .Cast<IRegionInfo>(),
+            new DnsRegionInfo("152.228.160.91", "matux.fr", StringNames.NoTranslation, "152.228.160.91", 22023)
+                .Cast<IRegionInfo>()
+        };
+
+        public static List<IRegionInfo> ModRegions { get; } = new List<IRegionInfo>();
+
+        public static IRegionInfo DirectRegion { get; set; }
+
+        private static TextBoxTMP DirectConnect { get; set; }
+
         public static void Patch()
         {
-            RegionInfo[] newRegions = new RegionInfo[]
-            {
-                new RegionInfo("skeld.net", "192.241.154.115", new ServerInfo[]
-                {
-                    new ServerInfo("skeld.net-Master-1", "192.241.154.115", 22023)
-                }),
-                new RegionInfo("localhost", "127.0.0.1", new ServerInfo[]
-                {
-                    new ServerInfo("localhost-Master-1", "127.0.0.1", 22023)
-                })
-            };
-            
-            RegionInfo[] oldRegions = ServerManager.DefaultRegions;
-            RegionInfo[] patchedRegions = new RegionInfo[oldRegions.Length + newRegions.Length];
-            Array.Copy(oldRegions, patchedRegions, oldRegions.Length);
-            Array.Copy(newRegions, 0, patchedRegions, oldRegions.Length, newRegions.Length);
+            ServerManager serverManager = ServerManager.Instance;
+
+            IRegionInfo[] patchedRegions = _oldRegions
+                .AddRangeToArray(_newRegions)
+                .AddRangeToArray(ModRegions.ToArray())
+                .AddRangeToArray(LoadCustomUserRegions());
+            if (DirectRegion != null) patchedRegions = patchedRegions.AddToArray(DirectRegion);
 
             ServerManager.DefaultRegions = patchedRegions;
+            serverManager.AvailableRegions = patchedRegions;
+        }
+
+        private static IRegionInfo[] LoadCustomUserRegions()
+        {
+            List<IRegionInfo> customRegions = new List<IRegionInfo>();
+
+            for (int x = 0; x < 9; x++)
+            {
+                ConfigEntry<string> regionName = UnifyPlugin.ConfigFile.Bind(
+                    $"Region {x + 1}", $"Name", "custom region");
+                ConfigEntry<string> regionIp = UnifyPlugin.ConfigFile.Bind(
+                    $"Region {x + 1}", "IP", "");
+                ConfigEntry<ushort> regionPort = UnifyPlugin.ConfigFile.Bind(
+                    $"Region {x + 1}", "Port", (ushort) 22023);
+
+                if (String.IsNullOrWhiteSpace(regionIp.Value)) continue;
+
+                IRegionInfo regionInfo = new DnsRegionInfo(
+                        regionIp.Value, $"{regionName.Value}\n{regionIp.Value}   {regionPort.Value}",
+                        StringNames.NoTranslation, regionIp.Value, regionPort.Value)
+                    .Cast<IRegionInfo>();
+
+                customRegions.Add(regionInfo);
+            }
+
+            return customRegions.ToArray();
+        }
+
+        private static void UpdateRegion()
+        {
+            RegionMenu regionMenu = DestroyableSingleton<RegionMenu>.Instance;
+
+            bool success = UnifyPlugin.SetDirectRegion(DirectConnect.text, out IRegionInfo newRegion);
+
+            if (!success)
+            {
+                DirectConnect.StartCoroutine(Effects.SwayX(DirectConnect.transform, 0.75f, 0.25f));
+                return;
+            }
+
+            regionMenu.ChooseOption(newRegion);
+            regionMenu.Close();
+        }
+
+        [HarmonyPatch(typeof(ServerManager), nameof(ServerManager.LoadServers))]
+        public static class LoadNewRegionsPatch
+        {
+            public static void Postfix()
+            {
+                Patch();
+            }
+        }
+
+        [HarmonyPatch(typeof(JoinGameButton), nameof(JoinGameButton.OnClick))]
+        public static class DirectConnectEnterButtonPatch {
+            public static bool Prefix(JoinGameButton __instance)
+            {
+                GameObject regionMenuGameObject = GameObject.Find("RegionMenu");
+                if (!regionMenuGameObject) return true;
+
+                UpdateRegion();
+
+                return false;
+            }
+        }
+
+        [HarmonyPatch(typeof(RegionMenu))]
+        public static class RegionMenuPatches
+        {
+            [HarmonyPatch(nameof(RegionMenu.Open))]
+            [HarmonyPostfix]
+            public static void DirectConnectButtonPatch(RegionMenu __instance)
+            {
+                if (DirectConnect) DirectConnect.gameObject.Destroy();
+
+                JoinGameButton joinGameButton = DestroyableSingleton<JoinGameButton>.Instance;
+
+                DirectConnect = Object.Instantiate(joinGameButton.GameIdText, __instance.transform);
+                DirectConnect.IpMode = true;
+                DirectConnect.characterLimit = 15;
+                DirectConnect.ClearOnFocus = false;
+
+                DirectConnect.OnEnter = new Button.ButtonClickedEvent();
+                DirectConnect.OnEnter.AddListener((Action) UpdateRegion);
+
+                int offset = _newRegions.Length + ModRegions.Count;
+                DirectConnect.transform.localPosition = new Vector3(0, 1f - (offset / 2f), -100f);
+            }
+
+            [HarmonyPatch(nameof(RegionMenu.Open))]
+            [HarmonyPostfix]
+            public static void RegionMenuLayoutPatch(RegionMenu __instance)
+            {
+                var regionButtons = __instance.ButtonPool.activeChildren.ToArray();
+
+                for (int i = 0; i < regionButtons.Length; i++)
+                {
+                    ServerListButton regionButton = regionButtons[i].Cast<ServerListButton>();
+
+                    bool isCustomRegion = i >= _oldRegions.Length;
+                    bool isCustomUserRegion = i >= _oldRegions.Length + _newRegions.Length + ModRegions.Count;
+                    float x = (isCustomRegion ? 3f : 0) + (isCustomUserRegion ? 3f : 0) - 4.25f;
+                    float y = i - (isCustomRegion ? _oldRegions.Length : 0) -
+                              (isCustomUserRegion ? _newRegions.Length + ModRegions.Count : 0);
+                    
+                    regionButton.transform.localPosition = new Vector3(1.25f + x, 2f - 0.5f * y, 0f);
+                }
+            }
         }
     }
-}
+}
+
+// TODO:
+//  Store custom servers in a JSON file

Unify/Unify.cs

@@ -1,6 +1,12 @@
-using BepInEx;
+using System;
+using System.IO;
+using System.Linq;
+using System.Text.RegularExpressions;
+using BepInEx;
+using BepInEx.Configuration;
 using BepInEx.IL2CPP;
 using HarmonyLib;
+using Hazel.Udp;
 using Reactor;
 using Unify.Patches;
 
@@ -9,19 +15,69 @@ namespace Unify
     [BepInPlugin(Id, Name, Version)]
     [BepInProcess("Among Us.exe")]
     [BepInDependency(ReactorPlugin.Id)]
+    [ReactorPluginSide(PluginSide.ClientOnly)]
     public class UnifyPlugin : BasePlugin
     {
-        public const string Id = "reactor.unify";
+        public const string Id = "daemon.unify";
         private const string Name = "Unify";
-        private const string Version = "0.1.0";
+        private const string Version = "4.1.0";
+
+        public static ConfigFile ConfigFile { get; private set; }
 
         public Harmony Harmony { get; } = new Harmony(Id);
 
         public override void Load()
         {
-            RegionsPatch.Patch();
-            
+            // ===== For compatibility reasons =====
+            string oldConfigPath = Path.Combine(Paths.ConfigPath, "daemon.unify.reactor.cfg");
+            string newConfigPath = Path.Combine(Paths.ConfigPath, $"{UnifyPlugin.Id}.cfg");
+            bool oldConfigExists = File.Exists(oldConfigPath);
+            if (oldConfigExists)
+            {
+                File.Copy(oldConfigPath, newConfigPath, true);
+                File.Delete(oldConfigPath);
+            }
+
+            ConfigFile = new ConfigFile(Path.Combine(Paths.ConfigPath, $"{UnifyPlugin.Id}.cfg"), true);
+            // =====================================
+
+            // Unpatches the modded handshake, because Impostor is STILL not fully updated yet
+            Harmony.Unpatch(typeof(UdpConnection).GetMethod("HandleSend"), HarmonyPatchType.Prefix, 
+                ReactorPlugin.Id);
+
             Harmony.PatchAll();
         }
+
+        public static IRegionInfo AddRegion(string name, string ip, ushort port)
+        {
+            if (Uri.CheckHostName(ip) != UriHostNameType.IPv4) return ServerManager.Instance.CurrentRegion;
+
+            IRegionInfo existingRegion =
+                ServerManager.DefaultRegions.ToArray().FirstOrDefault(region => region.PingServer == ip);
+            if (existingRegion != null) return existingRegion;
+            
+            IRegionInfo newRegion = new DnsRegionInfo(ip, $"{name}\n{ip}   {port}", StringNames.NoTranslation, ip, port)
+                .Cast<IRegionInfo>();
+            
+            RegionsPatch.ModRegions.Add(newRegion);
+            RegionsPatch.Patch();
+
+            return newRegion;
+        }
+
+        public static bool SetDirectRegion(string ip, out IRegionInfo newRegion)
+        {
+            newRegion = null;
+            
+            if (!Regex.IsMatch(ip, @"^(\d{1,3}\.){3}\d{1,3}$")) return false;
+            
+            newRegion = new DnsRegionInfo(ip, ip, StringNames.NoTranslation, ip, 22023)
+                .Cast<IRegionInfo>();
+
+            RegionsPatch.DirectRegion = newRegion;
+            RegionsPatch.Patch();
+
+            return true;
+        }
     }
 }

Unify/Unify.csproj

@@ -1,31 +1,38 @@
 <Project Sdk="Microsoft.NET.Sdk">
     <PropertyGroup>
         <TargetFramework>netstandard2.1</TargetFramework>
-        <Version>0.1.0</Version>
-        <Mappings>NuclearPowered/Mappings:0.1.2</Mappings>
+        <Version>4.1.0</Version>
+        <Mappings>NuclearPowered/Mappings:0.4.0</Mappings>
 
-        <Description>Region mod for Reactor</Description>
+        <Description>Region mod</Description>
         <Authors>Daemon</Authors>
     </PropertyGroup>
 
     <PropertyGroup Condition="'$(GamePlatform)' == 'Steam'">
-        <GameVersion>2020.12.9s</GameVersion>
+        <GameVersion>2021.4.12s</GameVersion>
         <DefineConstants>$(DefineConstants);STEAM</DefineConstants>
     </PropertyGroup>
-
+  
     <PropertyGroup Condition="'$(GamePlatform)' == 'Itch'">
-        <GameVersion>2020.11.17i</GameVersion>
+        <GameVersion>2021.4.12i</GameVersion>
         <DefineConstants>$(DefineConstants);ITCH</DefineConstants>
     </PropertyGroup>
-
+  
     <ItemGroup>
         <Deobfuscate Include="$(AmongUs)\BepInEx\plugins\Reactor-$(GameVersion).dll" />
-
-        <PackageReference Include="Reactor.OxygenFilter.MSBuild" Version="0.2.5" />
     </ItemGroup>
-
+  
+    <ItemGroup>
+        <PackageReference Include="Reactor.OxygenFilter.MSBuild" Version="0.3.0">
+            <PrivateAssets>all</PrivateAssets>
+            <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+        </PackageReference>
+    </ItemGroup>
+  
     <Target Name="Copy" AfterTargets="Reobfuscate">
         <Copy SourceFiles="$(OutputPath)reobfuscated/$(AssemblyName)-$(GameVersion).dll" DestinationFolder="$(AmongUs)/BepInEx/plugins/" />
         <Copy SourceFiles="$(OutputPath)reobfuscated/$(AssemblyName)-$(GameVersion).dll" DestinationFolder="../build/" />
+
+        <Copy SourceFiles="$(OutputPath)reobfuscated/$(AssemblyName)-$(GameVersion).dll" DestinationFolder="$(NewAmongUs)/" />
     </Target>
 </Project>