Grim Games Live Grim Games Live

GRiMbot documentation

Add/Remove Plugins

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

GRiMbot product page Manual home

Add/Remove Plugins

Add/Remove Plugins installs and uninstalls standard GRiMbOS plugin zip packages.

Open GRiMbar > System > Add/Remove Plugins.

Game DLC and item packs are not managed here. Use GRiMbar > Games > DLC Manager for those packages.

Installed plugin list

Each installed plugin row can show:

  • Plugin name
  • Version
  • Description
  • Plugin identifier
  • Uninstall button

The window displays No plugins installed when no standard plugins are registered.

Game DLC and item packs do not appear in this list.

Install a plugin

  1. Obtain the GRiMbOS plugin .zip package from a source you trust.
  2. Click Install….
  3. Select the zip file.
  4. Wait while the progress dialog displays Installing Plugin....
  5. Do not close or reload GRiMbOS while the API restarts.
  6. When Plugin Installed appears, click OK.
  7. Confirm that the plugin appears in the installed list.
  8. If the plugin registers GRiMbOS windows, open GRiMbar and confirm that they are present.
  9. If the plugin has settings, complete its setup instructions.

The install process checks the package before it places files or registers the plugin.

Package checks

The installer rejects a package when any applicable check fails.

Check Requirement
File type The uploaded filename must end in .zip, and the file must not be empty.
Layout Entries stored inside folders must belong to exactly one top-level plugin folder. Extra files at the zip root are accepted.
Folder name The top-level folder name must match the plugin identifier in manifest.json.
Manifest The package must contain {plugin-folder}/manifest.json with an identifier, name, and version.
GRiMbOS version The installed GRiMbOS version must satisfy the package requirement.
Dependencies Every required plugin and required version must already be installed.
Package contents Unsafe paths, forbidden dependency directories directly under the plugin folder, forbidden package-manager files anywhere in the zip, and packages over the uncompressed size limit are rejected.
Existing install A plugin with the same identifier must not already be installed. Uninstall it first.
Package kind Game DLC and item packs must be installed with DLC Manager.

Update a plugin

There is no in-place update command.

  1. Record any plugin settings that its own manual says are not retained after uninstall.
  2. Uninstall the existing plugin.
  3. Install the replacement zip.
  4. If the plugin has settings, open its settings window.
  5. Verify the functions supplied by the plugin.

The installer rejects a second package with an identifier that is already installed.

Uninstall a plugin

  1. Find the plugin in the list.
  2. Click Uninstall.
  3. Read the confirmation.
  4. Click Uninstall to continue, or cancel to keep the plugin.
  5. Wait while the progress dialog displays Uninstalling Plugin....
  6. When Plugin Uninstalled appears, click OK.
  7. Confirm that the plugin is absent from the list and GRiMbar.

GRiMbOS refuses to uninstall a plugin while another installed package depends on it. Uninstall the dependent packages first.

Restart and verification

Install and uninstall operations schedule an automatic API restart. GRiMbOS checks the health endpoint until it observes the API stop and return. The progress dialog can wait for up to two minutes.

After the API returns, GRiMbOS reloads the plugin list and registered windows.

Use this checklist after an install:

  • [ ] The completion dialog appeared.
  • [ ] The plugin is listed with the expected name and version.
  • [ ] Its GRiMbar folder or window appears, if the plugin registers one.
  • [ ] Its settings window opens, if the plugin provides one.
  • [ ] Its required dependencies are installed.
  • [ ] Its connection is green in Connection Status, when the plugin provides a connection check.

Failure handling

Message or condition Action
Plugin must be a .zip file Select the packaged plugin zip, not an extracted folder or another archive type.
Empty file Obtain a complete copy of the package and try again.
Invalid zip layout or missing manifest Obtain a correctly built GRiMbOS plugin package. Do not rearrange package files by hand.
Plugin already installed Uninstall the existing plugin before installing the replacement.
Required plugin is missing or the version is wrong Install the required dependency and version first.
Package requires another GRiMbOS version Use a compatible plugin package or update GRiMbOS through the documented update procedure.
Package belongs in DLC Manager Open Games > DLC Manager and install it there.
Uninstall is blocked by dependent packages Uninstall the named dependent Game DLC or item packs first.
API restart timed out Confirm that GRiMbot is running, check the available service logs, then reopen Add/Remove Plugins and inspect the installed list before retrying.
Plugin update failed Dismiss the error, check whether the old or new plugin appears in the list, and avoid repeating the operation until the API is healthy.

Boundaries

Add/Remove Plugins does not configure a plugin after installation. If the plugin has settings, open its settings window and follow its manual.

It does not manage Core windows, Game DLC, or item packs. Uninstalling a plugin removes its installed package and registration. It does not uninstall packages that depend on it because the operation is blocked first.