AI-generated documentation
This wiki’s articles were drafted using AI and may contain factual errors or misleading explanations. Check the cited sources and test examples before relying on them. Verification labels describe recorded checks, not a guarantee of accuracy or human review. See verification details or report a correction.
Build a plugin, follow an object through the game’s simulation, or learn how rooms become a region.
New to modding? Follow the beginner learning path. Looking for one answer? Use the question index to find a task by its name.
Coverage
The articles describe Rain World v1.11.8 and identify the exact game build, library revisions, and verification limits. Start with a task below or explore relationships in the graph. Compilation checks are available for the public examples. In-game behavior remains to be tested.
Start with a task
Write and debug a plugin
- Set up a C# project file and choose an operating-system workflow.
- Compile a first plugin and understand hook lifecycle.
- Change an internal instruction sequence with IL hooks.
- Keep per-instance state and read player input.
- Investigate a failure with debugging and performance checks.
Work with objects and creatures
- Follow abstract and realized objects through rooms.
- Understand processes and sessions and simulation and physics.
- Try a small item interaction.
- Connect creature templates to the AI lifecycle.
- Plan custom items or creatures with Fisobs.
Build a character or campaign
- Define a SlugBase character.
- Choose its world state.
- Store campaign facts.
- Follow oracle dialogue dispatch.
- Add character-selection art and custom character parameters.
Draw, play sound, and add controls
- Create sprites with the right lifetime and coordinates.
- Load atlases and shaders or draw triangle meshes.
- Play a sound and understand its asset files.
- Add Remix settings, extend HUD parts, or inspect menu pages.
- Use localized text.
Build rooms and check terminology
- Connect rooms and regions.
- Render a room with the authoring workflow and edit its settings.
- Look up a term in the glossary.
- Check versions and source identities in the runtime reference.
Package and release
- Declare mod metadata and dependencies.
- Trace asset resolution and merge behavior.
- Plan DLC and multiplayer compatibility.
- Prepare a Workshop release.
Follow the connections
The sidebar graph shows the current page’s neighbors. Expand it to explore all articles. Drag nodes to rearrange them, hover to reveal connections, and click a node to read its page.
Folder colors identify the topic: foundations are teal, code is purple, game systems are blue, regions are green, and reference pages are gray.
Read the verification details
Source inspected means the behavior was checked in code or the named tool documentation. Example compiled means the supplied example built against the stated local references. Tested in game is reserved for an observed game session. Each article states any remaining checks.
Source inspection and article drafting used AI. These labels do not establish that an experienced modder reviewed the explanation. A successful compile checks that specific example against its references. It does not prove the explanation is correct or that the plugin works in game.
To report an error or unclear explanation, include the page link, the passage, and what you expected or observed. Include the game and library versions if they affect the result. Posting requires a GitGud account.