You are viewing a potentially older version of this package. View all versions.
tristanmcpherson-R2API-4.4.1 icon

R2API

A modding API for Risk of Rain 2

Date uploaded 2 years ago
Version 4.4.1
Download link tristanmcpherson-R2API-4.4.1.zip
Downloads 202845
Dependency string tristanmcpherson-R2API-4.4.1

This mod requires the following mods to function

RiskofThunder-HookGenPatcher-1.2.3 icon
RiskofThunder-HookGenPatcher

MMHOOK generation at runtime.

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

API for adding content to the game

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

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

Preferred version: 1.0.2
RiskofThunder-R2API_RecalculateStats-1.2.0 icon
RiskofThunder-R2API_RecalculateStats

API for manipulating Character Stats

Preferred version: 1.2.0
bbepis-BepInExPack-5.4.2109 icon
bbepis-BepInExPack

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

Preferred version: 5.4.2109
RiskofThunder-R2API_DamageType-1.0.4 icon
RiskofThunder-R2API_DamageType

API for registering damage types

Preferred version: 1.0.4
RiskofThunder-R2API_Difficulty-1.1.1 icon
RiskofThunder-R2API_Difficulty

API for adding custom in-game difficulties

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

API for creation and management of custom Orb types.

Preferred version: 1.0.1
RiskofThunder-R2API_LobbyConfig-1.0.1 icon
RiskofThunder-R2API_LobbyConfig

API for modifying the in-game lobby rules

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

API for modifying the language localisation of the game

Preferred version: 1.0.1
RiskofThunder-R2API_Dot-1.0.1 icon
RiskofThunder-R2API_Dot

API for adding custom damage over time effects

Preferred version: 1.0.1
RiskofThunder-R2API_Deployable-1.0.1 icon
RiskofThunder-R2API_Deployable

API for adding custom deployables

Preferred version: 1.0.1
RiskofThunder-R2API_CommandHelper-1.0.1 icon
RiskofThunder-R2API_CommandHelper

API for registering console commands

Preferred version: 1.0.1
RiskofThunder-R2API_ArtifactCode-1.0.1 icon
RiskofThunder-R2API_ArtifactCode

API for making Artifact Codes

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

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

Preferred version: 1.1.1
RiskofThunder-R2API_Unlockable-1.0.2 icon
RiskofThunder-R2API_Unlockable

API for adding custom achievements and unlockables

Preferred version: 1.0.2
RiskofThunder-R2API_TempVisualEffect-1.0.2 icon
RiskofThunder-R2API_TempVisualEffect

API for adding custom temporary visual effects for characters.

Preferred version: 1.0.2
RiskofThunder-R2API_Sound-1.0.2 icon
RiskofThunder-R2API_Sound

API for adding custom sounds or musics

Preferred version: 1.0.2
RiskofThunder-R2API_Prefab-1.0.3 icon
RiskofThunder-R2API_Prefab

API for Prefab creation, networking and duplication

Preferred version: 1.0.3
RiskofThunder-R2API_Loadout-1.0.2 icon
RiskofThunder-R2API_Loadout

API for registering skills, skins and entity states

Preferred version: 1.0.2
RiskofThunder-R2API_Items-1.0.3 icon
RiskofThunder-R2API_Items

API for adding custom items

Preferred version: 1.0.3
RiskofThunder-R2API_Elites-1.0.2 icon
RiskofThunder-R2API_Elites

API for adding custom elite types

Preferred version: 1.0.2
RiskofThunder-R2API_SceneAsset-1.1.1 icon
RiskofThunder-R2API_SceneAsset

API for retrieving assets that live exclusively in game scenes

Preferred version: 1.1.1
RiskofThunder-R2API_Core-5.0.10 icon
RiskofThunder-R2API_Core

Core R2API module

Preferred version: 5.0.10

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