engineering
/
ramirez
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Move required logChannelId option to the top in README

master
Dragory 2018-03-11 22:00:02 +02:00
parent cccbf966c1
commit 7358d90b04
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -54,6 +54,7 @@ These go in `config.json`. See also `config.example.json`.
|------|-------|-----------| |------|-------|-----------|
|token|None|**Required!** The bot user's token| |token|None|**Required!** The bot user's token|
|mailGuildId|None|**Required!** The inbox server's ID| |mailGuildId|None|**Required!** The inbox server's ID|
|logChannelId|**Required!** Server's default channel|Channel where to post links to closed threads and other alerts|
|mainGuildId|None|ID of the main server where people contact the bot from, used for e.g. displaying users' nicknames| |mainGuildId|None|ID of the main server where people contact the bot from, used for e.g. displaying users' nicknames|
|prefix|"!"|Prefix for bot commands| |prefix|"!"|Prefix for bot commands|
|status|"Message me for help"|The bot's "Playing" text| |status|"Message me for help"|The bot's "Playing" text|
@ -69,7 +70,6 @@ These go in `config.json`. See also `config.example.json`.
|url|None|URL to use for attachment and log links. Defaults to `IP:PORT`| |url|None|URL to use for attachment and log links. Defaults to `IP:PORT`|
|snippetPrefix|"!!"|Prefix to use snippets. Defaults to `prefix` x2.| |snippetPrefix|"!!"|Prefix to use snippets. Defaults to `prefix` x2.|
|inboxServerPermission|None|Permission required to use bot commands on the inbox server| |inboxServerPermission|None|Permission required to use bot commands on the inbox server|
|logChannelId|Server's default channel|Channel where to post links to closed threads and other alerts|
|newThreadCategoryId|None|ID of the category where new modmail thread channels should be placed| |newThreadCategoryId|None|ID of the category where new modmail thread channels should be placed|
|relaySmallAttachmentsAsAttachments|false|Whether to relay small (<2MB) attachments from users as attachments rather than links in modmail threads| |relaySmallAttachmentsAsAttachments|false|Whether to relay small (<2MB) attachments from users as attachments rather than links in modmail threads|
|threadTimestamps|false|Whether to show custom timestamps in threads, in addition to Discord's own timestamps. Logs always have accurate timestamps, regardless of this setting.| |threadTimestamps|false|Whether to show custom timestamps in threads, in addition to Discord's own timestamps. Logs always have accurate timestamps, regardless of this setting.|