| Name | Modified | Size | Downloads / Week |
|---|---|---|---|
| nuclearthronestreamer.py | 2021-03-02 | 14.1 kB | |
| bugs.md | 2021-02-27 | 653 Bytes | |
| README.md | 2020-12-07 | 2.5 kB | |
| Totals: 3 Items | 17.2 kB | 0 |
README
NuclearThroneStreamer is a tiny multi-platform tool that is used to show current game stats while you play the Steam version of Nuclear Throne. This is useful for streamers who need to fill in the border space in the game. It does this by using the stream key function of the game. Every 15 seconds, the game will send information to a website, which this tool then downloads, parses and outputs to a file. OBS can then be configured to read this file and show the text on screen.
Setup instructions
- Install the latest Python 3 from https://www.python.org if you don't already have it.
- Run NuclearThroneStreamer.py from this site.
- Windows users can rename NuclearThroneStreamer.py to NuclearThroneStreamer.pyw to hide the command prompt window.
- OSX users have to right click on the file, go to Open With, then select Python Launcher. OSX ships with a broken Python, you must install a new Python.
- Linux users chmod +x NuclearThroneStreamer.py ; ./NuclearThroneStreamer.py.
- Enter your Steam64id. There are websites that can find this for you, or you can use the instructions here: https://nodecraft.com/support/games/sevendaystodie/how-to-quickly-find-steam-id-numbers
- Enter your Stream Key. This can be obtained by opening up the game, going to Settings, Game, Stream Key.
- Click the Text Output button to pick a file to output the text to.
- Add a new text source in OBS to read the outputted file.
- Enable Stream Key in the game each time you play by going to Settings, Game, Stream Key.
- Click the red Stopped button at the top to start it, start a game and you're good to go!
Customizing Output
Feel free to rename the guns and crowns listed, but changing the order of them will cause the wrong items to be reported. If you want to change the text output, currently the only way to do that is to modify the code in the getTextOut() function. I can help you do this if you want, just contact me by opening a ticket on this site. For more information on the stream key functionality and what information you can get from it, see https://nuclear-throne.fandom.com/wiki/Stream_Keys
Uninstallation
To uninstall this script, uninstall Python if you no longer want it, delete this script and then delete the configuration file that this script created:
- Windows: %APPDATA%\NuclearThroneStreamer.json
- Linux: ~/.config/NuclearThroneStreamer.json
- OSX: ~/Library/Application Support/NuclearThroneStreamer.json
