# Configuring Solix Moderation

Solix Moderation is releatively simple to configure with quite a lot of repetition between each module. You can see the configuration options below. 

#### General Settings

The only thing you need to worry about in this section of the config is the modLog value. This value should be the channel where your modlog reciepts are sent. It should be private from the public.

```yaml
####################
# General Settings #
####################
enabled: true # Whether this module is enabled
modLog: "CHANNEL_ID" # Modlog channel ID. 
```

#### Purge Command

This is quite self explanatory but in general, if modLog is true, it will be recorded in the modLog. If enabled is true the command will be enabled

```yaml
#################
# Purge Command #
#################
purge:
  enabled: true
  modLog: true
```

#### Ban, Kick and Timeout Command

The same principle as above applies for here. But if sendToUser is true the user will be notified when when they are issued a ban/kick/timeout.  

```yaml
##############
# Ban System #
##############
ban: # This applies to /ban and /unban. 
  enabled: true
  modLog: true
  sendToUser: true # This only applies to /ban

###############
# Kick System #
###############
kick: 
  enabled: true
  modLog: true
  sendToUser: true

##################
# Timeout System #
##################
timeout: # This applies to both /timeout issue and /timeout remove
  enabled: true
  modLog: true 
  sendToUser: true
```

#### Warning Module

The same principles as above apply here. Except banOnWarning has the option "number". This option allows you to decide after how many warnings a user should be automatically banned for. You can also disable this function as shown below.

```yaml
##################
# Warning System #
##################
warn:
  enabled: true
  modLog: true
  banOnWarning:
    enabled: true
    number: 3
```