Repository navigation
Before You Begin
Your goal for the first session is simple: start TDSBLive, open its editor, connect the chat service you use, and see a message. You do not have to set up speech, money tracking, custom code or network sharing on the first day.
TDSBLive combines incoming information and creates the web pages that show your chat and overlays. It runs in the background on your computer. Its editor is a page you open in a browser, rather than a separate desktop editing window.
Streamer.bot connects to supported streaming accounts and runs actions you configure. TDSBLive can connect to its WebSocket server. A WebSocket is simply a connection that stays open so new messages can arrive promptly.
Speaker.bot reads text aloud. It is optional. You can set up chat and graphics before setting up speech.
OBS Studio creates your broadcast. Its Browser Source displays a TDSBLive web page inside your video. A dock is a panel you read inside OBS; a dock does not automatically appear in the broadcast.
You can think of the arrangement as a short journey: your connected service receives a message, TDSBLive prepares the display, and OBS shows the display to viewers.
Download the version you want from GitHub Releases. Choose the application installer or ZIP, and read that version's release notes.
v1.0.1 includes the adaptive workspace, guided triggers and conditional alert designs, advanced arrangement, custom widgets, portable packages, limited local StreamElements compatibility and Windows/native Linux tray controls. There is no separate published v1.0.0 download to find.
The older v0.1.0 MVP has basic chat, overlays, totals, automation and recovery. It predates the newer interface in these chapters. Use 1.0.1 to follow the current guide, or use the guide bundled with your older version. The tray guide explains how to find and stop the app.
The guide bundled with your download belongs to that build. The online wiki can contain newer instructions. If a control is missing, check your version before changing your saved setup.
Build artifacts from this project's GitHub Actions are separate from published releases. Use only a successful, reviewed run for the intended source revision, keep a backup and do not use downloads from unrelated forks or failed runs.
For a ZIP installation, create an ordinary local folder such as C:\Apps\TDSBLive on Windows or ~/Applications/TDSBLive on Linux. Avoid putting the running application in a cloud-synced folder. Extract the complete download there.
Make a separate backup folder. A second drive is useful if available. A backup beside the application helps with an accidental edit, but it will not help if that whole drive fails.
TDSBLive's normal application data is separate from its program files. On Windows it is under %LOCALAPPDATA%\TDSBLive. On Linux it is normally inside the Wine or Proton prefix. Moving the program folder alone does not move all your saved data.
- A 64-bit Windows installation, or a Linux system with a suitable Windows compatibility setup.
- A web browser. The local editor does not require an online browser account.
- OBS if you want to show pages on stream.
- Streamer.bot if you want its supported chat connections or actions.
- Speaker.bot only if you want speech through that service.
- The accounts you intend to connect, and their official sign-in instructions.
TDSBLive's Windows package includes its .NET runtime. You do not need to install .NET separately just to launch that package. Other programs, including Streamer.bot and Speaker.bot under Wine, have their own requirements.
A password, access token or private Rumble API URL can let someone use a connection as you. Do not paste it into screenshots, a public issue, a widget package or chat. The private Rumble URL is not your broadcast stream key.
Local pages use HTTP. You do not need an HTTPS certificate for normal use on the same computer. Keep access local while learning. Network sharing is a separate, optional setup.