Automatic streaming to twitch.tv via OBS [x86]

parasven

Since i stream games to twitch from time to time i wanted a easy and convinient way to stream off my Retropie rig.
So i came up with a solution that uses obs-studio to automatically stream to twitch.tv.

What it does:

Automatically stream to twicht.tv based on the chosen emulator
Automatically set the streaming title and game to the game that is being launched.
Custom streamtitle per game.

Requirements:

Ubuntu x86 with Retropie installed.
Beefy rig that can handle the desired encode of the stream.
PPA Repo of OBS: https://launchpad.net/~obsproject/+archive/ubuntu/obs-studio
curl, iconv, uchardet
ClientID and Accesstoken for twitch.tv

Installing OBS-Studio:

Follow the instuctions on https://launchpad.net/~obsproject/+archive/ubuntu/obs-studio to install the repository.
Install OBS with "sudo apt-get install obs-studio"

Now you will need to configure OBS itself so it captures the windows you want to stream (retroarch, dolphin or what ever you want to broadcast) and of course fill in in your twitch account and the broadcastsetting(bitrate and so on).
There are plenty of guides out there for OBS so i will not go into details here.

Modify your emulators.cfg
You will need to modify your emulators.cfg so that the script actually triggers.

Example: If you want to stream Super Nintendo

Edit the following file:
/opt/retropie/configs/snes/emulators.cfg

lr-snes9x2010 = "/opt/retropie/emulators/retroarch/bin/retroarch -L /opt/retropie/libretrocores/lr-snes9x2010/snes9x2010_libretro.so --config /opt/retropie/configs/snes/retroarch.cfg %ROM%"
default = "lr-snes9x2010"

to

lr-snes9x2010 = "/opt/retropie/emulators/retroarch/bin/retroarch -L /opt/retropie/libretrocores/lr-snes9x2010/snes9x2010_libretro.so --config /opt/retropie/configs/snes/retroarch.cfg %ROM%"
lr-snes9x2010-record-twitch = "/opt/retropie/emulators/retroarch/bin/retroarch -L /opt/retropie/libretrocores/lr-snes9x2010/snes9x2010_libretro.so --config /opt/retropie/configs/snes/retroarch.cfg %ROM%"
default = "lr-snes9x2010"

After that you will have a new emulator to chose from within runcommand. If you chose "lr-snes9x2010-record-twitch" as default the script will trigger an start streaming.

Get Your ClientID and Accesstoken:

Got to the following website: https://dev twitch tv/dashboard/apps/create and login with your twitch account.
Fill in a name for App you want to register, set the RedirectURL to: https://twitchapps.com/tokengen and set the category to "Application Integeration"
To receive your ClientID click on the newly created App.
Got to https://twitchapps.com/tokengen and fill in your ClientID. Choose "channel_editor" as scope so the titleupdater can edit the channel metadata of your channel.
Copy your accestoken from the following page.

Note:
Keep these secret so no one can mess with your channel.

Create: /opt/Retropie_repos/streaming-games/update_channel_twitch.sh
You will need to fill in the CLIENTID and ACCESSTOKEN from the previous step.
This script will handle the automatic updating of your twitch.tv channel.

The default streamingtitle will be: "Retrogaming! Playing <GAME> on <SYSTEM>" where <GAME> and <SYSTEM> will be replaced with the correct values on the fly.
Additionally you can create the folder "custom_streaming_status" under the systems config directory and place txt file for custom streamingtitles.

Lets say you want to stream: Final Fantasy 6 on Super Nintendo with a custom streamtitle

Create the folder: /opt/retropie/configs/snes/custom_streaming_status
Create a .txt in that folder so it corresponds to the rom name. Example: finalfantasy6.smc -> finalfantasy6.txt
Fill in your custom streamtitle in your newly create txt file.
- You can use $SYSTEM_NAME $GAME in your streamtitle and they will get replaced with correct values on the fly.
- $SYSTEM_NAME = Corresponds to the system your a launching. (Super Nintendo Entertainment System in this case)
- $GAME = Corresponds to the game your are launching. The name will be retrieved from the gamelist.xml
The script should now find your txt file and use it to set the title accordingly.

update_channel_twitch.sh

#!/bin/bash

## Twitch Clientid, need to be generated for the app
CLIENTID="<Your Client-ID>"
## Accesstoken for this app.
ACCESSTOKEN="<Your Accesstoken>"
## System from runcommandvariable
SYSTEM="$2"
## Gamename from runcommandvariable
GAME="$1"
## Full romname without extension.
FULL_ROMNAME="$3"
## Set SYSTEM_NAME to nothing
SYSTEM_NAME=""
## Path to the custom Channel description files
CHANNEL_STATUS_CUSTOM_PATH="/opt/retropie/configs/$SYSTEM/custom_streaming_status"


## Set a Nice systemname based on the passed variable $SYSTEM from runcommand
case "$SYSTEM" in
        amstradcpc)
                SYSTEM_NAME="Amstrad CPC"
                ;;
        arcade)
                SYSTEM_NAME="Arcade"
                ;;
        atari2600)
                SYSTEM_NAME="Atari 2600"
                ;;
        atari7800)
                SYSTEM_NAME="Atari 7800"
                ;;
        atarilynx)
                SYSTEM_NAME="Atari Lynx"
                ;;
        dreamcast)
                SYSTEM_NAME="Sega Dreamcast"
                ;;
        fba)
                SYSTEM_NAME="FinalBurn Alpha"
                ;;
        fds)
                SYSTEM_NAME="Famicom Disk System"
                ;;
        gamegear)
                SYSTEM_NAME="Sega Game Gear"
                ;;
        gb)
                SYSTEM_NAME="Nintendo Game Boy"
                ;;
        gba)
                SYSTEM_NAME="Nintendo Game Boy Advance"
                ;;
        gbc)
                SYSTEM_NAME="Nintendo Game Boy Color"
                ;;
        gc)
                SYSTEM_NAME="Nintendo GameCube"
                ;;
        mame-libretro)
                SYSTEM_NAME="MAME"
                ;;
        mame-mame4all)
                SYSTEM_NAME="MAME"
                ;;
        mastersystem)
                SYSTEM_NAME="Sega Master System"
                ;;
        megadrive)
                SYSTEM_NAME="Sega MegaDrive"
                ;;
        msx)
                SYSTEM_NAME="MSX"
                ;;
        n64)
                SYSTEM_NAME="Nintendo 64"
                ;;
        neogeo)
                SYSTEM_NAME="Neo Geo"
                ;;
        nes)
                SYSTEM_NAME="Nintendo Entertainment System"
                ;;
        ngp)
                SYSTEM_NAME="Neo Geo Pocket"
                ;;
        ngpc)
                SYSTEM_NAME="Neo Geo Pocket Color"
                ;;
        pcengine)
                SYSTEM_NAME="PC Engine"
                ;;
        ps2)
                SYSTEM_NAME="Sony Playstation 2"
                ;;
        psp)
                SYSTEM_NAME="Sony Playstation Portable"
                ;;
        psx)
                SYSTEM_NAME="Sony Playstation"
                ;;
        saturn)
                SYSTEM_NAME="Sega Saturn"
                ;;
        sega32x)
                SYSTEM_NAME="Sega 32X"
                ;;
        segacd)
                SYSTEM_NAME="Sega CD"
                ;;
        sg-1000)
                SYSTEM_NAME="Sega SG-1000"
                ;;
        snes)
                SYSTEM_NAME="Super Nintendo Entertainment System"
                ;;
        vectrex)
                SYSTEM_NAME="Vectrex"
                ;;
        wii)
                SYSTEM_NAME="Nintendo Wii"
                ;;
        zxspectrum)
                SYSTEM_NAME="ZX Spectrum"
                ;;
esac

## Check for existing custom channel description and use it instead of the default Channel description.
if [[ -e "$CHANNEL_STATUS_CUSTOM_PATH/$FULL_ROMNAME.txt" ]]
then
        ## Clean up the variables, exchange some stuff and convert the text to utf-8
        file_encoding="$(file --mime-encoding "$CHANNEL_STATUS_CUSTOM_PATH/$FULL_ROMNAME.txt" | rev | awk '{printf $1}' | rev)"

        ## if the encoding is unknown, try again with uchardet
        if [[ $file_encoding == *unknown* ]]
        then
                file_encoding=$(uchardet "$CHANNEL_STATUS_CUSTOM_PATH/$FULL_ROMNAME.txt")
        fi

        CHANNEL_DESC=$(cat "$CHANNEL_STATUS_CUSTOM_PATH/$FULL_ROMNAME.txt" | iconv -f "$file_encoding" -t utf-8)
        CHANNEL_DESC=${CHANNEL_DESC//'$GAME'/"$GAME"}
        CHANNEL_DESC=${CHANNEL_DESC//'$SYSTEM_NAME'/"$SYSTEM_NAME"}
        CHANNEL_DESC=${CHANNEL_DESC//' '/'+'}

        #### Update Channel
        curl \
        -H 'Accept: application/vnd.twitchtv.v5+json' \
        -H "Authorization: OAuth $ACCESSTOKEN" \
        -H "Client-ID: $CLIENTID" \
        -d "channel[status]=$CHANNEL_DESC&channel[game]=$GAME" \
        -X PUT https://api./channel
else
        #### Update Channel
        curl \
        -H 'Accept: application/vnd.twitchtv.v5+json' \
        -H "Authorization: OAuth $ACCESSTOKEN" \
        -H "Client-ID: $CLIENTID" \
		-d "channel[status]=Retrogaming!+Playing+$GAME+on+$SYSTEM_NAME&channel[game]=$GAME" \
        -X PUT https://api./channel
fi

Modify /opt/retropie/configs/all/runcommand-onstart.sh:
Add the Snipped below to your runcommand-onstart.sh this will make sure to start OBS automatically when an emulator with the suffix "-record-twitch" is being launched.
It will also retrieve the name of the game from gamelist.xml for later use with the Channelupdatescript.

# get the full path filename of the ROM
rom=$3
# rom_bn receives $rom excluding everything from the first char to the last slash '/'
rom_with_extension="${rom##*/}"
# rom_bn receives $rom_bn excluding everything from the last char to the first dot '.'
rom_without_extension="${rom_with_extension%.*}"
# get the system name
system=$1
# Fullpath to gamelist.xml
gamelist_path="/opt/retropie/configs/all/emulationstation/gamelists/$system/gamelist.xml"
# Get nice Gamename from gamelist.xml
gamename=$(grep -F -R -A1 "$rom_with_extension" "$gamelist_path" | tail -n1 | cut -d">" -f2 | cut -d"<" -f1)



############## Snippet for Streaming ##############
## Check the default emulator for twitch suffix. If found the system is gonna start OBS and start the stream. Additionally the stream Title and Game is set via the script "update_channel_twitch.sh"
if [[ $(cat /opt/retropie/configs/$system/emulators.cfg | grep "default" | grep "\-record\-twitch") ]]
then
		## Set the Twitch channel name and Game
        /opt/Retropie_repos/streaming-games/update_channel_twitch.sh "$gamename" "$system" "$rom_without_extension"

        ## New way to start the stream automatically?
        obs --startstreaming &>/dev/null &
fi
##############

Note:
Modify "/opt/Retropie_repos/streaming-games/update_channel_twitch.sh" to where you have created the updatescript.

Modify:/opt/retropie/configs/all/runcommand-onend.sh
This will make sure that OBS gets closed after you stop playing the game.

############## Snippet for streaming stop ##############
### Only kill OBS if it is actually running
if [[ $(pgrep -c obs) > 0 ]]
then
        ### Kill Open Broadcaster after stopping the Stream
        kill $(pgrep obs)
fi
##############