Guide to installing & playing with mods

Introduction / Warning

First: Slow Down.

If you prefer lots of wasted time and frustration, don't pay close attention to these instructions.

Installing BepInEx (Windows)

Seeking this information for any other systems if you can contribute it.

BepInEx is a utility that allows your mods to work. That's all you need to know, or at least I hope so because that's all I know about it.

---

1. Download BepInEx here[github.com].
If you have a 64-bit system, get the x64 file. If you're not sure of what version of Windows you have, you can verify that information here[support.microsoft.com].

---

2. Once you've downloaded one of the release files, open the zip file, and put its contents in your Streets of Rogue directory:

C:\Program Files\Steam\steamapps\common\Streets Of Rogue

After you've put the zip contents in your SOR folder, it should look something like this.

---

3. Once that's done, run the game with or without Steam. Get to the title screen, and just close the program. Among other things, this will create a new file directory automatically:

C:\Program Files\Steam\steamapps\common\Streets of Rogue\BepInEx\plugins

If the plugins folder showed up, then BepInEx successfully installed.

Installing Mods

Go to the Links section, download a mod file, and put it in the indicated folder.

Did you follow all that?

FAQs

How do I open a ZIP or RAR file?

Install 7-Zip from here[www.7-zip.org]. Right-click the ZIP or RAR and select Extract. If you're still confused at this point, don't give up! Treat this as a mental exercise that may help slow the onset of your dementia!

---

I don't see any effect from loading mods.

There's a 99% chance you skipped a step in the installation instructions. And a 99% chance you think you're the 1% who didn't.

---

I did all that and you still let me down, Ted. It didn't work. I can't play my fun games. And you said there would be Fudgicles! Where's the Fudgicles?!

First, it's Fudgecicles. Here are some of the most common issues:

• RogueLibs is out of date - As of this writing, v3.6.6 is the final edition for SOR1, as development is halted until the release of SOR2. Make sure you have the latest version and you most likely won't have to do it again.
  
• Using my (Ted Bunny's) mods in pre-release test builds - I always try to work with the newest version of RogueLibs & BTHarmonyUtils. Keep an eye out for an error log message that mentions those.
  
• BTHarmonyUtils is in the wrong folder - Some users have reported that the BTHarmonyUtils mod library does not work in the normal mod folder (plugins). Instead, try putting it in

  Steam/steamapps/Streets of Rogue/BepInEx/core

• RogueLibsPatcher is in the wrong folder - This file goes into

  Steam/steamapps/Streets of Rogue/BepInEx/patchers

---

How do I get an Error Log?

1. Verify that you have BepInEx installed correctly. The Plugins folder should automatically generate the first time you run SOR after dropping the BepInEx folder into the directory.
   
2. Activate the error log. Open BepInEx's configuration file, which in Windows is located at:

   Steam/steamapps/common/Streets of Rogue/BepInex/config/BepInEx.cfg

   Set "LogLevels" to "All," like so:
   
3. You're doing great, buddy! Just wanted to say that.
   
4. Restart SOR. Now, whenever you close the game, the log file will be updated automatically as long as you don't have the file open.The log can be found at

   Steam/steamapps/common/Streets of Rogue/BepInEx/LogOutput.log

5. Submit that log on the Modding channel in the Streets of Rogue Discord. The community there has been very quick to help out people with questions.

Links

The destination Folders described below are all under the BepInEx directory:

Steam/steamapps/common/Streets of Rogue/BepInEx/

Libraries

Almost all mods use RogueLibs (https://github.com/Chasmical/RogueLibs/releases/tag/v4.0.0-rc.1). See each mod's documentation for its requirements. Many mods will come packaged with their required files.

Mods

The actual mod files. First listings are the most up to date.

Discord Modding Gallery	https://discord.com/channels/187414758536773632/453259227797127188	SOR community Discord, the best place to find the most recent mod releases.
SOR Mod Hub	https://chasmical.github.io/SoRModHub/	Abbysssal's site hosting various mod files.
GameBanana	gamebanana.com/games/8455	Community site hosting various mod files.

(Sorry, Steam mandates table ugliness through nonworking features.)

[SFH]

How to install CCU? do i put in BepInEx\plugins folder?

[Melilot Mee]

If BepInEx 5.23+ doesn't work with steam on linux(didn't for me and I spent 4 hours trying to get it to work), just get 5.22 and follow the steps on the docs as indicated by Yober

[Ted Bunny]

@Omelette Because you missed a step.

[Omelette]

hey my plugins folder did not show up

[Ted Bunny]

Thanks Yober, I'll update this guide

[Yober]

The CCU mod installation (from its github at least) already contains RogueLibsCore, BTHarmonyUtils and BunnyLibs, so there is no need to install them again if you already put the files from CCU into ./BepInEx/plugins.

This is only for when you have downloaded the zip already.

[Yober]

Also, since the v4 beta releases, RogueLibsPatcher.dll is no longer needed.

source: https://github.com/Chasmical/RogueLibs/releases/tag/v4.0.0-rc.1

[Yober]

For Mac (and Linux), following the steps listed in
https://docs.bepinex.dev/articles/user_guide/installation/index.html and
https://docs.bepinex.dev/articles/advanced/steam_interop.html
should create the ./BepInEx/plugins folder.

In case the docs aren't clear enough about which BepInEx zip to download, download the zip file called {BepInEx_unix_5.4.22.0.zip} from https://github.com/BepInEx/BepInEx/releases/latest .

[sqwerglez]

I have tried to redownload BepInEx after I deleted it under suspicion I got the wrong version, however I can never seem to get it back.

[bagoof.com]

alright so after you put bepinex in verify the integrity of the files through properties on steam. makes it work. its nice