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 Jun 13, 2022 · 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 RyuModManager.exe file and the other files in the zip 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 RyuModManager.exe once, without any mods installed. This will generate the files/folders necessary for mod installation. After running it, you should have these in your game folder:

  • 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.

Installing mods

Only one method needs to be followed. You can install mods either using Vortex (method A), using Mod Organizer (method B), or manually (method C).

Manually unpacking mods to the \mods\ folder is NOT required for methods A and B.

Method A (Simplest method): Vortex

This method uses Vortex to automatically set up everything when installing mods.

A.1) Installing Vortex

Download Vortex and run it.

A.2) Setting up Vortex for Yakuza games

In Vortex, go to the Games tab and you will find your installed Yakuza games there. If you cannot find a game you have installed, then you can type Yakuza in the search bar to find all games.

Go over each game you want to install mods for, and click Manage. Vortex will ask you to download the support extension. This needs to be done for each game you want to add Vortex support to. After downloading all extensions, you should restart Vortex.

Alternatively, if you don't want to install the extensions from inside Vortex, you can download the support extensions from Nexus using the links here.

A.3) Installing mods using Vortex: Please refer to step B.3)


Method B (Recommended method): Mod Organizer

This method uses Mod Organizer. This is the recommended method because Mod Organizer allows more freedom with installing and managing mods. There is support for multiple profiles (multiple mod lists), automatic fixing of unsupported mods, importing existing mods from RMM \mods\ directory, and seeing conflicts between mods to make organizing load order easier.

Mod Organizer also shows all modded files that are being loaded in an organized way, which makes it very useful for mod creators to manage compatibility with other mods.

B.1) Installing Mod Organizer

Download Mod Organizer's latest release. The file to download should end with .exe (for example, Mod.Organizer-2.4.4.exe). That file is an installer, and will install Mod Organizer for you. Make sure to note the install path of Mod Organizer in this step.

B.2) Setting up Mod Organizer for Yakuza games

Before running Mod Organizer, you need to download the Yakuza support plugins for it. Follow the instructions in that link to install the plugins. You will need to go to the Mod Organizer directory, which is the install path from the previous step. After running Mod Organizer, you will be able to select your Yakuza games from a list. If you cannot see them, you can manually browse for each game's directory.

Please read these additional notes about using Mod Organizer with Ryu Mod Manager.

B.3) Installing mods using Vortex/Mod Organizer

This step applies to both Vortex and Mod Organizer (Methods A and B)

You can install mods either from Nexus mods, or from a zip file (e.g. from the Discord server). All mods supported by Ryu Mod Manager are also supported by Vortex and Mod Organizer.

Nexus Mods

To install a mod from the Nexus mods site, just click on the Mod Manager Download button and the mod will be installed by Vortex/Mod Organizer.

Packed mods (ZIP)

Vortex: To install a mod from a ZIP, drag the ZIP file into the Mods tab of Vortex and the mod will be installed. Mod Organizer: Go to File -> Install Mods from the menu bar (or click the second icon from the top left). Browse to the ZIP file of the mod and select it.

If the Mod Manager Download button is not there or if Vortex/Mod Organizer shows an error when installing the mod, then the mod might be unsupported. In that case, you can try following these instructions to convert the mod to be supported by Ryu Mod Manager.

After you're done with this step, you can run the game and your mods will be applied automatically!


Method C: Manual Installation

This method involves manually unpacking the mod and using Ryu Mod Manager GUI.

C.1) 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.

C.2) Installing the mod

The mod is installed now. Simply unpacking a mod to the \mods\ directory will install it, and the mod should be applied next time you run the game.

If you want to manage the mod, continue reading.

Managing the mod load order

Run RyuModManager.exe and you will see the list of installed mods. You can toggle the checkbox in front of each mod to enable/disable it, and you can use the buttons on the right side to move mods up/down the load order. Multiple mods can be selected at once by holding Ctrl and selecting individual mods, or holding Shift to select all mods inside a range.

The load order is represented in terms of priority, ascendingly. 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.

Remember to click Save after you're done with modifying the load order, or your changes won't be saved.

Example image of the Ryu Mod Manager mod list:

example image