Documentation

NekoBot User Guide

This documentation covers the public release workflow and user-facing setup. It does not include internal implementation details.

Install NekoBot and find the local setup page.

Connect Streamer.bot, create one OBS overlay, then add text and media boxes inside it.

Create one full-scene OBS overlay with multiple triggered boxes inside it.

Connect Streamer.bot and bind triggers.

Audit reusable sources, preview media, inspect usage, and clean cached files.

Configure the app port, logging, updates, and daily log files.

Read UI option references for Overlay, Box, Add Source Dialog, Add Trigger, IF/Else, and Argument Control components.

Build common overlays such as chat text, media commands, and TTS responses.

Setup Home

The setup home is the starting point for overlay editing, Streamer.bot configuration, TTS, source management, and app settings.

PageWhen to use it

Download & InstallUse first. It explains where the release comes from, how to launch the app, and how to reach Setup Home.

Quick SetupUse after install. It walks through the first Streamer.bot bridge, OBS overlay, text box, and media box.

Landing PagesUse when you need page-level explanations for Overlay Setup, Streamer.bot Setup, TTS Setup, Manage Sources, or Settings.

ComponentsUse when you need detailed explanations of a specific UI component or dialog.

ExamplesUse when you want a recipe for a specific overlay behavior.

TroubleshootingUse when something fails to connect, render, trigger, play, or synthesize.