Spireside Together - A public multiplayer server browser

The most up to date source of truth:
https://github.com/omgyukiel/spireside-together
This mod is on nexus for accessibility, but may be deprecated in the future.

NOTE: Public lobbies can only be created and discovered by those with this mod or similar.

Description

Spireside Together is a Slay the Spire 2 mod that enables public multiplayer with strangers by enabling hosts to create public lobbies and guests to search with a server browser.

Features

This mod adds a server browser that can search up to 100 public lobbies with filtering by hostname, description, or game version.

Hosts can create public lobbies from the Spireside Together Multiplayer menu and copy their lobby ids.

Guests can join directly by lobby ids or connect to lobbies found in the server browser.

Known Issue: Currently there is no support for reconnects when a player disconnects. This may unfortunately hang the game.

Dependencies

This mod inherits from BaseLib and depends on lemonSpire2 for chat support:
- BaseLib-StS2 = v3.1.4
- lemonspire2 = v0.7.4
- Slay the Spire 2 >= v0.105.0 (Currently on beta branch)

Compatibility

You cannot join lobbies with conflicting base game versions.

To reduce the risk of error, you must use the exact mod versions listed and follow the exact install steps to guarantee compatibility. Mismatched mods and mod versions can cause the game to hang on black screens.

It may be possible that truly client-side only mods could work but this behavior is untested.

Installation

0. Review the compatibility section of this README
To guarantee compatibility, players must use the same mods and mod versions. Difference in mod versions that result in gameplay changes will causes the game to hang on a black screen when connecting.

If you already have mods, I suggest backing them up somewhere for public multiplayer.

1. Download dependencies
This mod uses lemonSpire2 for chat, and inherits from BaseLib. Install the EXACT versions listed

1. Download lemonSpire2 and BaseLib zip files from github (recommended) or nexusmods. If using nexus, ensure the right folders are selected
2. Extract the zip folders into the mods folder at your STS2 install location: `*\steamapps\common\Slay the Spire 2\mods` i.. You can find your install folder by right clicking STS2 in your Steam library, clicking properties, then click "Browse" in "Installed Files. You may need to create the "mods" folder if it does not exist yet

BaseLib-StS2 v3.1.4
github 
nexus

lemonSpire2 v0.7.4
github
nexus
2. Remove RitsuLib from lemonSpire2
We will remove RitsuLib to reduce the chance that players have different mod versions. LemonSpire2 v0.7.4 loosely depends on RitsuLib and removing it will remove the mod config feature.

1. Delete RitsuLib from the mods folder if you downloaded it already
2. Open the `lemonSpire2.json` in your `mods/lemonSpire2`

Remove RitsuLib from dependencies or replace it with the following block and save the file. `lemonSpire2.json` should look like this:
{
  "id": "lemonSpire2",
  "name": "Lemon Spire 2",
  "author": "freude916",
  "description": "A collection of multiplayer QoL: Chat, State, Damage Tracker",
  "version": "v0.7.4",
  "has_pck": true,
  "has_dll": true,
  "dependencies": [],
  "affects_gameplay": true,
  "min_game_version": "0.105.0"
}3. Download spireside-together

1. Download the zip folder in the nexus mods downloads or (preferred) via the latest release on github
2. Extract the zip folder to your mods folder in your *\steamapps\common\Slay the Spire 2\mods
3. Launch the game and you should see a new menu option!   i. If this is your first time using mods your game may shutdown on the first launch

4. (Optional) Sync vanilla saves with modded
If this is your first time using mods you may think you have corrupted your saves files, but STS2 just points to a different folder for modded play throughs!

You can find mods to sync vanilla gamess like (https://www.nexusmods.com/slaythespire2/mods/372) or manually copy your vanilla saves to your modded by doing the following:

1. Open STS2
2. Open the console by pressing the `~` key
3. Type `open saves` and press enter
4. You should see a folder like `C:\...\SlayTheSpire2\steam\{your_id}\modded\profile1\saves`
5. Go up a few paths until you're out of the "modded" folder. You should see three profiles, copy your desired profile into the modded folder to replace the existing one.