-
Notifications
You must be signed in to change notification settings - Fork 7
Using And Making Libraries
Libraries are scripts that extend the functionality of the game. They run with the highest priority, executing before any mod scripts are loaded and are almost always loaded. Mods can depend on these libraries to build more complex mods. Some examples:
- Yakuza 5 Co-op, which depends on Y5Lib library which provides a C# API for Yakuza 5.
- Like A Brawler 8, which depends on DELib library which provides a C# API for Like a Dragon 8.
- Yakuza 3/4 moveset mods, which may depend on OgreCommand library which unhardcodes Fighter Command data from those games.
Your mod can depend on libraries by including the GUID on mod-meta.yaml
. These libraries will be installed automatically when the mod is installed without the library being bundled with the mod.
An example of this from the mod meta of Yakuza 5 Co-op mod:
Dependencies: 79f1ce9b-e09c-447a-a3e8-a36ce886e1b0
The line above makes it clear that the mod depends on Y5Lib. Dependencies are seperated by ;
While the libraries list available to you when you open "Libraries" tab in the game is controlled by the Shin Ryu Mod Manager repositories, you can still make your own library (and even contact us in the future so we can add it to the list.)
- Get a GUID for your library
- Create a folder with it named as the GUID.
- Create a folder inside that and put your scripts inside.
Example:
srmm-libs\62d185f2-0d10-42d0-955c-67bf5f757994\DE Library\Init.asi