RMAPI Reference Book¶
RumbleModdingAPI v5.1.4 — The modding framework for RUMBLE (VR)
This reference is organized into chapters. Each one covers a self-contained feature of RMAPI. Pick the chapter that matches what you're trying to do.
Chapters¶
| # | Chapter | What it covers |
|---|---|---|
| 1 | Getting Started | What RMAPI is, how to set it up, your first mod |
| 2 | Events | Reacting to game moments (match start, round end, player spawn, etc.) |
| 3 | Game Queries | Reading game state: scene name, players, matchmaking type, mod lists |
| 4 | Controller Input | Reading VR controller buttons, triggers, grips, and joysticks |
| 5 | UI Creation | Spawning text labels and interactive buttons in the world |
| 6 | Asset Bundles | Loading custom models, prefabs, and assets into the game |
| 7 | Audio | Loading .wav files and playing custom sounds |
| 8 | Networking | Sending data to other players, custom Photon RPCs, mod exchange |
| 9 | GameObject Registry | Accessing any built-in GameObject by name (Gym, Park, Map0, Map1) |
| 10 | RumbleMod Base Class | Using RumbleMod instead of MelonMod for built-in networking |
Quick "I want to..." Guide¶
| I want to... | Go to |
|---|---|
| Set up my first mod project | Getting Started |
| Run code when a match starts | Events |
| Know when a player takes damage | Events |
| Get the local player object | Game Queries |
| Check what scene I'm in | Game Queries |
| See what mods the opponent is running | Game Queries |
| Check if opponent has a specific mod | Game Queries |
| Read a button press on the VR controller | Controller Input |
| Detect a button press/release this frame | Controller Input |
| Put text in the world | UI Creation |
| Make a clickable button | UI Creation |
| Load a custom 3D model | Asset Bundles |
| Play a custom sound effect | Audio |
| Send data to your opponent | Networking |
| Access a specific in-game object | GameObject Registry |
Full Object Trees¶
Complete collapsible trees for every scene — expand any node to see its children. Use these to find the exact class path for any GameObject.
| Scene | Description |
|---|---|
| DDOL | DontDestroyOnLoad — persistent managers, pools, UI |
| Gym | Solo gym / lobby — interactables, tutorial, leaderboard |
| Park | Park hangout area — notifications, gondola, interactables |
| Map0 | Battle arena #1 — match slabs, pedestals, scene geometry |
| Map1 | Battle arena #2 — match slabs, pedestals, scene geometry |
Namespaces at a Glance¶
RumbleModdingAPI // Main mod class, ModInfo
RumbleModdingAPI.RMAPI.Actions // Event system
RumbleModdingAPI.RMAPI.Calls // Game queries (scene, players, mods, input)
RumbleModdingAPI.RMAPI.Create // UI factory (text, buttons)
RumbleModdingAPI.RMAPI.AssetBundles // Asset bundle loading
RumbleModdingAPI.RMAPI.AudioManager // Audio loading and playback
RumbleModdingAPI.RMAPI.GameObjects // Static GameObject registry
RumbleModdingAPI.RMAPI.Utilities // RumbleMod base, ControllerInputPoller, RaiseEventManager
RumbleModdingAPI.RMAPI.PhotonRPCs // Custom Photon RPC system
RMAPI is created and maintained by UlvakSkillz. If you find it useful, consider supporting them on Ko-fi.