Rizu/README.md

72 lines
2.8 KiB
Markdown
Raw Normal View History

2024-05-21 20:29:18 +00:00
# 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
2024-05-21 20:58:22 +00:00
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-v0.1.1.zip](https://gitea.tendokyu.moe/beerpsi/Rizu/releases/download/v0.1.1/Rizu-v0.1.1.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
```
2024-05-21 20:29:18 +00:00
### 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 MonoMod loader for BepInEx
- Download the [MonoMod loader for BepInEx](https://github.com/BepInEx/BepInEx.MonoMod.Loader/releases/latest)
- Extract the `BepInEx` folder from the archive into the base game folder.
#### Installing the score hook
- Download `Assembly-CSharp.Rizu.mm.dll` from [releases](https://gitea.tendokyu.moe/beerpsi/Rizu/releases/latest) and
place it in `BepInEx/monomod`.
In the end, your game directory should look like this:
```
└───BepInEx
└───monomod
└───Assembly-CSharp.Rizu.mm.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 `Rizu/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 `Rizu/External`.
After that, the project can be restored and built normally.