How to get and use mods - Catman-232/Homebrewery GitHub Wiki

This will be a guide on how to get r2Modman, install it, and set it up. You should use this method instead of manually installing BepInEx, there is no reason to use the manual installation method unless you are techsmart and have an actual legitimate reason to. If you just want to use mods, the mod manager can do all you need.

  1. Go to the page for r2Modman on Thunderstore: https://thunderstore.io/c/atlyss/p/ebkr/r2modman/ r2Modman's page on Thunderstore
    Click on Manual Download!
    Red circle on the Manual Download button

  2. Find the downloaded zip, open it, and double click on r2Modman-Setup-3.2.1.exe to start the installer. You don't need to unzip it, it should work anyway.
    The downloaded zip, with the installer executable highlighted

  3. When it's installed, open it and you'll be met with a list of all the games that have lists of mods on Thunderstore. Scroll down to find Atlyss or use the search bar at the top. Click on Select game, or click Set as default - which will make r2Modman skip this page next time and go straight to the profiles page.
    r2Modman games list, hovering over ATLYSS

  4. The profile selection list lets you create extra profiles in case you sometimes wanted different sets of mods, you don't need to make a profile for playing the game without mods, there is always an option to launch the game unmodded anyway! If you don't need any of that, you can just use the Default profile, click on Select profile to go to the Mods list screen. r2Modman profile list, showing Default

  5. This is where the mod manager will list what mods you have, on the left side there are the buttons to launch the game modded or vanilla, under them is this screen's button and the Online page, which is where you will find the listings from the Thunderstore website. Empty mod list screen
    Online mod list screen

    If you're looking for the goodies, click on Filter, and then toggle on Allow NSFW Filter mod categories overlay

  6. Click on a mod listing to open the side-popup for it, here you can see the info about the mod from the README, CHANGELOG and a list of the dependencies for the mod. When you click download, r2Modman will automatically also grab those dependencies for you. Looking at Homebrewery's mod info
    It will ask what version you want to download, there's rarely any reason to ever not just pick the latest version, which it will have selected by default.
    Which version to download prompt

  7. Now back on the Installed screen, you will see the mod you downloaded and its dependencies (if any). Now you can click Start modded, and launch the game! Mod list screen after downloading a mod

  8. Just before the game launches, a CMD window will appear, this is the BepInEx console log output window. Do not close it accidentally or on purpose, it is attached to the game and will force close the game when it is closed! Exceptions, errors and warnings will be logged in here to notify when things have gone wrong, or just a lot of spam of mods doing their job. The BepInEx console log window above the game loading in the background
    The contents of this output is all saved to a file called LogOutput.log, and if you have a problem with the game and/or mods, you will likely be asked to send it. I don't need to bother showing where to find it since r2Modman has a shortcut to copy the contents with Discord formatting that you can just paste as a message, so go to r2Modman's settings page, click on the Debugging tab and then click "Copy log file contents to clipboard".
    r2Modman settings page, debugging tab, hovering copy log file button

    If you post this in a Discord server that has Pawsy in it, your log file will be automatically parsed and checked for major exceptions, which can be helpful for quickly determining any issues.
    Posting the log file contents in Discord
    Pawsy responding to it