GRiMbot documentation

Updating GRiMbot

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

Updating GRiMbot

Packaged Core

Install the new Core the same way you installed the last one. Prefer the same folder so data/grimbot.db and .env stay in place. Do not overwrite data with an empty tree from a zip.

Read the Release notes for that Release Candidate. Plugin zips are versioned against GRiMbOS. An old zip on a new Core is usually fine. A new zip on a very old Core may refuse to load.

Plugins

Open Add/Remove Plugins and install the new zip. Wait for the restart dialog. You do not uninstall first unless the notes say to.

Game DLC works the same way. Install Games Integration first if you are adding games for the first time.

After an update

Open Connection Status. Re-Authorize only if a feature asks for new Twitch permissions. Re-subscribe EventSub in that case.

Rebuild is not required on a Release Candidate. Rebuild applies to people with the git repository. They run npm run build in webui/frontend after UI edits.

Backups

Copy data/grimbot.db and .env somewhere else before you experiment. Media lives under data/media-clips. Plugin settings often live under data/ as JSON per game. A Core upgrade should leave those directories alone if you install in place.