tristanmcpherson-R2API icon

R2API

A modding API for Risk of Rain 2

Last updated 5 months ago
Total downloads 2368881
Total rating 322 
Categories Libraries
Dependency string tristanmcpherson-R2API-5.0.3
Dependants 2108 other mods depend on this mod

This mod requires the following mods to function

bbepis-BepInExPack-5.4.2103 icon
bbepis-BepInExPack

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

Preferred version: 5.4.2103
RiskofThunder-HookGenPatcher-1.2.3 icon
RiskofThunder-HookGenPatcher

MMHOOK generation at runtime.

Preferred version: 1.2.3
RiskofThunder-R2API_ArtifactCode-1.0.0 icon
RiskofThunder-R2API_ArtifactCode

API for making Artifact Codes

Preferred version: 1.0.0
RiskofThunder-R2API_CommandHelper-1.0.0 icon
RiskofThunder-R2API_CommandHelper

API for registering console commands

Preferred version: 1.0.0
RiskofThunder-R2API_ContentManagement-1.0.1 icon
RiskofThunder-R2API_ContentManagement

API for adding content to the game

Preferred version: 1.0.1
RiskofThunder-R2API_Core-5.0.2 icon
RiskofThunder-R2API_Core

Core R2API module

Preferred version: 5.0.2
RiskofThunder-R2API_DamageType-1.0.0 icon
RiskofThunder-R2API_DamageType

API for registering damage types

Preferred version: 1.0.0
RiskofThunder-R2API_Deployable-1.0.0 icon
RiskofThunder-R2API_Deployable

API for adding custom deployables

Preferred version: 1.0.0
RiskofThunder-R2API_Difficulty-1.0.1 icon
RiskofThunder-R2API_Difficulty

API for adding custom in-game difficulties

Preferred version: 1.0.1
RiskofThunder-R2API_Director-1.0.0 icon
RiskofThunder-R2API_Director

API for easily modifiying the Director (RoR2 monster / interactable spawner) behaviour

Preferred version: 1.0.0
RiskofThunder-R2API_Dot-1.0.0 icon
RiskofThunder-R2API_Dot

API for adding custom damage over time effects

Preferred version: 1.0.0
RiskofThunder-R2API_Elites-1.0.0 icon
RiskofThunder-R2API_Elites

API for adding custom elite types

Preferred version: 1.0.0
RiskofThunder-R2API_Items-1.0.1 icon
RiskofThunder-R2API_Items

API for adding custom items

Preferred version: 1.0.1
RiskofThunder-R2API_Language-1.0.0 icon
RiskofThunder-R2API_Language

API for modifying the language localisation of the game

Preferred version: 1.0.0
RiskofThunder-R2API_Loadout-1.0.0 icon
RiskofThunder-R2API_Loadout

API for registering skills, skins and entity states

Preferred version: 1.0.0
RiskofThunder-R2API_LobbyConfig-1.0.0 icon
RiskofThunder-R2API_LobbyConfig

API for modifying the in-game lobby rules

Preferred version: 1.0.0
RiskofThunder-R2API_Networking-1.0.1 icon
RiskofThunder-R2API_Networking

Networking API around the Unity UNet Low Level API (LLAPI)

Preferred version: 1.0.1
RiskofThunder-R2API_Orb-1.0.0 icon
RiskofThunder-R2API_Orb

API for creation and management of custom Orb types.

Preferred version: 1.0.0
RiskofThunder-R2API_Prefab-1.0.1 icon
RiskofThunder-R2API_Prefab

API for Prefab creation, networking and duplication

Preferred version: 1.0.1
RiskofThunder-R2API_RecalculateStats-1.0.0 icon
RiskofThunder-R2API_RecalculateStats

API for manipulating Character Stats

Preferred version: 1.0.0
RiskofThunder-R2API_SceneAsset-1.0.0 icon
RiskofThunder-R2API_SceneAsset

API for retrieving assets that live exclusively in game scenes

Preferred version: 1.0.0
RiskofThunder-R2API_Sound-1.0.0 icon
RiskofThunder-R2API_Sound

API for adding custom sounds or musics

Preferred version: 1.0.0
RiskofThunder-R2API_TempVisualEffect-1.0.0 icon
RiskofThunder-R2API_TempVisualEffect

API for adding custom temporary visual effects for characters.

Preferred version: 1.0.0
RiskofThunder-R2API_Unlockable-1.0.0 icon
RiskofThunder-R2API_Unlockable

API for adding custom achievements and unlockables

Preferred version: 1.0.0

README

R2API – a modding API for Risk of Rain 2

About

R2API is a modding framework for other mods to work in, providing centralized and simplified APIs for Risk of Rain 2.

This helps keep mods compatible with each other.

At its 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.

Installation

The usage of a mod manager is heavily recommended, you can use r2modman or the thunderstore mod manager.

If you want to manually install still:

  • Install BepInEx.

  • Install HookGenPatcher.

  • Copy the files inside the plugins folder from the zip into the BepInEx/plugins.

Developing mods using R2API

Since the R2API 5.0.0 version update, mod creators should ideally only reference the packages they need in their C# projects and their thunderstore packages.

In the dependency array of their thunderstore manifest, they should reference the R2API packages from the RiskofThunder team, for example: RiskofThunder-R2API_LobbyConfig-1.0.0

In their C# projects, they should only get the corresponding R2API submodules dll they need.

You can use the nuget packages, or download the dlls directly from thunderstore, depending on your workflow.

A lot of documentation is in the included xmldocs, and further information may be on the dedicated R2API wiki.

Do not hesitate to ask in the modding discord too!

Changelog

Older changelogs for this package can be found on GitHub.

'5.0.0'

  • R2API modules are now split into their own package.

    Mod creators should ideally only reference the packages they need in their C# projects and their thunderstore packages. Please refer to the Developing mods using R2API section for more info.

    If you are a mod user, there should be no difference whatsoever with this update.

    If you find any issues, please tell us in the the modding discord or the GitHub repository

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-12-22 5.0.3 348690 Version 5.0.3 Install
2022-12-19 5.0.2 7176 Version 5.0.2 Install
2022-12-19 5.0.1 834 Version 5.0.1 Install
2022-12-18 5.0.0 1849 Version 5.0.0 Install
2022-6-5 4.4.1 177859 Version 4.4.1 Install
2022-4-26 4.3.21 52821 Version 4.3.21 Install
2022-4-2 4.3.5 41553 Version 4.3.5 Install
2022-3-31 4.3.2 17025 Version 4.3.2 Install
2022-3-21 4.2.1 19403 Version 4.2.1 Install
2022-3-19 4.1.1 6607 Version 4.1.1 Install
2022-3-5 4.0.11 36700 Version 4.0.11 Install
2021-12-17 3.0.71 103307 Version 3.0.71 Install
2021-10-25 3.0.59 62018 Version 3.0.59 Install
2021-8-14 3.0.52 80795 Version 3.0.52 Install
2021-8-5 3.0.50 23580 Version 3.0.50 Install
2021-7-21 3.0.48 47808 Version 3.0.48 Install
2021-7-21 3.0.47 2432 Version 3.0.47 Install
2021-6-18 3.0.44 89880 Version 3.0.44 Install
2021-6-2 3.0.43 55270 Version 3.0.43 Install
2021-4-20 3.0.30 119049 Version 3.0.30 Install
2021-4-15 3.0.25 22575 Version 3.0.25 Install
2021-4-13 3.0.13 9740 Version 3.0.13 Install
2021-4-8 3.0.11 13844 Version 3.0.11 Install
2021-4-5 3.0.7 27917 Version 3.0.7 Install
2021-4-4 3.0.1 3656 Version 3.0.1 Install
2021-4-3 3.0.0 19523 Version 3.0.0 Install
2020-9-1 2.5.14 388770 Version 2.5.14 Install
2020-8-26 2.5.11 44830 Version 2.5.11 Install
2020-8-21 2.5.7 41360 Version 2.5.7 Install
2020-8-17 2.5.6 40475 Version 2.5.6 Install
2020-8-17 2.5.4 4302 Version 2.5.4 Install
2020-8-15 2.5.0 15981 Version 2.5.0 Install
2020-7-6 2.4.29 43370 Version 2.4.29 Install
2020-4-23 2.4.21 57849 Version 2.4.21 Install
2020-4-3 2.4.10 48936 Version 2.4.10 Install
2020-3-16 2.4.2 23416 Version 2.4.2 Install
2020-3-16 2.4.1 835 Version 2.4.1 Install
2020-1-26 2.3.22 43277 Version 2.3.22 Install
2020-1-11 2.3.20 18163 Version 2.3.20 Install
2020-1-9 2.3.17 2872 Version 2.3.17 Install
2020-1-26 2.3.14 505 Version 2.3.14 Install
2019-12-21 2.3.7 36814 Version 2.3.7 Install
2019-12-19 2.3.5 9893 Version 2.3.5 Install
2019-11-14 2.3.0 13917 Version 2.3.0 Install
2019-11-14 2.2.54 703 Version 2.2.54 Install
2019-10-15 2.2.32 15617 Version 2.2.32 Install
2019-9-19 2.1.16 33388 Version 2.1.16 Install
2019-8-12 2.1.15 19798 Version 2.1.15 Install
2019-7-7 2.1.0 23398 Version 2.1.0 Install
2019-5-29 2.0.10 31218 Version 2.0.10 Install
2019-5-24 2.0.8 4443 Version 2.0.8 Install
2019-5-22 2.0.6 2789 Version 2.0.6 Install
2019-5-22 2.0.5 2404 Version 2.0.5 Install