tristanmcpherson-R2API icon

R2API

A modding API for Risk of Rain 2

Last updated 3 weeks ago
Total downloads 1750904
Total rating 288 
Categories Libraries
Dependency string tristanmcpherson-R2API-4.3.21
Dependants 1538 other mods depend on this mod

This mod requires the following mods to function

bbepis-BepInExPack-5.4.9 icon
bbepis-BepInExPack

Unified BepInEx all-in-one modding pack - plugin framework, detour library

Preferred version: 5.4.9
RiskofThunder-HookGenPatcher-1.2.1 icon
RiskofThunder-HookGenPatcher

MMHOOK generation at runtime.

Preferred version: 1.2.1

README

R2API – a modding API for Risk of Rain 2

Build Status - DEPRECATED GitHub Actions Build

RoR2 1.0 - IMPORTANT NOTICE

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:

  • Use the NetworkCompatibility Attribute, either as an custom assembly attribute, or at the top of their plugin class inheriting from BaseUnityPlugin with the first argument being CompatibilityLevel.EveryoneMustHaveMod.
  • Don't have the NetworkCompatibility Attribute but depend on R2API (have [BepInDependency("com.bepis.r2api")] attribute).

About

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.

Manual installation

The contents of R2API should be extracted into the BepInEx folder, such that the files inside the plugins folder in the zip sit in the plugins folder in BepInEx.

Also you need to install HookGenPatcher because R2API wont function without it.

Developing

A lot of documentation is in the included xmldocs, and further information may be on the dedicated R2API wiki. Do not hestiate to ask in the modding discord too!

Changelog

The most recent changelog can always be found on the GitHub. In this readme, only the most recent minor version will have a changelog.

Current

4.3.x

4.2.x

4.1.x

4.0.11

Available versions

Please note that the install buttons only work if you have compatible client software installed, such as the Thunderstore Mod Manager. Otherwise use the zip download links instead.

Upload date Version number Downloads Download link  
2022-4-26 4.3.21 30633 Version 4.3.21 Install
2022-4-2 4.3.5 33523 Version 4.3.5 Install
2022-3-31 4.3.2 6832 Version 4.3.2 Install
2022-3-21 4.2.1 19008 Version 4.2.1 Install
2022-3-19 4.1.1 6381 Version 4.1.1 Install
2022-3-5 4.0.11 24996 Version 4.0.11 Install
2021-12-17 3.0.71 101533 Version 3.0.71 Install
2021-10-25 3.0.59 61366 Version 3.0.59 Install
2021-8-14 3.0.52 79282 Version 3.0.52 Install
2021-8-5 3.0.50 23378 Version 3.0.50 Install
2021-7-21 3.0.48 47636 Version 3.0.48 Install
2021-7-21 3.0.47 2344 Version 3.0.47 Install
2021-6-18 3.0.44 89403 Version 3.0.44 Install
2021-6-2 3.0.43 54898 Version 3.0.43 Install
2021-4-20 3.0.30 117839 Version 3.0.30 Install
2021-4-15 3.0.25 22187 Version 3.0.25 Install
2021-4-13 3.0.13 9631 Version 3.0.13 Install
2021-4-8 3.0.11 13456 Version 3.0.11 Install
2021-4-5 3.0.7 27753 Version 3.0.7 Install
2021-4-4 3.0.1 3557 Version 3.0.1 Install
2021-4-3 3.0.0 19346 Version 3.0.0 Install
2020-9-1 2.5.14 373168 Version 2.5.14 Install
2020-8-26 2.5.11 44594 Version 2.5.11 Install
2020-8-21 2.5.7 41242 Version 2.5.7 Install
2020-8-17 2.5.6 39202 Version 2.5.6 Install
2020-8-17 2.5.4 4202 Version 2.5.4 Install
2020-8-15 2.5.0 14946 Version 2.5.0 Install
2020-7-6 2.4.29 43265 Version 2.4.29 Install
2020-4-23 2.4.21 57575 Version 2.4.21 Install
2020-4-3 2.4.10 48833 Version 2.4.10 Install
2020-3-16 2.4.2 23319 Version 2.4.2 Install
2020-3-16 2.4.1 712 Version 2.4.1 Install
2020-1-26 2.3.22 43065 Version 2.3.22 Install
2020-1-11 2.3.20 18062 Version 2.3.20 Install
2020-1-9 2.3.17 2785 Version 2.3.17 Install
2020-1-26 2.3.14 405 Version 2.3.14 Install
2019-12-21 2.3.7 36695 Version 2.3.7 Install
2019-12-19 2.3.5 9795 Version 2.3.5 Install
2019-11-14 2.3.0 13818 Version 2.3.0 Install
2019-11-14 2.2.54 609 Version 2.2.54 Install
2019-10-15 2.2.32 15518 Version 2.2.32 Install
2019-9-19 2.1.16 33285 Version 2.1.16 Install
2019-8-12 2.1.15 19697 Version 2.1.15 Install
2019-7-7 2.1.0 23282 Version 2.1.0 Install
2019-5-29 2.0.10 31049 Version 2.0.10 Install
2019-5-24 2.0.8 4347 Version 2.0.8 Install
2019-5-22 2.0.6 2688 Version 2.0.6 Install
2019-5-22 2.0.5 2218 Version 2.0.5 Install