MoSadie-SlipInfo icon

SlipInfo

Local HTTP server to get game state info!

Last updated 2 weeks ago
Total downloads 59
Total rating 0 
Categories Mods
Dependency string MoSadie-SlipInfo-1.0.2
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

SlipInfo

Local API mod for Slipstream: Rogue Space. Hosts a local HTTP server you can query for information about the current game state.

Requirements

(Quick) Setup Video

(video soon!)

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 SlipInfo and click it. Then click "Download"
  5. Launch Slipstream using the "Start modded" button to generate the config file.
  6. (Optional) Modify the config file using the "Config editor" tab. (see the config file for more details)

Configuration Options

port

The port the API will listen on. Default is 8001.

prefix

The prefix for the API. Default is /slipinfo. (Ex http://localhost:8001/slipinfo/getCrew)

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

API Endpoints

GET /version

Gets the version information for the mod. Useful for testing without having to join a ship or sign in, since this works from the title screen.

Example Response
{ "version": "1.0.0.0" }

GET /getCrew

Returns a list of all crew members on the ship.

Example Response
{
    "crewList":[
        {
            "name":"MoSadie",
            "archetype":"hamster",
            "skin":"HamsterWildWest",
            "level":15,
            "xp":87661,
            "currentHealth":40.0,
            "maxHealth":40.0,
            "currentShields":0.0,
            "maxShields":40.0,
            "isCaptain":true,
            "isLocalPlayer":true
        },
        ...
    ]
}

GET /getCrewByUsername

Returns a crew member by their username.

Query Parameters

  • username (string): The username of the crew member.
Example Response
{
    "crewmate":{
        "name":"MoSadie",
        "archetype":"hamster",
        "skin":"HamsterWildWest",
        "level":15,
        "xp":87661,
        "currentHealth":40.0,
        "maxHealth":40.0,
        "currentShields":0.0,
        "maxShields":40.0,
        "isCaptain":false,
        "isLocalPlayer":true
    }
}

GET /getSelf

Returns information about the player character. Same information as /getCrewByUsername, but automatically selects the player character.

Example Response
{
    "crewmate":{
        "name":"MoSadie",
        "archetype":"turtle",
        "skin":"TurtleWildWest",
        "level":3,
        "xp":1678,
        "currentHealth":50.0,
        "maxHealth":50.0,
        "currentShields":0.0,
        "maxShields":80.0,
        "isCaptain":false,
        "isLocalPlayer":true
    }
}

GET /getShipInfo

Returns information about the ship including type, name, ship health, and fuel tanks.

Example Response
{
    "maxHealth":11800.0,
    "minHealth":1888.0,
    "currentHealth":10180.333,
    "maxFuel":16,
    "currentFuel":6,
    "currentSalvage":0, //Note this may not be accurate if you are not the captain.
    "currentGems":72
}

GET /getEnemyShipInfo

Returns information about the enemy ship, if there is one.

Example Response
{
    "enemyShip":{
        "maxHealth":10868.0,
        "minHealth":0.0,
        "currentHealth":3053.50952,
        "name":"FUEL SPEEDER",
        "invaders":"None",
        "intel":"Automated fuel supply ship. Lightly armed but built for extreme speed.",
        "threatLevel":5,
        "cargoLevel":5,
        "speedLevel":10
    }
}

GET /getRunInfo

Returns information about the current run including the current sector and region.

Example Response

Crew:

{
    "region":null,
    "regionDescription":null,
    "sector":null,
    "runId":0
}

Captain:

{
    "region":"PLUTO",
    "regionDescription":"Bleak, barren, and very cold. Two sectors, low threat; a good place to train new crew.",
    "sector":"PLUTO OUTSKIRTS",
    "runId":0
}

Between Runs:

{
    "region":"Space",
    "regionDescription":"The vast expanse of space. Perfect place to plan the next adventure!",
    "sector":"The Void",
    "runId":-1
}