MoSadie-SlipStreamerBot icon

SlipStreamerBot

Trigger Streamer.bot Actions based on in-game events!

Last updated 2 weeks ago
Total downloads 81
Total rating 0 
Categories Mods
Dependency string MoSadie-SlipStreamerBot-1.2.1
Dependants 0 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2100 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2100

README

SlipStreamer.bot

Trigger a Streamer.bot Action on in-game events!

Requirements

(Quick) Setup Video

(Updated video soon!)

Game Installation

  1. Launch Slipstream at least once.
  2. Download and setup r2modman from here (Click "Manual Download" and run the setup exe)
  3. Select Slipstream: Rogue Space from the list of games in r2modman and create a profile.
  4. In the "Online" tab look for SlipStreamer.bot and click it. Then click "Download"
  5. Launch Slipstream using the "Start modded" button to generate the config file.
  6. Modify the config file using the "Config editor" tab to match your setup. (see the config file for more details)

Streamer.bot Requirements

  1. Follow the Streamer.bot setup instructions
  2. In the "Servers/Clients" tab, under HTTP Server check "Auto Start" and click "Start Server" (making note of the IP and port)
  3. (Optional, but recommended) Click "Import" and paste the contents of ImportSlipStreamerBot.txt in the "Input String" text box and click "Import" This provices a set of premade actions for you to use. There is a dedicated action for each event type, as well as a few fun premade features such as chat polling and automatic predictions.

If you run into any issues getting this set up, please reach out! Best way is via Discord or GitHub Issues!

Events

GameLaunch

Sent when the game is launched.

Arguments:

  • eventType: "GameLaunch"

GameExit

Sent when the game is exited.

Arguments:

  • eventType: "GameExit"

JoinShip

Sent when a ship is joined.

Arguments:

  • eventType: "JoinShip"

StartFight

Sent when a fight is started.

Arguments:

  • eventType: "StartFight"
  • enemy: Name of the enemy ship.
  • invaders: Types of invading slugs.
  • intel: Available intel on the enemy ship.
  • threatLevel: Enemy threat level.
  • speedLevel: Enemy speed level.
  • cargoLevel: Enemy cargo level.

EndFight

Sent when a fight is ended.

Arguments:

  • eventType: "EndFight"
  • outcome: "NoneYet", "CaptainVictory", "CaptainDefeat", or "CaptainRetreat"

NodeChange

Sent when the ship moves to a new node.

Arguments:

  • eventType: "NodeChange"
  • isBacktrack - "True" or "False" if a backtrack.
  • scenarioKey - Unique identifier for the node's type scenario.
  • visited: "True" or "False" if the node has been visited before.
  • completed: "True" or "False" if the node has been completed before.
  • captainVictory: "True" or "False"

ChoiceAvailable

Sent when a choice is available.

Arguments:

  • eventType: "ChoiceAvailable"
  • isBacktrack - "True" or "False" if a backtrack.
  • scenarioKey - Unique identifier for the node's type scenario.
  • visited: "True" or "False" if the node has been visited before.
  • completed: "True" or "False" if the node has been completed before.
  • captainVictory: "True" or "False"
  • scenarioName: Name of the encounter
  • scenarioDescription: Description of the encounter
  • proposition: The question posed by the encounter
  • choice1: The first choice
  • choice2: The second choice

KnockedOut

Sent when you are knocked out.

Arguments:

  • eventType: "KnockedOut"
  • message: The message displayed when knocked out. Includes color information so will need parsing.

RunStarted

Sent when a run is started.

Arguments:

  • eventType: "RunStarted"
  • campaign: Counts the number of campaigns this ship has been on. (Starts at 0)
  • region: The region the ship is headed to.

RunFailed

Sent when a run is failed for any reason.

Arguments:

  • eventType: "RunFailed"

RunSucceeded

Sent when a run is succeeded.

Arguments:

  • eventType: "RunSucceeded"

NextSector

Sent when the ship moves to a new sector.

Arguments:

  • eventType: "NextSector"
  • sectorIndex: The index of the new sector.
  • sectorName: The name of the new sector.

CrewmateCreated

Sent when a crewmate joins the ship. Sent even if you join a ship with existing crewmates.

Arguments:

  • eventType: "CrewmateCreated"
  • name: The name of the crewmate. Usually their Twitch name, but they may be an Apple user.
  • id: A unique identifier for the crewmate.
  • level: Current level.
  • xp: Total XP earned, does not reset with level up.
  • archetype: The crewmate's archetype. ("cat", "hamster", "octopus", "turtle", "croc", "bear")
  • statHealth: Maximum health.
  • statShield: Maximum shield.

CrewmateRemoved

Sent when a crewmate leaves the ship.

Arguments:

  • eventType: "CrewmateRemoved"
  • name: The name of the crewmate. Usually their Twitch name, but they may be an Apple user.
  • id: A unique identifier for the crewmate.

CrewmateSwapped

Sent when a crewmate uses the Transporter station to swap archetypes.

Arguments:

  • eventType: "CrewmateSwapped"
  • name: The name of the crewmate. Usually their Twitch name, but they may be an Apple user.
  • id: A unique identifier for the crewmate.
  • level: Current level.
  • xp: Total XP earned, does not reset with level up.
  • archetype: The crewmate's archetype. ("cat", "hamster", "octopus", "turtle", "croc", "bear")
  • statHealth: Maximum health.
  • statShield: Maximum shield.