Hindenburg has an easy-to-use JSON file for configuring the whole server. Hindenburg will look for a config.json in the current working directory, or if the HINDENBURG_CONFIGS environment variable is set to an absolute filename of the config.json to use, check out the Environment Variables page for more information.
Hindenburg also accepts configuration values as CLI arguments to the start command, either yarn dev or yarn start.
You can use any of the config keys below preceded with two dashes (--) to change the config at runtime.
For eaxmple, you could start Hindenburg with:
yarn start --socket.port 22023 --reactor.mods["daemon.unify"].optional false
This is equivalent to the following config.json
{
"socket": {
"port": 22023
},
"reactor": {
"mods": {
"daemon.unify": {
"optional": false
}
}
}
}
Some configuration keys with a wildcard, such as reactor.mods.* require a special accessing syntax. As seen in the example, this is simply ["key"], where the key is instead separated by square brackets and quotation marks. You should also omit the period (.) preceding it.
Relative or absolute path to another Hindenburg config to base this one off, to extend all values from.
Type: string
Default: (none)
or
Relative or absolute path to other Hindenburg configs to base this one off, to extend all values from.
Type: array
Relative or absolute path to another Hindenburg config to base this one off, to extend all values from.
Type: string
The name of the cluster that this node belongs to.
Type: string
Default: "Capybara"
The ID of this node in relation to other nodes in the cluster.
Type: number
Whether or not to check for updates.
Type: boolean
Default: true
Whether or not to auto-update Hindenburg when there is an update available.
Type: boolean
Whether or not to confirm when pressing CTRL+C to close Hindenburg.
Type: boolean
Default: true
Default language to localise disconnect messages to.
Type: string
Default: "en"
Any of the following: "de", "en", "es_ES", "es_US", "fil", "fr", "ga", "it", "ja", "ko", "nl", "pt", "pt_BR", "ru", "zh"
Accepted game versions that clients can connect with.
Type: array
Type: string
Configuration for the included Hindenburg http matchmaker.
Type: object
The port that the matchmaker should listen on.
Type: number
Default: 22021
Options regarding the socket that the server listens on.
Type: object
The port to listen on.
Type: number
Default: 22023
Any additional ports for Hindenburg to listen on.
Type: array
Type: number
Whether or not to broadcast gamedata messages that don't get handled by the server.
Type: boolean
Whether to order reliable packets received from clients.
Type: boolean
The IP address of this node, set to auto for it to get auto-discovered.
Type: string
Default: "auto"
Whether or not to use the DTLS transport layout when listening for Hello packets.
Type: boolean
Options regarding fine-tuning the results of game listings.
Type: object
Whether to ignore the privacy of a room, and return even private ones.
Type: boolean
Whether to ignore filtering for game listings, and just list every game on the server.
Type: boolean
or
Which search terms to ignore
Type: array
Any of the following: "chat", "chatType", "impostors", "map"
Type: number
or
Type: string
Any of the following: "all"
Whether to only return results that are a perfect match to all of the sort terms. Otherwise, Hindenburg will sort results by relevance to the search terms.
Type: boolean
Options regarding global worker plugins, such as disabling them or passing configuration options.
Type: object
Whether to load all plugins found in the plugin directories.
Type: boolean
Default: true
Whether to enable or disable this plugin.
Type: boolean
or
Enable the plugin and pass any configuration values to it.
Type: object
Advanced options for HACS, Hindenburg's Anti-Cheat System.
Type: object
The penalty to give a player for breaking this rule.
Type: object
The action that should be applied on this user for breaking this rule.
Type: string
Any of the following: "ban", "disconnect", "ignore"
The number of strikes that this user has before they are penalised.
Type: number
The number of general disconnects the player should have to have had for breaking this rule until they are banned.
Type: number
The length, in seconds, of how long to ban a player for breaking this rule.
Type: number
The message to give this player when disconnecting or banning this player.
Type: string
Configuration for each individual sub-rule.
Type: boolean, number or object
Type: array, boolean, number, object or string
Options for logging.
Type: object
Whether to hide sensitive information from logging, such as ip addresses.
Type: boolean
Logging options for client connections.
Type: object
Custom formatting for the extra information provided when logging client connections. (The part in parenthesis after their username.)
Type: array
Default: [ "id", "ip", "ping", "room" ]
Type: string
Any of the following: "id", "ip", "language", "level", "mods", "ping", "platform", "room", "version"
Logging options for game rooms.
Type: object
Custom formatting for the extra information provided when rooms are logged. (The part in parenthesis after the game code.)
Type: array
Default: [ "players", "map", "issaah", "privacy" ]
Type: string
Any of the following: "issaah", "map", "players", "privacy"
Logging options for logging players in-game.
Type: object
Custom formatting for the extra information provided when players are logged. (The part in parenthesis after the player's name.)
Type: array
Default: [ "id", "ping", "ishost" ]
Type: string
Any of the following: "id", "ishost", "language", "level", "mods", "ping", "platform"
Type: object
Whether or not to make sure players have the same chat mode as the host before joining.
Type: boolean
Type: boolean
or
Type: object
The prefix (or command identifier) for commands.
Type: string
Default: "/"
Whether or not rooms can use the built-in help command.
Type: boolean
Default: true
The type of game code to generate for rooms, "v1" for a 4-letter code and "v2" for a 6-letter code.
Type: string
Default: "v2"
Any of the following: "v1", "v2"
Enforce certain settings, preventing the host from changing them.
Type: object
Default: {}
Type: number
Type: string
Any of the following: "All", "Arabic", "ChineseSimplified", "ChineseTraditional", "Dutch", "English", "Filipino", "French", "German", "Irish", "Italian", "Japanese", "Korean", "Other", "Polish", "Portuguese", "PortugueseBrazil", "Russian", "Spanish", "SpanishAmericas"
Type: string
Any of the following: "Airship", "Mira HQ", "Polus", "The Skeld", "The Skeld April Fools"
Type: number
Type: number
Type: number
Type: number
Type: number
Type: number
Type: number
Type: number
Type: number
Type: string
Any of the following: "Long", "Medium", "Short"
Type: number
Type: number
Type: number
Type: number
Type: number
Type: number
Type: number
Type: string
Any of the following: "Always", "Meetings", "Never"
Options regarding local room plugins, such as disabling them or passing configuration options.
Type: object
Whether to load all plugins in the plugin directory.
Type: boolean
Default: true
Whether to enable or disable this plugin.
Type: boolean
or
Enable the plugin, and also pass in any configuration options that the plugin accepts.
Type: object
Whether the server should act as the host of the room.
Type: boolean
Advanced room options for mod and plugin developers, or knowledgeable server owners.
Type: object
Ignore every object type and treat all of them as uknown, including standard Among Us objects.
Type: string
Any of the following: "all"
or
Whether or not to allow uknown object types.
Type: boolean
or
An array of either spawn IDs or spawn types to allow
Type: array
Type: string
or
Type: number
Default appearance for a message sent by the server in game chat.
Type: object
The name of the player for a message sent by the server in game chat.
Type: string
Default: "<color=yellow>[Server]</color>"
The color of the player for a message sent by the server in game chat.
Type: string
Default: "Yellow"
The hat of the player for a message sent by the server in game chat.
Type: string
Default: (none)
The skin of the player for a message sent by the server in game chat
Type: string
Default: (none)
The visor of the player for a message sent by the server in game chat
Type: string
Default: (none)
The timeout in seconds to wait for a player joins before considering the room empty and destroying it.
Type: number
Default: 10
Type: object
Type: object
Whether or not to re-use the buffer to send to every client, instead of re-constructing the packet each time.
Type: boolean
Default: true
How often to actually broadcast movement packets from a single player, should be a very low number, between 1 and 3, where 1 is the most frequent (every packet is broadcasted) and 3 is the least frequent.
Type: number
Default: 1
Whether or not to check whether or not the player receiving each movement packet is in the vision of the player that moved, so-as to only send movement packets to those who can see it.
Type: boolean
Whether or not to check whether the sender and the reciever are dead so as to not send movement packets from alive players to dead players.
Type: boolean
Default: true
Whether or not to completely disable the perspective API for Hindenburg.
Type: boolean
Generated using TypeDoc