Skip to main content

Documentation Index

Fetch the complete documentation index at: https://teambattles.gg/docs/llms.txt

Use this file to discover all available pages before exploring further.

Show your TeamBattles stats on stream with real-time overlays. Display wins, losses, streaks, active match scores, leaderboard rankings, and more - all updated automatically as you play.

​
Features

7+ Widgets

User stats, team stats, org stats, active match, leaderboard rank, top players, referral code, and game-specific rank widgets

Visual Editor

Drag-and-drop canvas editor to position and style your widgets

3 Style Types

Rounded, Angular/HUD, and Minimal styles - mix and match per widget

Real-Time Updates

Stats refresh automatically so your overlay always shows current data

Transparent Background

Designed for OBS Browser Sources with full transparency support

No API Key

Overlay URLs are public - paste into OBS and go. User widgets require your profile be non-private.

​
Quick Start

1

Open the editor

Navigate to /overlay/editor and sign in
2

Configure your overlay

Toggle on widgets, drag them into position, and customize the style
3

Add to OBS

Copy the overlay URL and add it as a Browser Source in OBS - no API key required
For detailed instructions, see the Setup Guide.

​
Supported Streaming Software

The overlay works as a browser source in any streaming software that supports web URLs:
  • OBS Studio - The most popular open-source option
  • Streamlabs Desktop - OBS-based with built-in alerts and themes
  • XSplit Broadcaster - Professional streaming and recording
  • Meld Studio - Modern OBS alternative built by streamers
  • Prism Live Studio - Desktop and mobile streaming
  • TikTok LIVE Studio - Uses a “Link” source type instead of “Browser Source”
See the Setup Guide for step-by-step instructions for each platform.

​
Simple Overlay

Want to get started without creating an account? The Simple Overlay lets you display a game rank widget on stream with no login required. Just select your game, enter your details, and copy the URL. Try the Simple Overlay

​
OBS Dock

OBS Studio users can manage their overlay directly from within OBS using the Battles Overlay Dock. Configure widgets, connect via WebSocket, and add or remove overlay sources without leaving OBS. Learn more about the OBS Dock

​
Learn More

Setup Guide

Step-by-step instructions for getting your overlay into OBS

Simple Overlay

No-account overlay for quick game rank display

OBS Dock

Manage your overlay directly from inside OBS Studio

Widget Reference

Detailed info on all 7 overlay widgets

Editor Guide

How to use the visual editor to customize your overlay

Visibility & Privacy

Public URLs explained and how profile visibility affects widgets

Troubleshooting

Common issues and solutions