RiftBroadcast Companion - User Guide

What is RiftBroadcast Companion?

RiftBroadcast Companion is a Windows desktop application that connects your League of Legends gameplay to the RiftBroadcast streaming platform. It captures real-time game data during your matches and forwards it to RiftBroadcast servers, enabling enhanced stream overlays, statistics, and viewer interaction features.

The app runs quietly in the background and automatically detects when you're in a League of Legends game, sending live match data to power your broadcast overlays.

Key Features

• Automatic Data Capture: Connects to League of Legends in-game API and captures real-time match data
• Farsight Integration: Forwards game state to RiftBroadcast Farsight API for overlay rendering
• League Client API: Access lobby and champion select information
• Session Recording: Record and replay champion select sessions for testing
• System Tray: Runs minimized in the system tray to stay out of your way
• Multiple Server Environments: Connect to Production, Staging, or custom servers
• Persistent Settings: All configuration is saved automatically

Getting Started

Initial Setup

1. Launch the Application: Double-click the RiftBroadcast Companion icon
2. Navigate to Setup Tab: The Setup tab opens by default
3. Select Server Environment:

• Production: For live streaming (api.riftbroadcast.de)
• Staging: For testing (staging.api.riftbroadcast.de)
• Custom: For development or custom servers

1. Enter Your API Key: Paste your RiftBroadcast API key in the Bearer Token field
2. Click Save: Your settings are now stored

Using the Application

Farsight Tab - In-Game Data Forwarding

The Farsight tab controls the connection to League of Legends in-game API:

1. Start Proxy: Click the "Start Proxy" button at the bottom of the window
2. Status Indicators: Watch the status lights at the top:

• Socket: Green when connected to League of Legends
• Server: Green when forwarding to RiftBroadcast API

1. Message Counter: Shows how many game events have been captured
2. Console Output: View live logs of captured data

Advanced Settings (usually don't need to be changed):

• Host/Port: League of Legends API endpoint (default: localhost:58869)
• WebSocket Route: API path (default: /ws/in)
• Reconnect Delay: Time before reconnection attempts
• Forwarding Delay: Optional delay for message forwarding

League Client API Tab - Lobby & Champion Select

The LCU tab provides access to League Client data:

1. Connect Client: Click "Connect" to link with your League Client

• The client must be running first

1. Available Modules: Start specific modules to capture:

• Lobby: Pre-game lobby information
• Champ Select: Champion select phase data

1. Recording Features:

• Start Recording: Record a champion select session
• Stop Recording: Saves to your user data folder
• Browse: Select a recording file
• Replay: Play back a recorded session for testing
• Stop Replay: Interrupt an active playback

1. Connect to Server: Click "Connect to Server" at the bottom to forward LCU data to RiftBroadcast

Understanding Status Indicators

Farsight Status

• Server (Red/Green): Connection to RiftBroadcast API
• Socket (Red/Green): Connection to League of Legends game

LCU Status

• Server (Red/Green): Connection to RiftBroadcast for LCU data
• Client (Red/Green): Connection to League of Legends Client

Green = Connected and working

Red = Disconnected

Yellow/Pulsing = Connecting or reconnecting

Common Workflows

For Streaming

1. Open RiftBroadcast Companion
2. Verify your API key is entered (Setup tab)
3. Click "Start Proxy" (bottom button)
4. Launch League of Legends
5. Start a game - data automatically forwards
6. Minimize the app (runs in system tray)

For Testing Overlays

1. Use the LCU tab to record a champion select session
2. Stop recording after the session
3. Use the Browse button to find the recording
4. Click Replay to test your overlays without being in a real game
5. Click Stop to interrupt the replay

Troubleshooting

No data being captured:

• Ensure you're in an active League of Legends game (not lobby)
• Check that "Start Proxy" button shows "Stop Proxy" (indicating it's running)
• Verify Socket indicator is green

Server connection fails:

• Check your API key is correct
• Verify you selected the right server environment
• Check your internet connection

League Client not connecting:

• Launch League of Legends client first
• Click the Connect button in the LCU tab
• Check that the Client indicator turns green

App disappeared:

• Check your system tray (bottom-right corner of Windows taskbar)
• Click the RiftBroadcast icon to restore the window

System Requirements

• Windows 10 or later
• League of Legends installed
• Active internet connection for API forwarding
• RiftBroadcast API key (obtain from RiftBroadcast platform)

Privacy & Data

RiftBroadcast Companion only captures:

• In-game match data (kills, deaths, assists, items, etc.)
• Champion select information (when LCU is connected)
• No personal information beyond what's visible in-game
• Data is only sent to servers you explicitly connect to

All settings and recordings are stored locally on your computer in:

%APPDATA%/RiftBroadcast Companion/

Support

For issues, questions, or feature requests:

• Join our Discord community for live support and discussions
• Visit the documentation at riftbroadcast.de