-
Notifications
You must be signed in to change notification settings - Fork 51
Home
R2API is designed to provide an abstraction layer in order to expose and simplify APIs to allow developers to modify Risk of Rain 2 more easily, while still keeping mod interoperability in mind.
Starting with the December Content Update for Risk of Rain 2, mods will need to explicitly request submodules to be loaded with the R2APISubmoduleDependency attribute.
These are loaded under the R2API namespace.
ArtifactCodeAPI allows adding custom artifact codes for the Compound Generator(ROR2Wiki) found on Sky Meadow.
ContentAddition is an all-inclusive submodule for the system RoR2 uses to load resources: content packs.
Currently located under Utils.CommandHelper, CommandHelper allows mods to initialize their convars and concommands.
DamageAPI allows adding custom damagetypes.
DifficultyAPI adds a unified way for difficulty mods to add themselves to the menu.
DotAPI adds a way to add custom DoTs (Damage Over Time).
EliteAPI adds a way to add custom Elites(ROR2Wiki).
LoadoutAPI is used for adding skills to characters.
LobbyConfigAPI adds a unified way to add rules to the pregame lobby.
NetworkingAPI adds methods for sending and receiving netmessages.
OrbAPI adds custom Orbs.
PrefabAPI is used for registering custom prefabs. They are set to not destroy on load, and can be either registered to network or not.
RecalculateStatsAPI allows a simple way of modifying character stats with conditions.
SceneAssetAPI allows loading assets found in scenes.
SoundAPI allows custom sounds.
TempVisualEffectAPI adds a method to add temporary visual effect overlays onto characters.
UnlockableAPI adds methods to add unlockables.
These are generally located under R2API.Utils namespace.
Class that handle the loading of the r2api submodules, mod makers should be aware of this class as you need to use the R2APISubmoduleDependency attribute.
It also allow to check if a specific submodule is loaded (safety check for your mod)
Currently located under R2API namespace, this class is for creating generic notifcations.
Eases up creating (colored) chat messages on mods.
After using R2API.Utils, this allows mods to generate block messages on their Logger provided by BepInEx.
After using R2API.Utils, this extends types and objects with cacheable reflection methods. See the Risk of Thunder Wiki.