Add warning for MelonLoader

This commit is contained in:
beerpsi 2024-06-01 07:41:41 +00:00
parent a664f59f4b
commit 18c559847c

150
README.md
View File

@ -1,69 +1,81 @@
# Rizu # Rizu
A Tachi score hook for maimai DX. A Tachi score hook for maimai DX.
Tested versions: Tested versions:
- BUDDiES - BUDDiES
## Installation ## Installation
First, get the [config file](https://kamai.tachi.ac/client-file-flow/CIaa7b4d91041688189231cfc696c0754120b1790b) and 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: place it in the same folder as the game executable (Sinmai.exe), then follow **only** one of three methods:
- [BepInEx (fast)](#bepinex-fast) - [BepInEx (fast)](#bepinex-fast)
- [BepInEx](#bepinex) - [BepInEx](#bepinex)
- [Hard-patching using MonoMod](#hard-patching-using-monomod) - [Hard-patching using MonoMod](#hard-patching-using-monomod)
### BepInEx (fast) ### BepInEx (fast)
- Update [segatools](https://gitea.tendokyu.moe/Dniel97/segatools/releases/latest). - 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). - 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`). - Extract the zip into the base game folder (containing `Sinmai.exe`).
- Edit `segatools.ini`, adding this entry: - Edit `segatools.ini`, adding this entry:
```ini ```ini
[unity] [unity]
targetAssembly=BepInEx\core\BepInEx.Preloader.dll targetAssembly=BepInEx\core\BepInEx.Preloader.dll
``` ```
### BepInEx > **Warning**
#### Installing BepInEx >
- Update [segatools](https://gitea.tendokyu.moe/Dniel97/segatools/releases/latest). > If you have MelonLoader installed (for YuanCon ADX HID input or other mods):
- Download [BepInEx 5](https://github.com/BepInEx/BepInEx/releases/tag/v5.4.23.1). > - 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.
- Extract the `BepInEx` folder from the archive into the base game folder, ignoring other files. > - Delete `version.dll`, which is used to load MelonLoader, from the game folder.
- Edit `segatools.ini`, adding this entry:
```ini ### BepInEx
[unity] #### Installing BepInEx
targetAssembly=BepInEx\core\BepInEx.Preloader.dll - 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.
#### Installing the score hook - Edit `segatools.ini`, adding this entry:
- Download [Rizu-v0.1.2.zip](https://gitea.tendokyu.moe/beerpsi/Rizu/releases/download/v0.1.2/Rizu-v0.1.2.zip). ```ini
- Extract it into the base game folder. [unity]
targetAssembly=BepInEx\core\BepInEx.Preloader.dll
In the end, your game directory should look like this: ```
```
└───BepInEx #### Installing the score hook
└───plugins - Download [Rizu-v0.1.2.zip](https://gitea.tendokyu.moe/beerpsi/Rizu/releases/download/v0.1.2/Rizu-v0.1.2.zip).
└───Rizu - Extract it into the base game folder.
├───Rizu.dll
└───Rizu.Core.dll In the end, your game directory should look like this:
├───Sinmai_Data ```
├───Rizu.cfg └───BepInEx
├───Sinmai.exe └───plugins
└───segatools.ini └───Rizu
``` ├───Rizu.dll
└───Rizu.Core.dll
### Hard-patching using MonoMod ├───Sinmai_Data
- Download [MonoMod](https://github.com/MonoMod/MonoMod/releases/latest). ├───Rizu.cfg
- Download `Assembly-CSharp.Rizu.mm.dll` from [releases](https://gitea.tendokyu.moe/beerpsi/Rizu/releases/latest) ├───Sinmai.exe
and place it in `Sinmai_Data/Managed`. └───segatools.ini
- 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.
> **Warning**
## Development >
Copy these files from `Sinmai_Data/Managed` into `External`: > If you have MelonLoader installed (for YuanCon ADX HID input or other mods):
- `Assembly-CSharp.dll` > - 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.
- `UnityEngine.dll` > - Delete `version.dll`, which is used to load MelonLoader, from the game folder.
- `UnityEngine.CoreModule.dll`
- `UnityEngine.JSONSerializeModule.dll` ### Hard-patching using MonoMod
- `UnityEngine.UnityWebRequestModule.dll` - 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)
You will also need to download [MonoMod](https://github.com/MonoMod/MonoMod/releases/latest). and extract to `External`. and place it in `Sinmai_Data/Managed`.
- Run `MonoMod.exe path\to\Sinmai_Data\Managed\Assembly-CSharp.dll` in a command prompt.
After that, the project can be restored and built normally. - 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.