How to use this manual

This manual is organized by operator task. Use the sequence pages for installation and first use. Use the feature pages while configuring GRiMbOS. Use the reference and diagnostic pages when you need an exact command, Variable, permission, file location, or fault-isolation procedure.

Choose the right section

If you need to	Start with	Continue with
Understand system boundaries	What GRiMbot does	Limits and Compatibility
Prepare a host	What you need	Install on Windows or Install on Linux
Connect a Twitch channel	Setup for a Twitch stream	Twitch Permissions
Prepare OBS	Overlays in OBS	Overlay Browser
Configure routine stream operations	Basic functions	Live Dashboard
Build an automation	Action Chains	Action Type Reference
Configure a Twitch event response	Event Alerts	Event Alert Variables
Install an optional function	Plugins	Add/Remove Plugins
Configure a Chat Game	Chat Games	The page for that Chat Game
Investigate a fault	Troubleshooting	Logs and Diagnostics
Protect or recover the installation	Back Up	Restore

Page types

The manual uses four page types.

Page type	Purpose	Typical content
Procedure	Complete a defined task	Prerequisites, ordered steps, verification, rollback
Feature	Configure and operate one GRiMbOS function	Scope, settings, operating procedure, failure states
Reference	Look up exact values	Commands, Variables, Action Types, permissions, ports
Diagnosis	Isolate and correct a fault	Symptoms, checks, evidence, corrective action

Read a procedure from the start. Feature pages may assume that installation and Twitch authorization already work. Reference pages are lookup material and do not replace the setup sequence.

Reading conventions

The manual uses consistent visual cues.

Cue	Meaning
`Code text`	A command, file name, path, setting value, or literal text
Bold text	A GRiMbOS window, button, field, menu item, or status
Checklist	A set of conditions to verify
Numbered list	Steps that must run in order
Table	Settings, choices, expected results, or reference data
Link	A related procedure or reference page

Callouts mark operational concerns.

IMPORTANT
The step affects whether the procedure succeeds or whether GRiMbot remains available.

SECURITY The step concerns credentials, permissions, network exposure, personal data, or diagnostic output.

NOTE The information clarifies behavior or points to a related task.

Terminology

Use the names shown in GRiMbOS and the Glossary. Exact names matter when one feature contains several related concepts.

Examples include:

A Chat Message is one message sent by a user in chat.
A Custom Command matches a Chat Message and runs an Action Chain.
A Voice Command matches transcribed text from Voice Recognition.
Match Mode controls where command text or a Phrase must appear.
Cooldown prevents immediate repeats.
Delay waits before the next action runs when Run Actions is set to In order.
XP determines Player Level.
Skill Points improve Skills by purchasing Skill Ranks.

Do not substitute similar terms when searching the manual. Search for the GRiMbOS label or the exact Glossary term.

Follow a configuration procedure

Use this process when a page changes GRiMbot configuration:

Read the scope and prerequisites.
Record the current setting values.
Confirm System Status and Connection Status.
Change one related group of settings.
Save or apply the change as directed.
Test with a controlled event, test account, or Event Emulator when the feature supports it.
Check the visible result and Logs and Diagnostics.
Restore the recorded settings if verification fails.

IMPORTANT
Do not combine installation, Twitch authorization, plugin installation, and Action Chain changes into one untested change. Separate changes produce clearer diagnostic evidence.

Use checklists as acceptance criteria

A checklist states the conditions that should be true when a task is complete. Do not treat a saved setting as proof that the service accepted it.

For connection-dependent work, verify all relevant conditions:

[ ] GRiMbot is running.
[ ] GRiMbOS opens without an error.
[ ] System Status reports the required service as running.
[ ] Connection Status reports the required external service as connected.
[ ] Twitch authorization includes the required Twitch Permissions.
[ ] The expected Chat Message, overlay output, or external action occurs.
[ ] Logs and Diagnostics contains no related error after the test.

Diagnose before changing configuration

Use a fixed evidence order:

Record the visible symptom and time.
Check System Status.
Check Connection Status.
Reproduce the fault once with the smallest practical test.
Read Logs and Diagnostics for the recorded time.
Confirm Twitch Permissions, plugin state, file access, and network requirements for the affected feature.
Apply the narrowest documented correction.
Repeat the same test.

NOTE
A red Connection Status row identifies a connection problem. It does not prove that credentials are wrong. Network access, missing Twitch Permissions, an unavailable external service, or an expired authorization may produce a similar result.

Protect sensitive information

Before sharing a screenshot or diagnostic extract:

[ ] Remove Twitch tokens and application secrets.
[ ] Remove account identifiers that are not needed for diagnosis.
[ ] Remove private network addresses and host names.
[ ] Remove local user names from file paths.
[ ] Remove Chat Messages or other personal data that is not needed.
[ ] Include the time, affected feature, and exact test instead.

Read Security, Data Files, and Logs and Diagnostics before sending files to another person.

Diagrams and screenshots

Feature pages use tables, numbered procedures, checklists, mermaid diagrams, and schematic figures as the visual map of GRiMbOS. Live window screenshots are not stored in this wiki. A capture of GRiMbOS or OBS usually contains tokens, chat, or private addresses.

When you take your own screenshot for diagnosis, follow the sanitizing checklist in Security.

Report a documentation fault

Capture enough information to reproduce the problem:

The page title and section heading.
The GRiMbot version.
The relevant GRiMbOS window and field label.
The expected result from the manual.
The observed result.
A sanitized log extract if behavior differs from the page.

Do not include credentials, private network details, database files, or unedited diagnostic bundles.