GRiMbot technical manual

This manual is the operating reference for GRiMbot and GRiMbOS. It is written for Twitch streamers who are comfortable managing OBS, browser sources, Twitch applications, plugins, local files, and network services.

GRiMbot is a self-hosted Twitch chat bot. GRiMbOS is its browser-based administration interface. The manual covers installation, Twitch authorization, stream operations, overlays, Action Chains, plugins, Chat Games, maintenance, recovery, and security.

IMPORTANT

Start with What GRiMbot does before installation. It defines the system boundaries and identifies which functions require Twitch, OBS, or a plugin.

SECURITY Never publish Twitch tokens, application secrets, configuration files, database files, diagnostic bundles, or screenshots that contain credentials. Read Security and Twitch Permissions before granting access.

Manual overview

flowchart LR
    A[Install GRiMbot] --> B[Authorize Twitch]
    B --> C[Configure GRiMbOS]
    C --> D[Connect stream services]
    D --> E[Build overlays and Action Chains]
    E --> F[Operate the stream]
    F --> G[Review status and diagnostics]
    G --> H[Back up and update]

The diagram shows the normal operating sequence. A fault may require you to move from stream operations to Connection Status, Logs and Diagnostics, Restore, or Failed Update Recovery.

Table of contents

1. Read this first

• How to use this manual
• What GRiMbot does
• What you need
• Glossary
• Limits and Compatibility

2. Install and authorize

• Setup for a Twitch stream
  • Install on Windows
  • Install on Linux
  • SETUP BOT
  • First login
  • Twitch Permissions
  • Two-PC setup
• First stream checklist

3. Learn the GRiMbOS desktop

• Basic functions
  • GRiMbOS desktop
  • System Status
  • Connection Status
  • Theme
  • Organize GRiMbar
  • Add/Remove Plugins
  • File Browser
• Live Dashboard
• Stream Setup
• Community
• Core Commands

4. Configure Twitch stream functions

• Channel Points
  • Point Redemptions
• Twitch Clips
• Calendar
• Schedule
• Ad Breaks
• Polls & Predictions
• Moderation
• Groups

5. Build media and overlays

• Overlays in OBS
• Overlay Browser
• Chat Overlay
• Media Library
  • Add Media
  • Emotes
• Bot Overlay
• Walk-On & Clip Overlay

6. Configure automation and viewer events

• Advanced features
  • Action Chains
  • Action Type Reference
  • Variables Index
  • Permissions
• Custom Commands
• Button Box
• Event Alerts
  • Event Alert Variables
  • Event Emulator
• Walk-Ons
• Shoutouts
• Walk-Ons and Shoutouts
• Custom Counters
• Custom Lists
• Bot Messages
• Opening Chat
• Lurkers, Streaks, Favorites
• Ads, polls, schedule
• Analytics and sessions

7. Install and operate plugins

• Plugins
  • How plugins work
  • Add/Remove Plugins
  • Spotify
  • OBS Integration
  • Streamer.bot
  • Voice Recognition
  • AI Integration
  • Discord
  • ATS
  • MSFS
  • StreamElements
  • PC Agent
  • Plugin Command Index

8. Operate Chat Games

• Chat Games
  • Games Integration
  • Joint Session
  • Bong Load
  • Weed Harvest
  • Extracts
  • Casino
  • Munchies

9. Maintain and recover GRiMbot

• Updating GRiMbot
• Data Files
• Back Up
• Restore
• Failed Update Recovery
• Network and Ports
• Security

10. Diagnose faults and check references

• Troubleshooting
  • System Status
  • Connection Status
  • Logs and Diagnostics
• FAQ
• Core Command Index
• Plugin Command Index
• Twitch Permissions
• Glossary

Operating sequence

Use this checklist for a new installation:

• [ ] Confirm that the host meets What you need.
• [ ] Install GRiMbot for the host operating system.
• [ ] Complete Twitch application setup and review Twitch Permissions.
• [ ] Open GRiMbOS and verify System Status.
• [ ] Verify each required service in Connection Status.
• [ ] Configure Stream Setup and Core Commands.
• [ ] Add the first overlay to OBS.
• [ ] Test with Event Emulator before a live Stream Session.
• [ ] Create a Back Up before installing plugins or applying an update.

Scope and authority

The manual describes released behavior. The Glossary controls terminology. Feature pages define configuration and operating procedures. Reference pages define commands, Variables, Action Types, permissions, files, ports, limits, and recovery steps.

When pages disagree, use this order:

1. Follow the feature page for current operating behavior.
2. Use the Glossary for exact terminology.
3. Use Troubleshooting for fault isolation.
4. Check Logs and Diagnostics before changing configuration.

Diagrams on these pages are schematic. Live GRiMbOS screenshots are omitted so this public manual never contains operator credentials, chat, or private network details. Use the tables and numbered procedures as the visual map of each window.