Getting started
Requirements
Create a game instance on Surrogate.tv
SDK installation
Method 1: installing a pre made image
Downloading and installing the image
Finding the controller setup page
Setting up the controller
Method 2: Manual installation
Setting up Raspberry Pi
Installing the required SurroRTG SDK components manually
Configuration file
Adding your controller to the game
Running a template game
Running the SurroRTG Python SDK (controller) automatically on boot
Admin Page
Game Dashboard
Status section
Game Loop
Players
Sets
Game Settings
Channel
Text elements
Game Engine
Robot Configuration
Camera and Overlay
Camera Adjustments
Overlays
In-Game configuration
Score settings
Controls
Schedule
Game Development
Game loop
Game states
on_init
on_config
on_prepare
on_pre_game
on_countdown
on_start
on_finish
on_exit
Custom game creation (IN DEVELOPMENT)
Custom game based on templates
SimpleGame template
Custom game example: LEDTestGame
Further reading
Template reference (IN DEVELOPMENT)
Ready to run examples (IN DEVELOPMENT)
Easy games to hook up
Sphero rover exploration game
Hook everything up
Create the game on Surrogate.tv
SurroRTG SDK’s setup page
Manual setup of the code
Running the LEDTestGame
Rc-Car Game
Ninswitch games
Hardware setup
Software setup
Image recognition
Creating custom image recognition
Streaming
Streamer
Audio
Enabling audio
Choosing audio capture device
Disabling asound conf generation
Audio processing
Example audio config
Troubleshooting
Custom audio configuration
Watcherstream
Default mode
OBS mode
RTSP mode
Linux
Windows
List of supported cameras
Troubleshooting
Restarting controller and streamer
Reading the logs
Most common issues
Streamer troubleshooting
Audio troubleshooting
Controller troubleshooting
SDK reference
Subpackages
surrortg.devices
Subpackages
surrortg.image_recognition
Classes
surrortg.inputs
Subpackages
Classes
surrortg.network
Classes
Classes
surrortg.config_parser
surrortg.game
surrortg.game_io
Contributing to the project
SurroRTG SDK
Docs
»
SDK reference
»
surrortg.devices
surrortg.devices
¶
Subpackages
¶
surrortg.devices.udp