hindenburg/hindenburg repository overview

⁠Hindenburg

Hindenburg is a completely customisable and scalable Among Us server, complete with advanced plugins and a sophisticated and configurable anti-cheat.

With unparalleled support for Reactor⁠, it's perfect for developers and for private modded game servers.

It uses SkeldJS⁠ to interface with the Among Us protocol, as well as keeping state.

Check out the full documentation⁠

⁠Features

⁠Server-As-A-Host

Hindenburg has complete authority, and does much more than a glorified relay network. It interacts directly with games, making sure everything runs smoothly and gives lots of power to plugins.

⁠Highly Configurable

Hindenburg is completely customisable with a simple json file, giving you full control.

⁠Plugins

Leveraging the power of SkeldJS, Hindenburg has full knowledge of running games, giving you the ability to write or easily install plugins to control the behaviour of the server.

⁠Reactor Support

Hindenburg also natively supports clients using Reactor⁠, allowing plugins to communicate directly with mods, and giving you the ability to leverage the full potential of the Reactor protocol.

⁠Getting Started with Docker

Hindenburg now supports Docker deployments on multiple architectures (amd64, arm64v8, armV7, armV6) and can run on your server or your RaspberryPi as well as other SBCs where docker is supported.

Docker deployments are new and support on Raspberry Pi may be limited to small servers depending on your model, if you have any issues please let us know.

⁠Basic Deployment

The following is the command to do a basic deployment of Hindenburg

Minimal (no access to config or plugins):

docker run -d --name hindenburg \
    -p 22023:22023/udp \
    hindenburg/hindenburg:latest

Basic (with access to config and plugins):

docker run -d --name Hindenburg \
    -p 22023:22023/udp \
    -v <PathToConfigDir>:/HConfig \
    -v <PathToPluginsDir>:/HPlugins \
    hindenburg/hindenburg:latest

Once you run the container the first time it will create a config.json file in the directory you specified. The plugins directory will be populated after the first run as well.

**The server does have an interactive cli. instead of docker run -d you could run docker run -it in screen or tmux so you can put it in the background. Here is a link of how to use tmux TMux Tutorial⁠ **

⁠Configuration

If you choose to you may create a string of command line switches and feed it to your docker run statement as an environmental variable that will be used on startup by adding the following to your "docker run" statement

    -e HINDENBURG_CLI_ARGS="<switches>"

⁠Example

docker run -d --name=Hindenburg \
    -p 22023:22023 \
    -e HINDENBURG_CLI_ARGS='--rooms.chatCommands false --logging.players.format ["id"]' \
    hindenburg/hindenburg:latest

⁠Available Switches

⁠Locales Table

⁠ServerPlayer table

⁠Issues

For issues regarding bugs that you encounter while using Hindenburg, please create an issue on the github issues⁠ page.

For help setting Hindenburg up, writing plugins or just general questions, please check out the Discord server⁠

⁠Notes

Hindenburg is licensed under the GNU General Public License v3.0⁠, meaning I am not responsible for anything you do with this library.