ReturnsAPI
(Mostly done) API for modding Risk of Rain Returns.
About this mod Author’s original text
Still an active work in progress, although it is mostly done.
API for modding Risk of Rain Returns.
Documentation can be found on the wiki.
Include ReturnsAPI-ReturnsAPI-0.1.59 as a dependency in manifest.json, and import it with:
-- Automatically adds class references directly to your mod,
-- and performs other actions (such as autoregistering for language loading)
mods["ReturnsAPI-ReturnsAPI"].auto()
-- or
-- Stores class references in a variable
local RAPI = mods["ReturnsAPI-ReturnsAPI"].setup()
-- See the Importing page for additional properties you can pass:
--
Uses ReturnOfModding as the base mod loader.
Successor to RoRR Modding Toolkit.
Installation Instructions
Install through the client or r2modman (more detailed instructions here if needed).
Join the Return of Modding server for support.
Install & use Install: follow the bundled instructions
- Unzip the archive from playbuff and read the bundled readme / instructions first.
- Most mods rely on the game's mod loader — the usual route is a community mod manager (such as r2modman): pick this game, install, and it handles the loader and dependencies.
- For a manual install, put the mod files into the matching Mod / plugins folder inside the game directory.
- Launch the game to confirm it loaded; mods with listed dependencies need those installed as well.
Install locations vary a lot between mods — the bundled readme is the most reliable guide. If the mod depends on a loader such as ReturnOfModding, install it first as the readme describes.
Install these first, or the mod will not work: