Update configuration.md

usage-guide/configuration.md

@@ -1,3 +1,363 @@
 ---
 description: Configuring and customizing modmail.
----
+---
+
+Modmail offers an assort of customizations to make your Modmail bot unique to your server. Most customizations can be set with `?config`, but some has its own special command, such as `?activity`.
+You may find all of the personalizable tweaks available for Modmail below:
+
+{% hint style="info" %} All examples presume your prefix is `?`.{% endhint %}
+
+{% hint style="warning" %} Things covered in brackets are optional: `[]`
+Things covered in angled brackets are required: `<>`  {% endhint %}
+
+Moderation Configurations
+======
+
+Account Age ( account_age )
+------
+
+***Default:*** No Age Threshold 
+
+Set an amount of time a users account has to be created in order to open a ticket. 
+
+***Example:***
+
+- `?config set account_age P12DT3H` (stands for 12 days and 3 hours in [ISO-8601 Duration Format](https://en.wikipedia.org/wiki/ISO_8601#Durations))
+- `?config set account_age 3 days and 5 hours` (accepted readable time)
+
+***Note(s):***
+- To remove this restriction, do ?config del account_age.
+- See also: `guild_age`.
+
+
+Alert on Mention ( alert_on_mention )
+------
+
+***Default:*** No
+
+Mentions all mods (mention) in mention channel when bot is mentioned
+
+***Example:***
+
+- `?config set alert_on_mention yes`
+
+***Notes:***
+- See also: `mention`, `mention_channel_id`
+
+
+Reply Without Command ( reply_without_command )
+------
+
+***Default:*** Disabled
+
+Setting this configuration will make all non-command messages sent in the thread channel to be forwarded to the recipient without the need of `?reply`.
+
+***Example:*** 
+- `?config set reply_without_command yes`
+- `?config set reply_without_command no`
+
+***Notes:***
+- See also: `anon_reply_without_command`, `plain_reply_without_command`.
+
+
+Show Timestamps ( show_timestamp )
+------
+
+***Default:*** Yes
+
+Shows timestamps on thread embeds
+
+***Example:*** 
+
+- `?config set show_timestamp no`
+
+
+Silent Alert On Commands ( silent_alert_on_mention )
+------
+
+Send a message in the mention channel without mentioning all mods (mention).
+
+***Default:*** No 
+
+***Example:*** 
+- `?config set alert_on_mention yes`
+
+***Notes:***
+This has no effect unless `alert_on_mention` is set to yes.
+See also: `mention`, `mention_channel_id`
+
+
+Update Channel ID ( update_channel_id )
+------
+
+This is the channel where update notifications are sent to.
+
+***Default:*** Log Channel (normally `#bot-logs`)
+
+***Example:*** 
+- `?config set update_channel_id 9234932582312` (9234932582312 is the channel ID)`
+
+***Notes:***
+- This has no effect unless `disable_autoupdates` is set to no and `update_notifications` is set to yes.
+- See also: `log_channel_id`
+
+
+Update Notifications ( update_notifications )
+------
+
+This is the channel where update notifications are sent to.
+
+***Default:*** Yes 
+
+***Example:*** 
+- `?config set update_notifications no`
+
+***Notes:***
+- This has no effect unless `disable_autoupdates` is set to no.
+- See also: `update_channel_id`
+
+
+Fallback Category ID ( fallback_category_id )
+------
+
+This is the category that will hold the threads when the main category is full.\n\nTo change the Fallback category, you will need to find the [category’s ID](https://support.discordapp.com/hc/en-us/articles/206346498).
+
+***Default:*** `Fallback Modmail` (created when the main category is full)
+
+***Example:*** 
+- `?config set fallback_category_id 9234932582312` (`9234932582312` is the category ID)
+
+***Notes:***
+- If the Fallback category ended up being non-existent/invalid, Modmail will create a new one. To fix this, set `fallback_category_id` to a valid category.
+- See also: `main_category_id`.
+
+
+Log Channel ID ( log_channel_id )
+------
+
+This is the channel where all log messages will be sent (ie. thread close message, update message, etc.).\n\nTo change the log channel, you will need to find the [channel’s ID](https://support.discordapp.com/hc/en-us/articles/206346498). The channel doesn’t necessary have to be under the `main_category`.
+
+***Default:*** `#bot-logs` (created with `{prefix}setup`)
+
+***Example:*** 
+- `?config set log_channel_id 9234932582312` (9234932582312 is the channel ID)
+
+***Notes:*** 
+- If the Modmail logging channel ended up being non-existent/invalid, no logs will be sent.
+
+Main Category ID ( main_category_id )
+------
+
+This is the category where all new threads will be created.\n\nTo change the Modmail category, you will need to find the [category’s ID](https://support.discordapp.com/hc/en-us/articles/206346498).
+
+***Default:*** `Modmail` (created with `{prefix}setup`)
+
+***Example:*** 
+- `?config set main_category_id 9234932582312` (`9234932582312` is the category ID)`
+
+***Notes:***
+- If the Modmail category ended up being non-existent/invalid, Modmail will break. To fix this, run `?setup` again or set `main_category_id` to a valid category.
+- When the Modmail category is full, new channels will be created in the fallback category.
+- See also: `fallback_category_id`
+
+Mod Typing ( mod_typing )
+------
+
+When this is set to `yes`, whenever a moderator starts to type in the thread channel, the recipient user will see \"{bot.user.display_name} is typing…\" in their DM channel.
+
+***Default:*** Disabled
+
+***Example:*** 
+- `{prefix}config set mod_typing yes`
+- `{prefix}config set mod_typing no`
+
+***Notes:***
+- See also: `mod_typing`
+
+User Typing ( user_typing )
+------
+
+When this is set to `yes`, whenever the recipient user starts to type in their DM channel, the moderator will see “{bot.user.display_name} is typing…” in the thread channel.
+
+***Default:*** Enabled
+
+***Example:*** 
+- `?config set user_typing yes`
+- `?config set user_typing no`
+
+***Notes:***
+- See also: `mod_typing`.
+
+Twitch URL ( twitch_url )
+------
+
+This channel dictates the linked Twitch channel when the activity is set to \"Streaming\".
+
+***Default:*** `https://www.twitch.tv/discordmodmail/`
+
+***Example:***
+- `?config set twitch_url https://www.twitch.tv/yourchannelname/`
+
+***Notes:***
+- This has no effect when the activity is not set to \"Streaming\".
+- See also: `?help activity`
+
+Close On Leave ( close_on_leave )
+------
+
+Closes a modmail thread upon user leave automatically
+
+***Default:*** No 
+
+***Example:*** 
+- `?config set close_on_leave yes`
+
+***Notes:***
+- See also: `close_on_leave_reason`.
+
+Confirm Thread Creation ( confirm_thread_creation )
+------
+
+Ensure users confirm that they want to create a new thread
+
+***Default:*** No 
+
+***Example:*** 
+- `?config set confirm_thread_creation yes`
+
+***Notes:***
+- See also: `confirm_thread_creation_title`, `confirm_thread_response`, `confirm_thread_creation_accept`, `confirm_thread_creation_deny`
+
+Mention ( mention )
+------
+
+This is the message above user information for when a new thread is created in the channel.
+
+***Default:*** `@here`
+
+***Example:*** 
+- `?config set mention Yo~ Here's a new thread for ya!`
+- `?mention Yo~ Here's a new thread for ya!`
+
+***Notes:***
+- To disable mention, use command `{prefix}mention disable`.
+- See also: `{prefix}help mention`.
+
+Require Close Reason ( require_close_reason )
+------
+
+Require a reason to close threads.
+
+***Default:*** No 
+
+***Example:*** 
+- `?config set require_close_reason yes`
+
+
+Thread Auto Close ( thread_auto_close )
+------
+
+Setting this configuration will close threads automatically after the number of days, hours, minutes or any time-interval specified by this configuration.
+
+***Default:*** Never 
+
+***Example:*** 
+- `?config set thread_auto_close P12DT3H` (stands for 12 days and 3 hours in [ISO-8601 Duration Format](https://en.wikipedia.org/wiki/ISO_8601#Durations))
+- `?config set thread_auto_close 3 days and 5 hours` (accepted readable time)
+
+***Notes:***
+- To disable auto close, do `{prefix}config del thread_auto_close`.
+- To prevent a thread from auto-closing, do `{prefix}close cancel`.
+- See also: `thread_auto_close_silently`, `thread_auto_close_response`.
+
+Thread Cooldown ( thread_cooldown )
+------
+
+Specify the time required for the recipient to wait before allowed to create a new thread.
+
+***Default:*** Never 
+
+***Example:*** 
+- `?config set thread_cooldown P12DT3H` (stands for 12 days and 3 hours in [ISO-8601 Duration Format](https://en.wikipedia.org/wiki/ISO_8601#Durations))
+- `?config set thread_cooldown 3 days and 5 hours` (accepted readable time)
+
+***Notes:***
+- To disable thread cooldown, do `?config del thread_cooldown`.
+
+
+Thread Move Notify ( thread_move_notify )
+------
+
+Notify the recipient if the thread was moved.
+
+***Default:*** No 
+
+***Example:***
+- `?config set thread_move_notify yes`
+- `?config set thread_move_notify no`
+
+***Notes:***
+- See also: `thread_move_title`, `thread_move_response`, `thread_move_notify_mods`.
+
+Thread Move Notify Mods ( thread_move_notify_mods )
+------
+
+Notify mods again after the thread is moved
+
+***Default:*** No 
+
+***Example:*** 
+- `?config set thread_move_notify_mods yes`
+- `?config set thread_move_notify_mods no`
+
+***Notes:***
+- See also: `thread_move_title`, `thread_move_response`, `thread_move_notify`.
+
+Use Regex Autotrigger ( use_regex_autotrigger )
+------
+
+Whether to use regex to compare in autotriggers.
+
+***Default:*** No 
+
+***Example:***
+- `?config set use_regex_autotrigger yes`
+
+***Notes:***
+
+{% hint style="danger" %} This is meant for advanced user that understand regular expressions. {% endhint %}
+
+- You can test it out with https://regexr.com on `PCRE (Server)` mode
+- See command: `autotrigger`
+
+Plain Reply Without Command ( plain_reply_without_command )
+------
+
+Setting this configuration will make all non-command messages sent in the thread channel to be forwarded to the recipient in a plain form without the need of `{prefix}reply`.
+
+***Default:*** Disabled 
+
+***Example:*** 
+- `?config set plain_reply_without_command yes`
+- `?config set plain_reply_without_command no`
+
+***Notes:***
+- See also: `reply_without_command`, `anon_reply_without_command`.
+
+Anonymous Snippets ( anonymous_snippets )
+------
+
+Sends snippets anonymously.
+
+***Default:*** No 
+
+***Example:*** 
+- `?config set anonymous_snippets yes`
+
+***Notes:***
+- See also: `anon_avatar_url`, `anon_tag`, `plain_snippets`.
+
+Appearance Configurations
+======
+
+TODO