tristanmcpherson-R2API icon

R2API

A modding API for Risk of Rain 2

Last updated 2 days ago
Total downloads 1202962
Total rating 258 
Categories Libraries
Dependency string tristanmcpherson-R2API-3.0.44
Dependants 1011 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!

Bleeding Edge

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.

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

3.0.43

3.0.30

  • Fixes for current patch

3.0.25

3.0.13

3.0.11

3.0.7

3.0.1

3.0.0

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  
2021-6-18 3.0.44 14962 Version 3.0.44 Install
2021-6-2 3.0.43 52350 Version 3.0.43 Install
2021-4-20 3.0.30 114582 Version 3.0.30 Install
2021-4-15 3.0.25 21403 Version 3.0.25 Install
2021-4-13 3.0.13 9281 Version 3.0.13 Install
2021-4-8 3.0.11 12443 Version 3.0.11 Install
2021-4-5 3.0.7 27479 Version 3.0.7 Install
2021-4-4 3.0.1 3397 Version 3.0.1 Install
2021-4-3 3.0.0 18920 Version 3.0.0 Install
2020-9-1 2.5.14 354461 Version 2.5.14 Install
2020-8-26 2.5.11 44088 Version 2.5.11 Install
2020-8-21 2.5.7 41114 Version 2.5.7 Install
2020-8-17 2.5.6 34459 Version 2.5.6 Install
2020-8-17 2.5.4 4097 Version 2.5.4 Install
2020-8-15 2.5.0 14456 Version 2.5.0 Install
2020-7-6 2.4.29 43141 Version 2.4.29 Install
2020-4-23 2.4.21 57288 Version 2.4.21 Install
2020-4-3 2.4.10 48706 Version 2.4.10 Install
2020-3-16 2.4.2 23201 Version 2.4.2 Install
2020-3-16 2.4.1 605 Version 2.4.1 Install
2020-1-26 2.3.22 42788 Version 2.3.22 Install
2020-1-11 2.3.20 17960 Version 2.3.20 Install
2020-1-9 2.3.17 2694 Version 2.3.17 Install
2020-1-26 2.3.14 302 Version 2.3.14 Install
2019-12-21 2.3.7 36564 Version 2.3.7 Install
2019-12-19 2.3.5 9686 Version 2.3.5 Install
2019-11-14 2.3.0 13687 Version 2.3.0 Install
2019-11-14 2.2.54 499 Version 2.2.54 Install
2019-10-15 2.2.32 15409 Version 2.2.32 Install
2019-9-19 2.1.16 33168 Version 2.1.16 Install
2019-8-12 2.1.15 19591 Version 2.1.15 Install
2019-7-7 2.1.0 23168 Version 2.1.0 Install
2019-5-29 2.0.10 30865 Version 2.0.10 Install
2019-5-24 2.0.8 4249 Version 2.0.8 Install
2019-5-22 2.0.6 2577 Version 2.0.6 Install
2019-5-22 2.0.5 1936 Version 2.0.5 Install