Giter VIP home page Giter VIP logo

rwmodloader's Introduction

Number of downloads Latest version

Realm

Installing Rain World mods can be a pain, so Realm is my attempt at simplifying the process. It's easy to use for players and developers alike.

To compare Realm with other similar projects:

  • BOI manages mods for Rain World. If you can't use Realm, BOI is a reliable fallback.
  • BepInEx loads mods for Unity games. Realm uses BepInEx as a framework to bootstrap the vanilla game.
  • Partiality loads mods for Rain World and a few other games. It's slowly being replaced by BepInEx, though.

Realm loads and manages your mods in-game, so you can manage mods without closing the game. It's a minor miracle this works at all, and there are a few mods it breaks. If a mod doesn't work after reloading in-game, restart and avoid reloading while that mod is installed.

There's a mod browser to make installing mods easier. You can still install them manually though: Drop the mod's files and dependencies into the plugins folder as one .zip file, .dll file, or folder. You can find the plugins folder within the mod menu.?

Video of reloading
demonstration.mp4

Install Realm

While Realm is installed, keep in mind:

  • You don't need to install AutoUpdate, EnumExtender, PublicityStunt, or LogFix.
  • You don't need to use BOI. In fact, you shouldn't—just launch the game without it.
  • Logs are sent to BepInEx/LogOutput.log.

If you're on Linux or Steam Deck, please check PJB's guide for playing Rain World on those platforms.

Click here to install.

Uninstall Realm

  1. Open the Rain World folder?.
  2. Run uninstall_realm.bat while the game is closed.

Resources

  • Skim the dev guide to enable reloading from the pause menu.
  • Run the rdb client to submit mods to the browser.
  • Visit the support page to report bugs, suggest features, or get technical support.

Credits

rwmodloader's People

Contributors

dual-iron avatar sylveonbottle avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

rwmodloader's Issues

Incorrect array initialization in VirtualEnums

Problem

Someone playing Automaton on Realm ran into a bug with the virtual enum system. This code:

var types = (CreatureTemplate.Type[])Enum.GetValues(typeof(CreatureTemplate.Type));

Throws this error: InvalidCastException: Cannot cast from source type to destination type.
I think EnumExtender had the same bug a long time ago

Thanks @SlimeCubed

Solution

Should be generic:

var valuesExtended = new object[values.Length + data.EnumValues.Count];

"Please reinstall Realm" on linux

Describe the bug
Installed Realm on a fresh game install, using the same wineprefix as the game. Results in the above message on the title screen. The log gives a fatal error:
[Fatal : Realm] Mutator not present. Please reinstall Realm!
Full log here
Should probably also mention reinstalling doesn't work.

Additional context
Running on Proton 6.3-8, also tried the most recent 7.0rc3 of GloriousEggroll's proton.

Mod list offline, autoupdate isn't functioning

Describe what you were trying to do and why
I'm simply trying to view the mod list. Also, autoupdate seems to be failing.

(For example, "Many More Fixes" is still 1.0.0 even though it's 1.0.1, mentioned here in the RW discord: https://discord.com/channels/291184728944410624/804088181904375819/807564814586216449)

To Reproduce
Unfortunately I'm not sure what's causing this or if it's just a local problem. Here are some logs.

  • No mods enabled. Opened game, viewed mod list, and exited: LogOutput.log

  • No mods enabled. Opened game, enabled "Many More Fixes" and ConfigMachine, viewed mod list, and exited: LogOutput.log

Expected behavior
Autoupdate works, the mod list is viewable.

Actual behavior
Autoupdate doesn't work, the mod list is always offline.

Screenshots
image

Additional context
My system is configured to use Cloudflare DNS, and I've heard some websites and APIs will reject that.

RegionKit Incompatibility

Attempting to use Realm with the most recent version of RegionKit (v2.0) breaks the game, preventing all mods from being used. The menu will give this error:
image
Here is the LogOutput from BepInEx:
LogOutput.log
If more information is needed please let me know.

Realm seems to kill my game.

Describe the bug
Honestly, there's no true way to describe this. The bug happens when I install Realm, then use Dev Console, and Warp together in the console.

To Reproduce
Steps to reproduce the behavior:

  1. Download and use the installer for Realm
  2. Install Dev Console and Install Warp
  3. Run some commands with Warp and Dev Console [I ran a fill pips command, and a karma command with 10 karma]
  4. Do some more commands after you run the fill pips and karma, such as messing with the rain timer
  5. Watch the game crash
  6. Load the game up and Uninstall both mods

Expected behavior
It should crash your game, and then when you next load up the game you should get a notification that some mods are broken. I then disabled and uninstalled both Dev Console and Warp, and hit single player, then I got a notification when I pressed the single player button that some mod had broken, even though no mods were active or in the game files at all.

Screenshots
If applicable, add screenshots to help explain your problem.
image

Additional context
I don't know what the hell went on honestly, all I know is using realm completely disables game-play with those two mods once used.
Oh also, the only way I could actually play the game was by uninstalling Realm.

BepInEx fails to initialize under Proton with Realm installed.

Describe the bug
BepInEx fails to initialize properly with realm installed on Linux (Running Rain World under Steam Proton), preventing Rain World from even launching fully.

To Reproduce

  • Install BepInEx and Realm on Linux
  • Edit the BepInEx config settings to output logs to a terminal
  • Launch Rain World under Proton after putting WINEDLLOVERRIDES="winhttp=n,b" %command% in the launch options to make BepInEx actually run.
  • Observe terminal output and see that the game never fully launches.

Expected behavior
The game should launch with BepInEx and Realm loaded.

Screenshots

  • BepInEx log: (it stops after this error with Realm installed)
    image

Additional context
Linux distro being used is Arch Linux with kernel version 5.10.88-2-lts
Game will launch with BepInEx if Realm either is not installed or the Realm folder is missing in the BepInEx folder.

Incompatible with some mods

Some mods behave poorly with Realm.

Some mods can't be unloaded in-game:

  • Sharpener
  • SeamlessLevels

Other mods are simply broken:

  • Expedition (uses BinaryFormatter for save data)

Installer crashes when running it.

Describe the bug
Installer crashes when running it. Version Beta 1.

To Reproduce
Steps to reproduce the behavior:

  1. Download release.
  2. Run UserInstaller.exe
  3. See error

Expected behavior
It should install Realm loader.

Additional context
Unhandled exception. System.IO.FileNotFoundException: Could not find file 'C:\Program Files (x86)\Steam\steamapps\appmanifest_312520.acf'. File name: 'C:\Program Files (x86)\Steam\steamapps\appmanifest_312520.acf' at Microsoft.Win32.SafeHandles.SafeFileHandle.CreateFile(String , FileMode , FileAccess , FileShare , FileOptions ) at Microsoft.Win32.SafeHandles.SafeFileHandle.Open(String , FileMode , FileAccess , FileShare , FileOptions , Int64 ) at System.IO.Strategies.OSFileStreamStrategy..ctor(String , FileMode , FileAccess , FileShare , FileOptions , Int64 ) at System.IO.Strategies.FileStreamHelpers.ChooseStrategyCore(String , FileMode , FileAccess , FileShare , FileOptions , Int64 ) at System.IO.Strategies.FileStreamHelpers.ChooseStrategy(FileStream , String , FileMode , FileAccess , FileShare , Int32 , FileOptions , Int64 ) at System.IO.StreamReader.ValidateArgsAndOpenPath(String , Encoding , Int32 ) at System.IO.File.InternalReadAllText(String , Encoding ) at System.IO.File.ReadAllText(String ) at Mutator.IO.ExtIO.GetRwDir() at Mutator.IO.ExtIO.get_RwDir() at Mutator.IO.RealmInstaller.UserInstall() at Program.<Main>$(String[] )

Uninstallation Issue

When I uninstalled it took my BepInEx folder with it, and all my mods. >:(

I'm not sure if it was a bug but I assume it is.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.