Skip to content
This repository has been archived by the owner on Jan 31, 2023. It is now read-only.

Home

Jump to bottom
casheww edited this page Dec 27, 2020 · 7 revisions

Welcome to the RW-RegionCast wiki!

RegionCast is a BepInEx plugin for Rain World that adds Discord Rich Presence functionality!

How does it work?

RegionCast is made up of 3 parts.

  • A BepInEx plugin (Rain World mod) that grabs the necessary game data and sends it via UDP messages to...
  • The side-app (RCApp.exe). It's built for a newer .NET version than Rain World itself and is the relay between the mod part and Discord.
  • The website at https://casheww.github.io/RW-RegionCast/ that hosts a JSON containing the data for custom regions with RegionCast thumbnail support.

Why is the website necessary?

An owner of the "application" registered on Discord (that's me) must upload the thumbnail of the custom region to Discord's Rich Presence system. This means that if a region creator wants to have their thumbnail art featured, they must request it themselves.

A JSON is maintained in the repository holding data relating to regions that have registered thumbnails. The side app (RCApp.exe) loads this JSON at launch and uses it to determine when a custom region has a thumbnail that can be indexed (if this is not the case, a default image is available). This same JSON is loaded and displayed neatly by the RegionCast website.

The system is as complex as it is because Discord returns an "Ok" message even if the thumbnail doesn't exist, and sets no thumbnail.

The name of the region or subregion being displayed can be changed directly by region pack creators (see below).

Are you a region creator? Check the custom regions page!
Or maybe you're making a custom slugcat character? See the custom sluggo page!

Clone this wiki locally