Hello!

This was requested by a few people, so I decided to write up a guide on how to use the plugins I have made for Slipstream: Rogue Space. These plugins are mainly designed for streamers and Captains, but most work somewhat for even regular crew members.

This guide will be broken into a few sections, one for each plugin. But first, a section on how to get started modding Slipstream: Rogue Space.

DISCLAIMER

I am not a perfect coder, so using these plugins has a chance of making your game less stable (especially right after the game updates). If you run into any issues please reach out to the plugin’s developer directly first. (9 times out of 10 it’s something a plugin did.)

Table of Contents

How to Start Using Mods

Requirements

Steps

  1. Download Slipstream: Rogue Space on Steam. (This will not work on mobile, sorry.)
  2. Download and install r2modman
    1. Go to r2modman on Thunderstore and click Manual Download
    2. Unzip the file into a folder
    3. Inside the contents should be a Setup file, run it to begin the installation.
    4. Follow the installer’s instructions
    5. r2modman should open automatically, otherwise open it manually.
  3. Select Slipstream: Rogue Space in the Game selection screen. (Optional: Click the star to pin the game to the start of the list.)
  4. On the Profile selection screen, either create a profile or select the Default profile (What are profiles?)
  5. Read on to the sections for the plugin(s) you want to setup!
  6. Once you got all mods/plugins setup, you can launch the game with mods enabled using the Start modded button. (You’ll know if it worked if a black box with text also opens alongside the game.)
  7. Have fun!

NOTE: Mods will only be enabled when you click the Start modded button, if you launch via Steam or via Start vanilla the game will start normally without mods.

SlipChat

What SlipChat Does

SlipChat allows you to use a Elgato Stream Deck (either free app or hardware, both work!) to send pre-filled custom orders from the Helm. Those pre-filled orders also can have live game information replace certain special phrases in the message. (Examples of available information includes enemy ship intel, stats, and more!)

How to Setup SlipChat

Make sure to do the initial modding setup first.

This plugin has two components, the Slipstream plugin and the Stream Deck plugin. The Slipstream plugin is installed via r2modman, while the Stream Deck plugin is installed separately.

Slipstream Plugin

  1. In r2modman, go to the Online tap and find SlipChat.
  2. Click SlipChat once to expand the options, then click Download to install it. (Dependencies will be installed automatically.)
  3. You should now be able to see SlipChat in the Installed tab.
  4. That’s it!

Stream Deck Plugin

If you haven’t already, download the Elgato Stream Deck computer app and install it. You’ll also need the Stream Deck mobile app (iOS or Android) or a physical Stream Deck to use this plugin.

(If you are unable to use a Stream Deck, there are other ways to send the custom orders, but I won’t be covering them here. If you want to know how to do this, please reach out and I’ll explain more in detail.)

Option 1: Elgato Marketplace (preferred)

This is the preferred method of installing the Stream Deck plugin, as it will automatically update when I release new versions.

  1. Go to SlipChat’s page on the Elgato Marketplace.
  2. Click the big blue Get button. (You may be asked to log in to your Elgato account, if you don’t have one, you can create one for free.)
  3. You should be redirected to the Stream Deck app, if not click the Open Stream Deck button (or whatever looks the closest to that)

If it worked, you should see a new section in the list of available actions called SlipChat. If you don’t see it, try restarting the Stream Deck app or clicking the Open in Stream Deck button again on the marketplace website.

Option 2: Manual Install
  1. Download the SlipChat Stream Deck Plugin from the releases page. (Make sure to download the .streamDeckPlugin file, not the source code zip file.)
  2. Then, double click the .streamDeckPlugin file to install it. (Or whatever the equivalent of opening the file is on your OS.)
  3. The Stream Deck app should open automatically and ask if you want to install the plugin. Click Install to continue.

If it worked, you should see a new section in the list of available actions called SlipChat. If you don’t see it, try restarting the Stream Deck app or dragging the plugin file onto the Stream Deck app.

How to Use SlipChat

  1. Open the Stream Deck app and find the SlipChat section in the list of available actions.
  2. Drag the Send Announcement action onto one of the buttons on your Stream Deck.
  3. Click the button you just added to open the property inspector on the bottom of the app.
  4. In the property inspector, you can set the following options:
    • Title: The name of the button on your Stream Deck. (This is just for you, it won’t show up in the game.)
    • IP / Port: The IP address and port of the local server SlipChat is running on. (This should be 127.0.0.1 and 8002 by default.)
    • Message: The message you want to send to your crew. Additionally, you can use the following special phrases which will be replaced with live game information:
      • $captain: The display name of the Captain
      • $randomCrew[id]: A random crew member’s name, replace [id] to keep it consistent in the message (ex $randomCrew1)
      • $crew[id]: The crew member with that numeric id, replace [id] with a number (ex $crew0)
      • $enemyName: The name of the enemy ship (Will be blank if no fight is occurring)
      • $enemyIntel: The intel of the enemy ship (Will be blank if no fight is occurring)
      • $enemyInvaders: The invaders from the enemy ship (Will be blank if no fight is occurring)
      • $enemyThreat: The threat level of the enemy ship (Will be blank if no fight is occurring)
      • $enemySpeed: The speed of the enemy ship (Will be blank if no fight is occurring)
      • $enemyCargo: The cargo of the enemy ship (Will be blank if no fight is occurring)
      • $campaignName: The name of the campaign (ex Pluto)
      • $sectorName: The name of the sector (ex Pluto Outskirts)
      • $version: The version of SlipChat (mainly for debugging purposes, no real purpose)
  5. Once you are in-game, as either the Captain or the First Mate, and you are on the helm, you can press the button on your Stream Deck to send the custom order! If everything is working, you’ll see a green checkmark on the button when it sends successfully. If you see a yellow triangle, that means there was an error sending the order. (This is usually because you are not on the helm or the plugin is not running.)

As always if you run into any issues or have any questions, please reach out to me! I can help you troubleshoot the issue.

SlipInfo

What SlipInfo Does

On the surface, SlipInfo is a simple plugin that just makes available game state information to external programs. But it allows for a lot of cool things to be done with it! For example, I have a few browser sources on my stream that show the current ship status and crew breakdown.

How to Setup SlipInfo

If you haven’t already, do the initial modding setup first.

  1. In r2modman, go to the Online tab and find SlipInfo.
  2. Click SlipInfo once to expand the options, then click Download to install it. (Dependencies will be installed automatically.)
  3. That’s it! You should now be able to see SlipInfo in the Installed tab.

How to Use SlipInfo

On it’s own, SlipInfo doesn’t do much. But it allows other programs to access the game state information. This is done via a local web server that SlipInfo runs on port 8001 by default. (You can change this in the config file, but I wouldn’t recommend it unless you know what you are doing.)

For an example, scroll on down to the Stream Overlays section to see how to use SlipInfo with OBS Studio to create a stream overlay.

Stream Overlays

What are these Stream Overlays?

These are a few simple overlays I made to demonstrate how to use SlipInfo with OBS Browser Sources.

How to Setup Stream Overlays

Firstly make sure you have setup SlipInfo.

  1. Go to the Overlay Generator and select the overlay you want to use. (Listen I know the page is ugly, but it works.)
  2. Most of the options you can leave as their default values, but here are a few useful ones to know about:
    • Font: You can put any font you have installed on your computer.
    • Connection Method: You can change this to Example Data to see what the overlay will look like without having to run the game.
    • Random Named Checkboxes/Dropdowns: These indicate which lines of the overlay will be shown. This allows you to change how the information is laid out just by using multiple overlays.
    • Text Color / Outline Color: Set the color of the text and outline. Useful for adding contrast or if the area behind the overlay isn’t static. (You can enable the text outline using the checkbox.)
  3. Then click Generate! You should see a preview of the overlay below the button.
  4. Click Copy URL to copy the URL of the overlay to your clipboard.
  5. In your streaming software, add a new Browser Source and provide the copied URL.
  6. Resize and move it as you see fit.
  7. Repeat for any other overlays you want to use.
  8. That’s it!

SlipEvent

What SlipEvent Does

SlipEvent is a plugin that allows in-game events to be sent to external programs. The initial use case was for a Twitch chat bot to post as I play, but it’s expanded a little more since then lol.

For the instructions here I will be walking through what I have setup on my stream, which includes the following features:

How to Setup SlipEvent

Make sure to do the initial modding setup first.

  1. In r2modman, go to the Online tab and find SlipEvent.
  2. Click SlipEvent once to expand the options, then click Download to install it. (Dependencies will be installed automatically.)
  3. You should now be able to see SlipEvent in the Installed tab.

How to Setup Streamer.bot

Streamer.bot is a free stream automation tool that I use to handle all of the custom event handling. It is what connects to Twitch, YouTube, OBS, or whatever integrations you want to use.

But don’t worry too much about all the setup, I will walk you through the important parts!

  1. Download and install Streamer.bot
  2. (Optional, but recommended) Use the steps here to setup the integration with your streaming platform/software.
  3. Open Streamer.bot and go to the Servers/Clients -> HTTP Server tab.
  4. Check the Auto Start button then click Start Server (If it’s not already started, indicated by the button being greyed out.)
  5. Click the Import button and paste in the text from this page into the Import String text box. (This is the pre-configured set of events and actions for SlipEvent.)
  6. Click the Import button to import the events and actions. (You should see a success message if it worked.)
  7. The commands are disabled by default, so if you want to use them, you will need to enable them. To do so:
    1. Go to the Commands tab and find the command you want to enable. (Disabled commands will be displayed with red text.)
    2. Right click on the command and select Enabled from the context menu. It should turn black and be enabled!
  8. You can manage what happens when the events are triggered by going to the Actions tab and finding the action you want to edit. Each one should be named after the event it is associated with.
    1. You can left click on the action to display the sub-actions on the right.
    2. Right click in the empty space in Sub-Actions to add a new sub-action. (They are executed in order from top to bottom.)
    3. If you want to learn more about how to use Streamer.bot (it’s really cool!), I recommend checking out the documentation or this helpful video by nutty.

How to Use SlipEvent

As long as both the SlipEvent plugin and Streamer.bot are running, you should be able to see the events being sent to Streamer.bot.

SlipPronouns

What SlipPronouns Does

SlipPronouns is a simple plugin that adds player’s pronouns next to their name whenever possible. It uses the Twitch Chat Pronouns Extension’s API to get the pronouns. This means players may already have their pronouns set, and do not need the plugin for it to work.

How to Setup SlipPronouns

Make sure to do the initial modding setup first.

  1. In r2modman, go to the Online tab and find SlipPronouns.
  2. Click SlipPronouns once to expand the options, then click Download to install it. (Dependencies will be installed automatically.)
  3. That’s it! You should now be able to see SlipPronouns in the Installed tab.

How to Set YOUR pronouns

As a reminder, you do not need to have the SlipPronouns plugin or the browser extension installed for this to work.

  1. Go to the Twitch Chat Pronouns Extension and log in with your Twitch account.
  2. Set your pronouns and click Save.
  3. That’s it! It may take a few minutes and players using SlipPronouns will need to restart their game to see your pronouns.
  4. (Optional) If you want to see pronouns in your browser, you can install the browser extension using the browser icons on the top left of the page.

How to Use SlipPronouns

It’s automatic! As long as you have the plugin installed and enabled, it will automatically add everyone’s pronouns when possible.

Appendix

Plugins vs Mods

Technically, what I have made is called “Plugins” for a actual “Mod” called BepInEx, but most people just use them interchangeably for what I’ve made at this point. It’s fine lol.

What are profiles?

Profiles are a collection of mods/plugins and configuration files you can easily switch between.

As an example, I can have one profile for when I am streaming as a Captain, and a different one with a different set of mods/plugins when I am just joining as crew while offline. You can also share profiles with others using either a code or a file.

What is MoCore?

It’s a plugin I made that contains some code used across multiple plugins, so I don’t have to have multiple copies of the same code in each plugin. It also allows me to check the game version and make sure the plugin version is compatible with the game version. (This is important for when the game updates, as it may break the plugin if I don’t update it too.)

What is TiltiSlip?

It’s a plugin I’m working on that allows Tiltify charity donations to trigger crowd-control-like events in Slipstream. This is still a work in progress, and I plan to update this guide once it’s ready.

Can I have videos on the installation process?

Soon™