1 settings.json
7cc5c4f330d47060 edited this page 2024-08-12 04:41:26 -04:00

The settings for the bot are stored in a JSON file.

secret string

Path to the secrets file (containing hashes, passwords, tokens, etc)

version_mc string

Default version to join with.

defaultLang string

Default language.

terminalMode string

Mode for the terminal. Possible values:

  • blackTerminal_24bit: 24-bit color mode for dark/black terminals
  • whiteTerminal_24bit: 24-bit color mode for light/white terminals
  • blackTerminal_8bit: 8-bit color mode for dark/black terminals
  • whiteTerminal_8bit: 8-bit color mode for light/white terminals
  • blackTerminal_4bit: 4-bit color mode for dark/black terminals
  • whiteTerminal_4bit: 4-bit color mode for light/white terminals
  • none (default): Displays no colors.

colors object

  • primary string: Primary color (for the primary subjects of sentences)
  • secondary string: Secondary color (for the rest of sentences)

prefix array

Array of prefixes the bot will respond to.

servers array

Servers the bot will connect to. Each server should be as follows:

  • host: Domain/IP of the server being connected to.
  • port: Port of the server being connected to. If you don't know this, it's probably 25565.
  • version: Server-specific version override.
  • options: Options for the server.
    • name: Unused.
    • disabled (boolean): Used in development to disable the bot on servers that are being spammed. If a server has been shut down permanently, you should remove it from the list instead.
    • isVanilla (boolean): Optimizes the bot for vanilla servers.

A settings.json file should be formatted as follows:

{
    "secret":"/path/to/secrets/file/here/secret.json",
    "version_mc": "1.20.4",
    "defaultLang": "en-US",
    "terminalMode": "blackTerminal_24bit",
    "colors": {
        "primary": "#FFCCEE",
        "secondary": "#FF99DD"
    },
    "prefix":[
        "ubotdev:",
        "d\""
    ],
    "servers":[
        {
            "host": "kaboom.pw",
            "port": 25565,
            "options":{
                "name": "kaboom"
            }
        }
    ]
}

An example settings file is provided as settings_example.json.