From 18c559847ce46855e69c19a652a5f789e31e32a4 Mon Sep 17 00:00:00 2001 From: beerpsi Date: Sat, 1 Jun 2024 07:41:41 +0000 Subject: [PATCH] Add warning for MelonLoader --- README.md | 150 +++++++++++++++++++++++++++++------------------------- 1 file changed, 81 insertions(+), 69 deletions(-) diff --git a/README.md b/README.md index 6a3c2a5..3b0bf43 100644 --- a/README.md +++ b/README.md @@ -1,69 +1,81 @@ -# Rizu -A Tachi score hook for maimai DX. - -Tested versions: -- BUDDiES - -## Installation -First, get the [config file](https://kamai.tachi.ac/client-file-flow/CIaa7b4d91041688189231cfc696c0754120b1790b) and -place it in the same folder as the game executable (Sinmai.exe), then follow **only** one of three methods: -- [BepInEx (fast)](#bepinex-fast) -- [BepInEx](#bepinex) -- [Hard-patching using MonoMod](#hard-patching-using-monomod) - -### BepInEx (fast) -- Update [segatools](https://gitea.tendokyu.moe/Dniel97/segatools/releases/latest). -- Download [Rizu-BepInEx-v0.1.2.zip](https://gitea.tendokyu.moe/beerpsi/Rizu/releases/download/v0.1.2/Rizu-BepInEx-v0.1.2.zip). -- Extract the zip into the base game folder (containing `Sinmai.exe`). -- Edit `segatools.ini`, adding this entry: -```ini -[unity] -targetAssembly=BepInEx\core\BepInEx.Preloader.dll -``` - -### BepInEx -#### Installing BepInEx -- Update [segatools](https://gitea.tendokyu.moe/Dniel97/segatools/releases/latest). -- Download [BepInEx 5](https://github.com/BepInEx/BepInEx/releases/tag/v5.4.23.1). -- Extract the `BepInEx` folder from the archive into the base game folder, ignoring other files. -- Edit `segatools.ini`, adding this entry: -```ini -[unity] -targetAssembly=BepInEx\core\BepInEx.Preloader.dll -``` - -#### Installing the score hook -- Download [Rizu-v0.1.2.zip](https://gitea.tendokyu.moe/beerpsi/Rizu/releases/download/v0.1.2/Rizu-v0.1.2.zip). -- Extract it into the base game folder. - -In the end, your game directory should look like this: -``` -└───BepInEx - └───plugins - └───Rizu - ├───Rizu.dll - └───Rizu.Core.dll -├───Sinmai_Data -├───Rizu.cfg -├───Sinmai.exe -└───segatools.ini -``` - -### Hard-patching using MonoMod -- Download [MonoMod](https://github.com/MonoMod/MonoMod/releases/latest). -- Download `Assembly-CSharp.Rizu.mm.dll` from [releases](https://gitea.tendokyu.moe/beerpsi/Rizu/releases/latest) -and place it in `Sinmai_Data/Managed`. -- Run `MonoMod.exe path\to\Sinmai_Data\Managed\Assembly-CSharp.dll` in a command prompt. -- Rename `MONOMODDED_Assembly-CSharp.dll` to `Assembly-CSharp.dll`, optionally backing up the original file. - -## Development -Copy these files from `Sinmai_Data/Managed` into `External`: -- `Assembly-CSharp.dll` -- `UnityEngine.dll` -- `UnityEngine.CoreModule.dll` -- `UnityEngine.JSONSerializeModule.dll` -- `UnityEngine.UnityWebRequestModule.dll` - -You will also need to download [MonoMod](https://github.com/MonoMod/MonoMod/releases/latest). and extract to `External`. - -After that, the project can be restored and built normally. +# Rizu +A Tachi score hook for maimai DX. + +Tested versions: +- BUDDiES + +## Installation +First, get the [config file](https://kamai.tachi.ac/client-file-flow/CIaa7b4d91041688189231cfc696c0754120b1790b) and +place it in the same folder as the game executable (Sinmai.exe), then follow **only** one of three methods: +- [BepInEx (fast)](#bepinex-fast) +- [BepInEx](#bepinex) +- [Hard-patching using MonoMod](#hard-patching-using-monomod) + +### BepInEx (fast) +- Update [segatools](https://gitea.tendokyu.moe/Dniel97/segatools/releases/latest). +- Download [Rizu-BepInEx-v0.1.2.zip](https://gitea.tendokyu.moe/beerpsi/Rizu/releases/download/v0.1.2/Rizu-BepInEx-v0.1.2.zip). +- Extract the zip into the base game folder (containing `Sinmai.exe`). +- Edit `segatools.ini`, adding this entry: +```ini +[unity] +targetAssembly=BepInEx\core\BepInEx.Preloader.dll +``` + +> **Warning** +> +> If you have MelonLoader installed (for YuanCon ADX HID input or other mods): +> - Grab [MLLoader-UnityMono-BepInEx5-v0.5.7.zip](https://github.com/BepInEx/BepInEx.MelonLoader.Loader/releases/download/v2.1.0/MLLoader-UnityMono-BepInEx5-v0.5.7.zip) and extract this zip into the base game folder, overwriting any conflicts. This allow BepInEx to also load MelonLoader mods. +> - Delete `version.dll`, which is used to load MelonLoader, from the game folder. + +### BepInEx +#### Installing BepInEx +- Update [segatools](https://gitea.tendokyu.moe/Dniel97/segatools/releases/latest). +- Download [BepInEx 5](https://github.com/BepInEx/BepInEx/releases/tag/v5.4.23.1). +- Extract the `BepInEx` folder from the archive into the base game folder, ignoring other files. +- Edit `segatools.ini`, adding this entry: +```ini +[unity] +targetAssembly=BepInEx\core\BepInEx.Preloader.dll +``` + +#### Installing the score hook +- Download [Rizu-v0.1.2.zip](https://gitea.tendokyu.moe/beerpsi/Rizu/releases/download/v0.1.2/Rizu-v0.1.2.zip). +- Extract it into the base game folder. + +In the end, your game directory should look like this: +``` +└───BepInEx + └───plugins + └───Rizu + ├───Rizu.dll + └───Rizu.Core.dll +├───Sinmai_Data +├───Rizu.cfg +├───Sinmai.exe +└───segatools.ini +``` + +> **Warning** +> +> If you have MelonLoader installed (for YuanCon ADX HID input or other mods): +> - Grab [MLLoader-UnityMono-BepInEx5-v0.5.7.zip](https://github.com/BepInEx/BepInEx.MelonLoader.Loader/releases/download/v2.1.0/MLLoader-UnityMono-BepInEx5-v0.5.7.zip) and extract this zip into the base game folder, overwriting any conflicts. This allow BepInEx to also load MelonLoader mods. +> - Delete `version.dll`, which is used to load MelonLoader, from the game folder. + +### Hard-patching using MonoMod +- Download [MonoMod](https://github.com/MonoMod/MonoMod/releases/latest). +- Download `Assembly-CSharp.Rizu.mm.dll` from [releases](https://gitea.tendokyu.moe/beerpsi/Rizu/releases/latest) +and place it in `Sinmai_Data/Managed`. +- Run `MonoMod.exe path\to\Sinmai_Data\Managed\Assembly-CSharp.dll` in a command prompt. +- Rename `MONOMODDED_Assembly-CSharp.dll` to `Assembly-CSharp.dll`, optionally backing up the original file. + +## Development +Copy these files from `Sinmai_Data/Managed` into `External`: +- `Assembly-CSharp.dll` +- `UnityEngine.dll` +- `UnityEngine.CoreModule.dll` +- `UnityEngine.JSONSerializeModule.dll` +- `UnityEngine.UnityWebRequestModule.dll` + +You will also need to download [MonoMod](https://github.com/MonoMod/MonoMod/releases/latest). and extract to `External`. + +After that, the project can be restored and built normally.