Skip to content
This repository has been archived by the owner on Nov 29, 2023. It is now read-only.

Installing Mods

SutandoTsukai181 edited this page May 8, 2021 · 15 revisions

This article explains how to install a mod. Please check the Supported Games list to make sure the game you want to mod is supported.

Requirements

This step needs to be done only once.

Installing Ryu Mod Manager

Download the latest version of the mod manager. Unpack the zip into your game's directory (most of the time it is C:\Program Files (x86)\Steam\steamapps\common\<GAME-NAME>). The RyuModManagerCLI.exe file should be put in the same directory that contains the data folder and the game's EXE file. For Yakuza 0 and Kiwami, the zip should be unpacked into the media folder. For Yakuza 5, it should be unpacked into the main folder.

Setting up the configuration files

Run RyuModManagerCLI.exe once, without any mods installed. This will generate all the files necessary for mod installation. After running it, you should have these files:

  • ModLoadOrder.txt: Used for adding mods and managing load order.
  • YakuzaParless.ini: Used for configuring the mod loader.
  • "mods" folder: Downloaded mods will be unpacked in this folder, where each mod is inside its own folder.

Unpacking the mod

Unpack the mod into your \mods\ folder in the game's directory. If done correctly, your mods folder should have something similar to the following example:

\mods\ExampleMod\<mod files>

where \mods\ is in the same directory as the game's executable file. The mod's files will be inside a single folder, in this case called ExampleMod. If the archive you unpacked contained a lot of files/folders in its root, put them all inside a single folder in \mods\ and rename that folder to have the name of the mod.


Adding the mod

Adding the mod to the mod list

Open the ModLoadOrder.txt file which was generated by the mod manager. Add your mod's name to the file on a single line. Here, the "mod's name" is the name of the folder that you put inside \mods\. The line should only contain the mod folder's name.

Example: ModLoadOrder.txt with 3 mods inside. Each of these mods has a folder with its name inside the \mods\ directory.

ExampleMod
ExampleMod2
MyNewMod

Managing the mod load order

The line where you add the mod's name inside ModLoadOrder.txt determines the load order of its files. The LAST mod in the list has the HIGHEST priority. So in case of some file conflicts between mods, the mod with the highest priority will have its files guaranteed to be loaded.

In the above example, MyNewMod has the highest priority, and ExampleMod has the lowest priority.


Installing the mod

This step is really simple. Just run RyuModManagerCLI.exe by double-clicking on it, and wait for the mods to be processed by the mod manager.

If you have done all of the previous steps correctly, you will be able to see the new mod applied when the game is launched.

Important note about this step

This step needs to be done again whenever a new mod is installed/uninstalled, or whenever the ModLoadOrder.txt file is modified. Simply run RyuModManagerCLI.exe once before launching the game after making one of these changes, and the mods will be applied.