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

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mosamadeeb authored Jun 9, 2022
1 parent b281830 commit 65d9c92
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# RyuModManager
Mod manager for Yakuza series PC games. Currently is a CLI app, no GUI has been made yet. Please check the [Supported Games](../../wiki/Supported-Games) list before using.
Mod manager for Yakuza series PC games. Please check the [Supported Games](../../wiki/Supported-Games) list before using.

Allows loading mods from a `/mods/` folder inside the game's directory.
Mods do not have to contain repacked PAR archives, as Ryu Mod Manager can load loose files from the mod folder.
Expand All @@ -9,15 +9,15 @@ Repacking is needed only for some PAR archives in Old Engine games (Yakuza games
Unpack the [latest release](../../releases/latest) into the game's directory, in the same folder as the game's executable.

# Usage
Starting from version v1.7, RyuModManager is now supported in [Vortex](https://www.nexusmods.com/about/vortex/)! This allows using the **Mod Manager Download** button on Nexus Mods to make downloading mods a simpler process. Please check the [Vortex support plugins](https://github.com/SutandoTsukai181/vortex_mo2_yakuza_plugins) repo for more info. You still have to install RyuModManager in order to use Vortex support.
A command line interface is available, as well as a simple GUI. For better operation, using an external mod manager (such as [Vortex](https://www.nexusmods.com/about/vortex/) or [Mod Organizer](https://github.com/ModOrganizer2/modorganizer) is recommended. Ryu Mod Manager needs to be installed as well. Please check the [Yakuza Support Plugins](https://github.com/SutandoTsukai181/vortex_mo2_yakuza_plugins) repository for more info.

For actual usage, check the [Installing Mods](../../wiki/Installing-Mods) and [Creating A New Mod](../../wiki/Creating-A-New-Mod) articles in the [wiki](../../wiki).

To run the program, just launch it with no arguments and it will generate an MLO file to be used by [Parless](https://github.com/SutandoTsukai181/YakuzaParless), the Yakuza mod loader.
All of the mod manager [releases](../../releases) include Parless and all necessary files for usage, so no need to download Parless separately.

# Building
Clone the repository and fetch the submodules, then open the solution file (.sln) in Visual Studio.
Clone the repository and fetch the submodules, then open the solution file (.sln) in Visual Studio. You can then `dotnet publish` the `RyuGUI` project.

# Credits
Thanks to [Kaplas](https://github.com/Kaplas80) for [ParLibrary](https://github.com/Kaplas80/ParManager), which is used for repacking pars.
Expand Down

0 comments on commit 65d9c92

Please sign in to comment.