Installing Plugins

Installing plugins is very simple with Hindenburg; you can either install straight from NPM, or manually install one via a git repository or dropping in a folder.

Via NPM

If you want to install a plugin that is published on the NPM registry, installing it is as simple as the following command:

yarn plugins install hbplugin-<plugin name>

For example, you could run yarn plugins install hbplugin-ban-textfile.

If you need to install a specific version of the plugin, add a @<version> at the end of the plugin name, for example hbplugin-ban-textfile@1.0.0.

If you want to change where your plugins install to, see the HINDENBURG_PLUGINS environment variable.

Uninstalling a plugin that you installed from NPM is as simple as:

yarn plugins uninstall hbplugin-ban-textfile

Git Repository

Hindenburg has a built-in utility to install a plugin from a git repository such as one from Github:

yarn plugins import <git repository url>

This will handle cloning the plugin, installing dependencies with the correct package manager, building and verifying it for you.

Manual Install

You can also simply drop plugins into any of your plugin folders and Hindenburg will automatically recognise it as a plugin and attempt to load it.

Step 1: Navigate to your plugins directory with the cd command, e.g. cd C:/Users/essma/Documents/Projects/AmongUsProjects/Hindenburg/plugins.

If you want to install from a git repository, such as one on Github, you can simply use the git clone command to clone the plugin into your plugins directory For example, git clone https://github.com/SkeldJS/hbplugin-ban-textfile.

Step 2: cd into your plugin with cd <repo name>, for example cd hbplugin-ban-textfile

Step 3: yarn, npm install or pnpm install to install dependencies

Step 4: yarn build, npm run build or pnpm run build to build the plugin if necessary.

Hindenburg will now recognise the plugin and attempt to load it.

TypeScript Plugins

Note that if the plugin is written in TypeScript, you will have to build the plugin manually.

Navigate to the directory of the installed plugin with the cd command, e.g. cd C:/Users/essma/Documents/Projects/AmongUsProjects/Hindenburg/plugins/hbplugin-ban-textfile

Build the plugin with yarn build, npm run build or pnpm run build depending on the package manager used.