We recommend using the Thunderstore Mod Manager or an alternative for installing mods
|Date uploaded||a month ago|
In the Release version of RoR2, Hopoo Games made a
NetworkModCompatibilityHelper class, which can be given a mod list that is then transformed into a hash that will be checked upon client connection in multiplayer.
If the hash doesnt correspond between the server and the connecting client, the connection is refused.
R2API will add mods to that mod list if they:
NetworkCompatibilityAttribute, either as an custom assembly attribute, or at the top of their plugin class inheriting from
BaseUnityPluginwith the first argument being
NetworkCompatibilityAttribute or the
ManualNetworkRegistrationAttributeanywhere in their assembly.
R2API is a modding framework for other mods to work in, providing centralized and simplified APIs for Risk of Rain 2. This helps keeping mods compatible with each other.
At it's core, R2API should not change how the game behaves without any other mod installed. The only change is to keep mods out of quickplay and prismatic trials by request of the Hopoo Games team.
The contents of
R2API should be extracted into the
BepInEx folder, such that the files inside the
monomod folder in the zip sit in the
monomod folder in BepInEx and the files and folder in
plugins in the archive is inside your
A succesful installation should look like this:
(click to enlarge)
Unless you are a mod developer, you won't need this.
Want to get the latest versions of R2API? The latest bleeding edge builds of
master are hosted on Azure, and may be downloaded using the
Artifacts drop down menu.
Note that such builds may be unstable.
The most recent changelog can always be found on the Github. In this readme, only the most recent minor version will have a changelog.
IsLoaded(string)to check if a submodule is loaded correctly
[mod]prefix to dedicated servers