RimWorld

RimWorld

41 ratings
Puppeteer
4
2
2
   
Award
Favorite
Favorited
Unfavorite
Mod, 1.3, 1.4
File Size
Posted
Updated
4.668 MB
Sep 5, 2021 @ 10:37pm
Oct 30 @ 7:15pm
5 Change Notes ( view )

Subscribe to download
Puppeteer

Description
Mod originally created by Brrainz

Puppeteer allows RimWorld players to give others control over a colonist. It's completely web-based and does not use things like Twitch chat to do so. As a gamer you install the mod and follow the instructions below to pair your game to your Twitch identity. Then you publish your game and as soon as you are in a game, your viewers will see you in the Lobby. You can now assign colonists to viewers that are waiting for assignment.

As a Twitch viewer, you can open your browser (or mobile phone) to wait until a streamer starts a published game and when you get assigned, you can see all the colonist stats and control your character. The one playing the game can restrict remote controlled colonists from doing bad things and every action is logged in the combat log of the colonist.

For Streamers

    First Time Set-up
  • Install the mod by subscribing to it on this page
  • Start your game and open a web browser at https://pupp3t.live
  • Use the Twitch button to log in
  • After logging in, go to Settings -> Streamer and create a game token
  • Download the game token and put the file in:
      AppData\LocalLow\Ludeon Studios\RimWorld by Ludeon Studios\Config
  • Now you can configure your listing under Stream Information and put your game online

    During Gameplay
  • As viewers connect through the website, you can assign existing pawns to them by
    • (in-game) Right clicking on the colonist in the colonist bar
    • (website) Using the last section on the page
  • Or create a new pawn for them by using the [+] button in the top right corner of the screen
      Creating a pawn this way supports Prepare Carefully and you can even give new colonists weapons to start with if you like
  • There is also a connection meter in the upper right corner which shows you the load on your connection to the server (should normally stay at 0ms)

For Viewers

  • Open a web browser at https://pupp3t.live
  • Use the Twitch button to log in
  • After logging in, wait in the Lobby until a streamer has made their game available, then select it
  • When the streamer sees that you are in the game and available, he/she might assign a colonist to you
  • Once assigned the colonists data will appear and some commands are already enabled

Respawning

Puppeteer has a respawn system that makes deaths caused by viewer interactions less fatal.
If you place a respawn portal in your base, colonists that satisfy the following conditions will respawn with their apparel and fully healed.

Tickets
  • Tickets are given at start of a NEW game
    • EXISTING games will get the tickets the first time you load them with Puppeteer
    • The amount of given tickets is defined in the Puppeteer settings
  • A respawn consumes a ticket
  • Selecting the portal shows the remaining tickets in the lower left corner
  • Zero tickets remaining means all deaths are permanent

Deaths
  • A death that is caused by a viewer will be compensated by a respawn
  • A death caused by the streamer/player will be permanent
  • Any interaction of the streamer/player with the colonist will start a cooldown (blue bar)
  • During the cooldown, a death is considered the fault of the streamer/player
  • The cooldown time can be set in the Puppeteer settings

Portal
  • You can have zero or one portal per map
  • Placing a portal starts a cooldown
  • Removing the portal is only possible after the cooldown to prevent you from moving the portal too quickly
  • Without portal, deaths are permanent

Issues
If you have any specific issues with either the website or the mod, you can submit an issue on Github:
Puppeteer Mod (for streamers)[github.com]
Puppeteer Website (for viewers and streamers)[github.com]

Incompatible Mods

Some known Issues
  • Pawns sometimes turn invisible
  • Toolkit integration is not always functional (viewers sometimes are not able to use the TT tab in Puppet) Fixed! Thanks saschahi
< >
31 Comments
Switch Nov 20 @ 6:53pm 
Makes pawns invisible.
Switch Nov 20 @ 6:52pm 
Incompatible with new updated combat extended.
Captolamia Nov 3 @ 12:53pm 
Getting disconnected a lot.

11/3/2022 12:21:14 PM|Error|WebSocket.SendAsync|This operation isn't available in: connecting
11/3/2022 12:21:14 PM|Error|WebSocket.error|System.NullReferenceException: Object reference not set to an instance of an object
at Puppeteer.Connection.Ws_OnError (System.Object sender, WebSocketSharp.ErrorEventArgs e) [0x00006] in <898a2c7604cf48de9cc6819635590128>:0
at WebSocketSharp.Ext.Emit[TEventArgs] (System.EventHandler`1[TEventArgs] eventHandler, System.Object sender, TEventArgs e) [0x00009] in <38d3cef14c5a4fc9a92de0991034bc1a>:0
at WebSocketSharp.WebSocket.error (System.String message, System.Exception exception) [0x00010] in <38d3cef14c5a4fc9a92de0991034bc1a>:0
Chmerity Oct 31 @ 10:04am 
Absolute legend BleuSquid, thanks for the 1.4 lovetap!
BleuSquid  [author] Oct 20 @ 7:30pm 
1.4 update is in progress. I've been slightly held back since the 1.4-unstable preview has been removed from Steam, and I had temporarily rolled back to 1.3 to test something.
Dimitrion Jul 14 @ 11:20am 
as of today i get error map loading, if i disable puppet it works again i can send you the mods i have in discord
Captolamia Jul 14 @ 8:02am 
A log of what players do would be nice and the option to turn it off.
BleuSquid  [author] Jun 10 @ 5:09pm 
@Pullle - TTV No incompatibility, as far as I'm aware. I use that mod regularly myself. However, Better Loading does report a harmless red error if you have Puppet, but do not have TwitchToolkit. I spent a fair amount of time trying to fix this, and I thought I had, but I instead it wouldn't work *with* TTK. My previous 2 comments were related to this issue.

The error is because Puppet is looking to determine if the TTK mod is also loaded. If it finds it, everything works, but if it's not there, we get an error for a missing chunk of code. Normally this is bad, and RW treats it as a loading error, hence the red warning. Since Puppet knows that what its looking for something that might be missing, it just makes a note of that fact, and carries on with what it's doing.
Pullle - TTV Jun 8 @ 3:48am 
Is there any known incompatibility with "Better Loading"?