Skip to main content
The project's repository is archived as part of the GitHub Archive Program. RogueLibs' code and the documentation will no longer be updated.

Installation

To start using mods, first you need to install BepInEx, the modding framework that we're using to mod Streets of Rogue. Then, install RogueLibs (both plugin and patcher - two different important files) and then any mods that you want to play with. You can find a lot of mods on SoR ModHub or GameBanana.

Installing BepInEx

If you already have BepInEx installed, skip this step.

Downloading BepInEx

Go here and download the version for your OS:

Download the version of BepInEx for your game's executable's type:

  • BepInEx_x64_5.x.y.z.zip is for 64-bit executables.
  • BepInEx_x86_5.x.y.z.zip is for 32-bit executables.

Here's a few pointers:

  • You might notice some files in the game's root directory: Galaxy64.dll, UnityCrashHandler64.exe. If you have these, then I'm pretty sure it means that the game's executable is also 64-bit.
  • Launch the game and open the Task Manager. If you see "(32 bit)" in the name of the game's process, then it's 32-bit; otherwise, it's 64-bit.

BepInEx v6

BepInEx v6 pre-release recently came out. Don't use it yet. All of the mods at the moment still use BepInEx v5.4.x, and if you install v6, the mods probably won't work. BepInEx developers plan on supporting older v5 plugins in the future, so once a stable v6 version comes out, you should be able to use it.

Extracting files

Open Steam's game library, right-click on the game and click Properties...:

Go to Local files and click Browse...:


Extract the contents of the .zip file into the game's root directory.

Make sure you extract it the right way. There's a lot of wrong ways, apparently.

  • Make sure that BepInEx folder is in the same directory as your game's executable (StreetsOfRogue.exe);
  • Make sure that you extract the doorstop_config.ini and winhttp.dll files too;

Running the game

note

You need to run the game at least once, so that BepInEx can generate config files and directories!

Just run the game. Either through an executable, or any game launcher.

You can close the game once you see a logo or a loading screen.


Running BepInEx through Steam

On Windows you can run BepInEx through Steam too. Nothing to worry about.


Installing RogueLibs

Backwards compatibility

RL v4 is compatible with mods made on RL v3!

Download the latest RogueLibs v4.0.0-rc.1 version

You need to download only one file - RogueLibsCore.dll.

Go to the BepInEx's directory and put RogueLibsCore.dll file into plugins directory:

RogueLibsPatcher.dll

In previous versions, you would also need to install a patcher, but now it's installed automatically!


Installing plugins (mods)

Download the mods that you want to install (.dll files).

And put these .dll files in the BepInEx/plugins directory.

Where can I get mods?

SoR ModHub is a collection of mods that use the latest RogueLibs v3 that I know about. Includes links to other mod sources as well, and is updated pretty regularly.

GameBanana - Streets of Rogue's official mod-sharing place. Some mods don't get released or updated there, since the process of setting up or updating a page is way too long and overly complicated.

The #👍|modding-gallery🔧 channel in the official SoR's Discord. You'll find all of the latest info, updates and bugfixes there. It's kind of hard to search for specific mods though.

ModDB and NexusMods are barely used at all.

The project's repository is archived as part of the GitHub Archive Program. RogueLibs' code and the documentation will no longer be updated.