config_sample.json

{
  "_comment0": "Keys in the form of '_comment<num>' are comments to this json document and they are ignored. But DON'T PUT COMMENTS IN YOUR 'vcard' DEFINITION!",

  "_comment1": "These are the general configuration keys, you should use all of them and adjust them to your bots XMPP account",
  "jid": "bluebot@domain.tld",
  "password": "<password>",
  "nick": "bluebot",
  "timezone": "Europe/Berlin",

  "_comment2": "The 'owner' key holds the bare XMPP JID of the allmighty owner of the bot for administration",
  "owner": "<owner>@domain.tld",

  "_comment3": "the 'prefix' key holds the prefix the commands need to be triggered like ',pong'. Can be set to '!' but consider clashes with other bots",
  "prefix": ",",

  "_comment4": "The 'db' key holds the name of the database file. It will be stored in the bots main directory you cloned",
  "db": "bot.db",


  "_comment6": "Your YouTube API key for getting Information about Videos with the urlcheck plugin",
  "youtube_api_key": "<your_youtube_api_key>",

  "_comment7": "Avatar image name and type. Types may only be 'image/jpeg' and 'image/png' AFAIK",
  "avatar": "avatar.jpg",
  "avatar_type": "image/jpeg",

  "_comment8": "The XMPP temp-vcard in JSON format. Look at https://xmpp.org/extensions/xep-0054.html for which fields you can use and how they're structured. These are the ones I know they work. You don't need to use all of them. If you want to use more than one NOTE/EMAIL/URL/WHATEVER, you have to find out how to put them in json format in the slixmpp documentation.",
  "vcard": {
    "FN": "Blue Bot",
    "NICKNAME": "bluebot",
    "N": {
      "FAMILY": "Bot",
      "GIVEN": "Blue"
    },
    "BDAY": "2026-03-05",
    "ORG": {
      "ORGNAME": "Example Org",
      "ORGUNIT": "Automation"
    },
    "EMAIL": {
      "USERID": "bot@example.org"
    },
    "URL": "https://example.org",
    "ADR": {
      "LOCALITY": "Berlin",
      "CTRY": "Germany"
    },
    "NOTE": "I'm an XMPP helper bot.\nMy pronouns are 'it/its'."
  },


  "_comment101": "Maximum age for reminders in days. Reminders older than this will be rejected.",
  "reminder_max_age_days": 365,
}