Sample Configuration

SajuukBot will be ceasing operations on March 31st 2024, due to a variety of factors. For more information, please refer to the announcement provided on the SajuukBot discord server and your options for migrating to a new bot.

The configuration is the most important element of SajuukBot. Without it, it is not possible for the bot to function in the way that will work for your guild.

The configuration structure used for SajuukBot is YAML. Previously it was based on JSON, but there are many benefits to using YAML, primarily:

  • It is a human readable format.

  • You can add comments to annotate your config for others.

  • IDs can be used for key names, which provides straightforward compatibility for the bot.

  • YAML converts the most accurately into Python types without meta conversions in the code.

  • It's very easy to validate that the configuration is accurate, preventing malicious input.

  • Removing elements you don't need is more intuitive compared to JSON.

Sample Configuration

Below is the default sample configuration that is created when the bot is added to a guild. It is provided below for those who need to reference something. This is also used as the boilerplate in the backend when a setting is missing, ie as the default.

For specifics about the configuration data of each section, use the navigation panel on the left to navigate to each section. If you are confused about the nature of the configuration, or you are running into validation issues applying a change, please report it via the SajuukBot support server in the #support channel, where a user or the support team can provide assistance.

---
prefix: "!"
nickname: ""
language: "english"
mute role: 0
anti spam:
  enabled: false
  level: 50
  censors:
    enabled: false
    shouting:
      enabled: false
      length: 10
    ascii:
      enabled: false
    zalgo:
      enabled: false
    bad words:
      enabled: false
      words:
    invites:
      enabled: false
      codes:
    domains:
      enabled: false
      blacklist:
  filters:
    enabled: false
    duplicates:
      enabled: false
      clean: false
      trigger: 5
      time: 30
    attachments:
      enabled: false
      clean: false
      trigger: 10
      time: 30
    emoji:
      enabled: false
      clean: false
      trigger: 10
      time: 30
    max messages:
      enabled: false
      clean: false
      trigger: 20
      time: 30
    mentions:
      enabled: false
      clean: false
      trigger: 20
      time: 30
    newlines:
      enabled: false
      clean: false
      trigger: 30
      time: 30
  heuristics:
    enabled: false
    duplicates:
      enabled: false
      clean: false
      trigger: 20
      punishment: tempmute
      tempmute length: 0
      time: 60
    scams:
      enabled: false
      trigger: 10
      punishment: tempmute
      tempmute length: 0
      time: 60
    max messages:
      enabled: false
      clean: false
      trigger: 20
      punishment: tempmute
      tempmute length: 0
      time: 60
    newlines:
      enabled: false
      clean: false
      trigger: 100
      punishment: tempmute
      tempmute length: 0
      time: 120
    links:
      enabled: false
      clean: false
      trigger: 25
      punishment: tempmute
      tempmute length: 0
      time: 100
    mentions:
      enabled: false
      clean: false
      trigger: 50
      punishment: tempmute
      tempmute length: 0
      time: 90
    attachments:
      enabled: false
      clean: false
      trigger: 25
      punishment: tempmute
      tempmute length: 0
      time: 75
  anti raid:
    enabled: false
    joins:
      enabled: false
      trigger: 50
      punishment: mute
      time: 60
      change level: false
    messages:
      enabled: false
      trigger: 30
      punishment: mute
      time: 15
      change level: false
    new accounts:
      enabled: false
      trigger: 15
      time: 45
      punishment: kick
      change level: false
      account age: 14
archive:
  enabled: false
  commands:
    archive:
      enabled: false
      level: 50
  blacklist:
    channel:
    category:
clean:
  enabled: false
  commands:
    suppress invoke: false
    user:
      enabled: false
      level: 50
    all:
      enabled: false
      level: 50
    bots:
      enabled: false
      level: 50
    channel:
      enabled: false
      level: 50
    channel user:
      enabled: false
      level: 50
    between:
      enabled: false
      level: 50
    until:
      enabled: false
      level: 50
    cancel:
      enabled: false
      level: 50
events:
  AUTOMOD CREATE:
    enabled: false
  AUTOMOD UPDATE:
    enabled: false
  AUTOMOD DELETE:
    enabled: false
  AUTOMOD EXECUTED:
    enabled: true
  CHANNEL CREATE:
    enabled: false
    audit log: false
  CHANNEL UPDATE:
    enabled: false
    audit log: false
  CHANNEL DELETE:
    enabled: false
    audit log: false
  GUILD UPDATE:
    audit log: true
  INVITE CREATE:
    enabled: false
    audit log: false
  INVITE DELETE:
    enabled: false
    audit log: false
  MEMBER JOIN:
    enabled: false
  MEMBER LEAVE:
    enabled: false
  MEMBER BAN:
    enabled: false
    audit log: false
  MEMBER UNBAN:
    enabled: false
    audit log: false
  MEMBER UPDATE:
    nickname: false
    roles: false
    timeout: false
    username: false
    audit log: false
  MESSAGE DELETE:
    enabled: false
  MESSAGE EDIT:
    enabled: false
  MESSAGE REACTION ADD:
    enabled: false
  MESSAGE REACTION REMOVE:
    enabled: false
  ROLE CREATE:
    enabled: false
    audit log: false
  ROLE UPDATE:
    enabled: false
    audit log: false
  ROLE DELETE:
    enabled: false
    audit log: false
  THREAD UPDATE:
    audit log: true
  VOICE CHANGE:
    enabled: false
    statistics: false
infractions:
  enabled: false
  commands:
    search:
      enabled: false
      level: 50
    issuer:
      enabled: false
      level: 50
    info:
      enabled: false
      level: 50
    delete:
      enabled: false
      level: 100 
    clear:
      enabled: false
      level: 100
    reason:
      enabled: false
      level: 50
member persist:
  enabled: false
  nickname: false
  roles:
    enabled: false
    only roles: 
    not roles:
memes:
  enabled: false
  commands:
    banana:
      enabled: false
      level: 50
    delet:
      enabled: false
      level: 50
    promote:
      enabled: false
      level: 50
    bees:
      enabled: false
      level: 50
    jokeban:
      enabled: false
      level: 50
moderation:
  enabled: false
  commands:
    ban:
      enabled: false
      level: 50
    kick:
      enabled: false
      level: 50
    mban:
      enabled: false
      level: 100
    mkick:
      enabled: false
      level: 100
    mmute:
      enabled: false
      level: 50
    mwarn:
      enabled: false
      level: 50
    mute:
      enabled: false
      level: 50
    softban:
      enabled: false
      level: 50
    tempban:
      enabled: false
      level: 50
    tempmute:
      enabled: false
      level: 50
    unban:
      enabled: false
      level: 100
    unmute:
      enabled: false
      level: 50
    vkick:
      enabled: false
      level: 50
    warn:
      enabled: false
      level: 50
modlog:
  master:
    channel: 0
    commands: false
    timestamp: false
    timezone: "Europe/London"
pinboard:
  enabled: false
  self star: false
  channel: 0
  count: 5
  emoji code: ''
  commands:
    add:
      enabled: false
      level: 50
    update:
      enabled: false
      level: 50
    remove:
      enabled: false
      level: 100
    reset:
      enabled: false
      level: 100
    block:
      enabled: false
      level: 50
    unblock:
      enabled: false
      level: 50
reaction roles:
  enabled: false
  description: A list of reaction roles in this server.
  channels:
  commands:
    add br:
      enabled: false
      level: 100
    remove br:
      enabled: false
      level: 100
    generate:
      enabled: false
      level: 100
    refresh:
      enabled: false
      level: 50
    remove:
      enabled: false
      level: 100
reminders:
  enabled: false
  commands:
    add:
      enabled: false
      level: 50
    clear:
      enabled: false
      level: 50
    delete:
      enabled: false
      level: 50
    list:
      enabled: false
      level: 50
roles:
  enabled: false
  commands:
    add:
      enabled: false
      level: 50
    remove:
      enabled: false
      level: 50
    list:
      enabled: false
      level: 100
    info:
      enabled: false
      level: 100
    temprole:
      enabled: false
      level: 100
self roles:
  enabled: false
  roles:
  commands:
    join:
      enabled: false
      level: 50
    leave:
      enabled: false
      level: 50
tags:
  enabled: false
  commands:
    suppress invoke: false
    create:
      enabled: false
      level: 50
    update:
      enabled: false
      level: 50
    remove:
      enabled: false
      level: 50
    get:
      enabled: false
      level: 50
    list:
      enabled: false
      level: 50
    clear:
      enabled: false
      level: 100
utilities:
  enabled: false
  commands:
    announce:
      enabled: false
      level: 100
    avatar:
      enabled: false
      level: 100
    charinfo:
      enabled: true
      level: 50
    get ids:
      enabled: false
      level: 50
    help:
      enabled: true
      level: 50
    info:
      enabled: false
      level: 50
    jumbo:
      enabled: false
      level: 50
    lock:
      enabled: false
      level: 100
    logs:
      enabled: false
      level: 100
    ping:
      enabled: false
      level: 100
    quote:
      enabled: false
      level: 100
    search:
      enabled: false
      level: 100
    server:
      enabled: false
      level: 100
    slowmode:
      enabled: false
      level: 50
    userinfo:
      enabled: false
      level: 50
    uptime:
      enabled: false
      level: 100
    voice:
      enabled: false
      level: 50
welcome messages:
  enabled: false
  channel: 0
  mention: false
  message: ":wave: Hey {member}, welcome to the **{guild}**! Please refer to the server rules channel before posting!
   :wave:"
PreviousPermissionsNextConfiguration

Last updated