Beginners Guide to Risk of Rain 2 Modding

Overview

This is a guide contains all the necessary information to get started modding Risk of Rain 2 step by step. It’s honestly very easy and this guide should have everything you need. If this is ever outdated please check the updated version on https://github.com/risk-of-thunder/R2Wiki/wiki/Beginner’s-Guide-for-Modding-Risk-of-Rain-2

Foreword

Please take the time to read through this guide as well as any sub-guides that are linked to. Most issues can simply be resolved by reading what is provided.

If you do not like to read then skip to downloading the mod manager, you can always refer back to this if you’re stuck

Reading mod descriptions and doing research on issues is recommended if you want a pleasant modding experience. If you think you can skip doing these to save time now, you may end up spending time troubleshooting all because you missed something simple like single player only, not compatible with X, etc.

This guide assumes that you are familiar with basic Windows OS use such as the file and folder systems and with the file system of your own computer. It also assumes you know how to download and install programs and unzip archive files. If you lack a program to extract archive files, I recommend 7zip[www.7-zip.org] for this task.

Note: You can still play Vanilla Risk of Rain 2 by launching via steam, riskofrain2.exe, a shortcut or clicking “Start Vanilla” inside a mod manager.

Frequently Asked Questions (FAQ)

I am dearly sorry but currently there is no mod support for console. This would require considerable effort from hopoo and an agreement with each platform similar to what bethesda has, If you really want this on console then ask the Developers:

• Tweets by RiskofRain
• Tweets by the_hopoo
• Tweets by hopoogames
• HopooGames’s email: [email protected]

They’ve made an official statement here and have spoken about it in an interview with Woolie . They haven’t popped in to say hello to the modding discord nor do they provide an official modding API but they do support the modding community by trying not to break mods when updating the game and altering the code to make it more convenient for modders to slot in their mods. Their long term goal as stated in the interview is to stop mods breaking after every update.

The Developers have asked that modded users stay out of prismatic trials since modded players likely have a different gameplay experience from vanilla players thus shouldn’t get leaderboard placement.

Yes you can by using the Unmodded Version[thunderstore.io] mod, however this limits you to client-side and sever-side/host mods. Mods that add completely new characters, enemies, skills, etc will not work.

Nah, you can still play vanilla Risk of Rain 1 & 2 by launching via steam, riskofrain(2).exe, a shortcut or clicking “Start Vanilla” inside a mod manager.

Have a quick google or ask around on the discord’s. There will be some varied opnions on what are the best mods and recommend mods but guides and some suggestions should help. Just open up the Thunderstore and start looking. Compile a list of what looks interesting, and if you still feel stuck, post that list to the discord for more feedback.

Look through thunderstore sorting by last updated.

Configuration files for mods are located in /bepinex/config and can be opened with any text editor(I recommend Notepad++). If you are using a mod manager there should be a config editor option to find and open these quicker.

Risk of Rain 2 Part 1/2

You can install mods manually[github.com], but it will cause you and developers great pain in the long run so for the sake of everyone’s sanity we implore you to use one. There are four managers that you can choose from currently. Three are for windows and one is for Linux. For now we will focus on r2modman[thunderstore.io] until the other managers are more feature complete and this guide can be generalized.

Installation

1. Go to the Thunderstore download page.
2. Click “Manual Download”
3. Extract the contents of the downloaded .zip file.
4. Run the “r2modman Setup X.X.X.exe” (The “X.X.X” is representative of the version number e.g. v1.1.1) and follow the steps in the installer (Do not install r2modman inside the Risk of Rain 2 folder.).

Updating
r2modman will automatically download any available updates during use. If an update has been downloaded, it will be installed once you have closed the application.

Installing Mods

Installing mods on r2modman is very simple once you have created and selected a profile you can:

• Click “Online” then browse the mods that have appeared(I recommend sorting by “Last Updated”), click on a mod, click download, confirm “Download with dependencies” and you’re done.

OR

• Browse Thunderstore[thunderstore.io] and click “Install with Mod Manager”, confirm “open r2modman?”(Tick the box for always allow if you never want to see the prompt again) and you’re done.

If you we’re wondering what “Dependencies” are well.. To simplify it all mods are generally reliant on libraries which contain features for mods to utilize, thus these mods are dependent on them. All mods are dependent on BepEx(Allows execution of custom code in RoR2) and R2API(Full of all the basic features required to make mods) by default.

Updating Mods

Updating is once again very simple and can be done in two ways.
One by one:

1. Open the profile for which mods you wish to update.
2. Click “Installed”.
3. Click on the mod you wish to update(Mods with updates available will be indicated by a cloud icon).
4. Click “Update”
5. Confirm “Download with dependencies”

OR

1. All at once:
2. Open the profile for which mods you wish to update.
3. Click “Settings”
4. Scroll down to the bottom of the “All” tab.
5. Click “Update all mods”
6. Confirm “Update all”

It is recommended you update one by one so you can confirm which mods are being updated, mod changes and for general security.

While some mods may have configuration in-game most have configuration files stored in “BepInExconfig”, You can alter the settings in these files by:

r2modman Config Editor

1. Select the Profile whos mod settings you wish to configure.
2. Click on “Config editor”.
3. Click on the mod you wish to configure.
4. Confirm “Edit Config”

Remember to “Save changes” when you are done.

Directly

1. Select the Profile whos mod settings you wish to configure.
2. Click on “Settings”.
3. Click on the “Locations” tab.
4. Click “Browse profile folder”
5. Navigate to “BepInExconfig”
6. Open the appropriate config for the mod you wish to configure with an appropriate text editor(We recommend Notepad++[notepad-plus-plus.org]).

Remember to save when you are done.

Wait.. I have no config files???

Ah yes, You must launch the game with mods at least once for it to generate any configuration files so.. do that!

I think I broke my config file. How can I fix it?

Simply delete the config file and launch the game with mods again, It will generate a fresh copy for you to edit.

Simple:

1. Open the profile you wish to use.
2. Click “Start modded”
3. Wait a short while until the title screen appears.
4. Play!

Do you wish to share your list of mods and the configuration tweaks you’ve done for each one without laboriously telling your friends what to do? Well here is how:

What you do:

1. Select a Profile.
2. Click on “Settings”.
3. Click on the “Profile” tab.
4. Click “Export profile as a code”.
5. Share the code with your friend; Ctrl+v.

What they do:

1. Click “Import”
2. Click “From code”
3. Enter the code provided and confirm “Import”
4. Wait for the mods and configs to download and you’re done.
5. The code will only last for an hour, if you desire to have a longer lasting way to share then use the file option instead

The code will only last for an hour, if you desire to have a longer lasting way to share then use the file option instead

Help, I’m trapped in the purgatory of this profile I selected!

Don’t worry, you change profile easily.

1. Click on “Settings”.
2. Click on the “Profile” tab.
3. Click “Change profile” and you’re free.

Dark Mode

This very bright UI hurts my eyes make it stop!

1. Select a Profile.
2. Click on “Settings”.
3. Click on the “Other” tab.
4. Click “Switch theme”.

Let me stop you right there. You will need to put an exception in for r2modman.exe with your anti-virus. If you’ve done that and are still experiencing problems then:

1. Select the Profile you’re experiencing producing problems with.
2. Click on “Settings”.
3. Click on the “Debugging” tab.
4. Click “Toggle download cache”.
5. Go back to profile selection and delete all your profiles so you can start over fresh.
6. In your first new profile repeat steps 2-3 then click “Clean mod cache”.
7. Continue as normal with installing mods.
8. If everything is now working repeat steps 2-4, the cache should be fine now.

This will likely cause problems, I highly recommend you use r2modman with a clean Risk of Rain 2 install sooo.. delete your “steamappscommonRisk of Rain 2” folder and verify your game files by:

1. Navigate to “steamappscommon”.
2. Delete your “Risk of Rain 2” folder.
3. Open Steam.
4. Click the “LIBRARY” tab.
5. Find and right click “Risk of Rain 2”.
6. Click “Properties”.
7. Click on the “LOCAL FILES” tab.
8. Click “VERIFY INTEGRITY OF GAME FILES…”.
9. Wait and you’re done, you can go back to r2modman now.

Should you run into any of the following errors:

• Unable to resolve steam install directory
• An error occurred whilst searching Steam library locations
• An error occurred whilst locating the Risk Of Rain 2 install directory from X

Then you can solves these by:

1. Select a Profile.
2. Click on “Settings”.
3. Click on the “Locations” tab.
4. Click “change ‘X’ directory” (X is the of the directory/location the error displayed(If you are unsure which one do all of the options)).
5. Navigate and manually confirm the appropriate directory.

1. Select the Profile producing this problem.
2. Click on “Settings”.
3. Click on the “Debugging” tab.
4. Click “Run preloader fix”.
5. Wait until steam has finished validation and you’re done.

Risk of Rain 2 Part 2/2

For any other errors relating to r2modman please use the #tech-support section of the Official Risk of Rain 2 Modding Discord[discord.gg]

Before you do anything check the “Configuring Mods” section; Your mod(s) may have settings you can change to solve your problems

• A clear and concise description of what you were doing and what happened. You may additionally provide a screenshot, gif or video clip if you think this will help.
• A “LogOutput.log” file:

1. Select the Profile you are experiences bugs or problems with.
2. Click on “Settings”.
3. Click on the “Debug” tab
4. Click “Copy LogOutput contents to clipboard”
5. Pasting(Ctrl+v) this directly into Discord or a .txt file then send that in Discord.

ALTERNATE METHOD:

1. Select the Profile you are experiences bugs or problems with.
2. Click on “Settings”.
3. Click on the “Locations” tab.
4. Click “Browse profile folder”
5. Navigate to “profilesXBepInEx” (X will instead be the name of your profile).
6. Drag or Copy+Paste(Ctrl+c > Ctrl+v) this into Discord.

If the files are too big for Discords 8mb limit then store the .txt/.log in a .zip archive(It is very good at compressing text file types) and send that

Once you have both of these things please use the #tech-support section of the Official Risk of Rain 2 Modding Discord[discord.gg] or and @ the developer(assuming you have a suspicion it’s their mod causing it) with these otherwise post it without the @ and wait for a helpful user to respond OR contact the mod developer directly instead.

Recommendation

I highly recommend this Risk of a Deluge Modpack, It has enough content to be equivlent to 2-3 Major Content Updates by Hopoo, The additions do not ruin the art style and themes of Risk of Rain 2. It’s Multiplayer compatible so you should have no problems playing with your friends. Balanced as everything has been carefully tweaked to respect and enhance the sandbox.