GRiMbot documentation

Data Files

This is the hosted copy of the GRiMbot technical manual. Use the table of contents to open any page in the manual.

Data Files

GRiMbot stores configuration, authorization data, media, plugins, and the database on the host you control. Treat this tree as sensitive.

Layout on a packaged install

Paths are relative to the GRiMbot install directory.

Path Contents
.env Twitch Client Secret, tokens, GRiMbOS credentials, STREAMERBOT_AGENT_TOKEN, and other secrets
data/grimbot.db SQLite database used by packaged local installs
data/media-clips/ Uploaded Media Library files
data/plugins/installed/ Unzipped plugin runtime. Do not edit this tree by hand
data/opening-chat/ Opening Chat settings
data/groups/ Custom Groups
data/channel/ Recent categories
data/game-* Chat Game JSON such as crops, session history, and game settings

The browser cache is not a Back Up. GRiMbar layout from Organize GRiMbar is stored on the server. Desktop shortcut positions are stored in the current browser only.

SECURITY

Do not copy .env or data/grimbot.db into chat, tickets, screenshots, or this wiki.

What a Core update must not overwrite

Install a new Core into the same folder so data/ and .env remain. A zip that extracts an empty data tree on top of a live install will destroy the database.

Related pages