60dfb16d5e944afc-RoR2GameModeAPI icon

RoR2GameModeAPI

RoR2GameModeAPI is a fully networked API for the game Risk of Rain 2 that provides a simplified way to add custom game modes, custom voteable rulebooks, custom vote polls, as well as useful utilities and callbacks

Last updated 3 years ago
Total downloads 9635
Total rating 3 
Categories Tools Libraries Tweaks Client-side Server-side Gamemodes
Dependency string 60dfb16d5e944afc-RoR2GameModeAPI-1.0.0
Dependants 1 other package depends on this package

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
tristanmcpherson-R2API-3.0.50 icon
tristanmcpherson-R2API

A modding API for Risk of Rain 2

Preferred version: 3.0.50

README

RoR2GameModeAPI

RoR2GameModeAPI is a fully networked API for the game Risk of Rain 2 that provides a simplified way to add custom game modes, custom voteable rulebooks, custom vote polls, as well as useful utilities and callbacks.

The API supports compatibility with vanilla along with modded clients. It should also be able to handle multiple mods and run fine even if the users don't have all the same mods installed that uses the API's functionalities

Check out my RoR2PVP mod to see the API in action!

Want to buy me a coffee?

Are you a developer?

For a guide on how to integrate this API with your own project you can check my wiki
For example projects you can check out the one included with the API here or look at my RoR2PVP mod

Found a bug? Want a feature added?

Feel free to submit an issue here on my github!

alt text

Features:

  • Vanilla Compatibility
  • GameModeAPI
    • Fully networked
    • Useful general use case event callbacks
    • Register custom game modes
    • Expandable and flexible base game mode class
  • VoteAPI
    • Fully networked
    • Register custom vote polls
    • Register custom RuleCategoryDefs
    • Register custom RuleDefs
    • Register custom RuleChoiceDefs
  • Utilities
    • EmbeddedUtils: Useful utilities methods for handling the loading of embedded files within a assembly
    • GameModeUtils: Useful utilities methods for handling game mode functionalities
  • Extras
    • Config entry for setting the multiplayer limit, can play with up to 16 players!
    • Config entry for unlocking of all artifacts for debugging
    • Config entry for unlocking of all vanilla characters and loadouts for debugging

Requirements:

BepInExPack 5.4.9
R2API 3.0.50
HookGenPatcher 1.2.1

Installation:

  1. Install BepInExPack (Version is provided above)
  2. Install R2API (Version is provided above)
  3. Install HookGenPatcher (Version is provided above)
  4. Download and unzip RoR2GameModeAPI (From releases or on thunderstore.io)
  5. Place RoR2GameModeAPI.dll into your \Risk of Rain 2\BepInEx\plugins\ folder

Default config values
GameModeAPI.cfg

Keys Default values
Unlock All Artifacts false
Unlock All Characters false
Max Multiplayer Count 4
Modded true

Change log:

1.0.0 (Current)

  • Initial release