default-example.yaml

---
# relative to the cwd() of running process, which should usually be the top
# level of this repository.
dirs:
  data: data
  dist: dist

# which directory to keep x2i keys in
x2i: x2i

# logging level; see npmlog.level
level: info

conniebot:
  # set up your own token here:
  # https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token
  token: 000000000000000000000000.000000.000000000000000000000000000

  # you can just leave this off if you want, but I suggest including it because
  # it's useful
  activeMessage: x/help for info
  prefix: x/

  # owner id, only responds to admin commands if author is this person.
  owner: '499681310592335892'
  database: data/db.sqlite # relative to cwd
  migrations: migrations/*.sql # glob pattern, relative to cwd

  # discord.js config
  clientOptions:
    partials:
    # In v13 and earlier, these were strings. In v14 this is an enum, so numeric values are required
      - 1 # Channel
      - 3 # Message
      - 4 # Reaction
    intents:
      - DirectMessages
      - DirectMessageReactions
      - GuildMessages
      - GuildMessageReactions
      - Guilds
      - MessageContent
    allowedMentions:
      repliedUser: false

  # where x2i data should be read from
  x2iFiles: data/x2i

  # Help string; can be object instead for embed. Object structure should match the EmbedData
  # interface. As of discord.js v14.0.3, this is intentionally undocumented (if you're on the
  # server, see the thread at https://discord.com/channels/222078108977594368/999317051782987797 ).
  # However, the interface is very similar to APIEmbed, which is documented at
  # https://discord-api-types.dev/api/discord-api-types-v10/interface/APIEmbed .

  # additionally, you can use string substitution with `user` and `config` objects
  # supplied, of the User object and configuration respectively. Use like
  # `{foo.bar}` or `{foo[0]}`. (see `utils.strFormat` for more info.)

  # objects will recursively look through values for strings to replace.
  help: |-
    **Commands**

    **`{config.prefix}alpha`**: List all available alphabets.

    **`{config.prefix}help`**: Reply with this message.

    **`{config.prefix}invite`**: Send a DM with information about adding this bot to other servers.

    **`{config.prefix}ping`**: Check whether the bot is alive.

    **`{config.prefix}config`**: List current server config settings.
    **`{config.prefix}config reset`**: Reset all server config settings.
    **`{config.prefix}config <key>`**: Describe the config setting `key`.
    **`{config.prefix}config <key> <option>`**: Change the server config setting `key` to `option`.

    **`{config.prefix}about`**: Display information about the bot's runtime.

    **`{config.prefix}purge`**: Remove yourself from the database, if applicable.

    found a bug or want to suggest a feature?
    github: <https://github.com/xsduan/conniebot>
    come discuss: https://discord.gg/qgCG67knvs

  # alternatively, if you wanted to have a rich embed as a help message

  # help:
  #   color: 10017588
  #   author:
  #     name: '{user.username}'
  #     iconURL: '{user.avatarURL}'
  #   title: 'Commands'
  #   fields:
  #     - name: x,z,p[phonetic] or x,z,p/phonemic/
  #       value: Converts XSAMPA, ZSAMPA, or APIE. Hopefully.
  #     - name: '{config.conniebot.prefix}help'
  #       value: Reply with this message.
  #     - name: About these conversions
  #       value: |-
  #         <https://en.wikipedia.org/wiki/X-SAMPA>
  #         <http://www.kneequickie.com/kq/Z-SAMPA>
  #     - name: "\u200B"
  #       value: |-
  #         found a bug or want to suggest a feature?
  #         github: <https://github.com/xsduan/conniebot>
  #         come discuss: https://discord.gg/MvWMH3z

  invite:
    # I'm not using >- or |-, since I want to manually specify where line breaks are.
    "To add {user.username} to a server, click on the link below:
    \nhttps://discordapp.com/oauth2/authorize?client_id={user.id}&scope=bot&permissions=274878254144
    \nYou may only add the bot to a server that you have the \"manage server\" permission in.
    \n
    \nIt will request the following permissions:
    \n- Read messages
    \n- Send messages in channels
    \n- Send messages in threads
    \n- Embed links
    \n- Read message history
    \n- Add reactions
    \n- Use external emojis
    \n
    \nIn order for the bot to function, at least the \"read messages\" and one of the \"send messages\"
    permissions must be enabled.
    \n\"Embed links\" allows the invite to the testing server to have an embed. It is an optional
    permission.
    \n\"Read message history\" is required to self-react, so for the same reasons as \"add reactions\",
    it is recommended. It also allows the bot to use the Discord reply feature to indicate which message
    it's responding to. 
    \n\"Add reactions\" is used for the {config.deleteEmoji} reaction to delete messages. It's not
    technically required, but I highly recommend enabling it.
    \n\"Use external emojis\" is only used for reacting with {config.pingEmoji} to @\\-mentions. This is
    purely optional, and it doesn't do anything if \"add reactions\" is not enabled."

  # currently absolute timeout is 2048 because the largest field is 2048
  # characters long, and the longest normal message is only allowed to be 2000
  # characters (I think?) however if you really wanted to you could set it
  # farther, but you'll have some rejections from the api server. (or you
  # somehow purchased an override from Discord)
  timeoutChars: 2000
  timeoutMessage: |-
    **Timeout**
    Could not send all output as there were too many in a single message.

  deleteEmoji: 🗑️

  # If this is included, and the bot has access to it, it will react with this to all messages that
  # @-mention it. This does not include roles, @everyone, or @here.
  # It's totally optional, though.
  pingEmoji: <:wugping:913268541023723570>

  # If these are both present, they'll be used to post the server count to bots.gg.
  botlistToken:
    "000000000000000000000000000000000000.000000000000000000000000000000000000000000000000000000000\
    00000000000000000.0000000000000000000000000000000000000000000"
  botlistUrl: 'https://discord.bots.gg/api/v1/bots/{user.id}/stats'

  # This is the amount of delay required for confirmation of server config reset, in seconds.
  confirmationTimeout: 300

  # the URL of the privacy policy
  privacyURL: 'https://github.com/xsduan/conniebot/blob/master/PRIVACY_POLICY.md'