Update README.md

This commit is contained in:
Joren 2024-06-27 12:52:41 +02:00
parent 8b5448312b
commit 23a3ff1da2

View File

@ -15,11 +15,8 @@ This setting should be enabled for the bot in the discord developer panel for it
SERVER_ID = "1050204101826334999"
OUTPUT_CHANNEL_ID = "1250585834726621999"
PREFIX_ENABLED = true
# Display name of server a message has been send in
SERVER_ID_ENABLED = false
# Display clickable channel object of server a message has been send in
CHANNEL_ID_ENABLED = true
# Provides a link to the message where the regex has been matched
MESSAGE_LINK_ENABLED = false
[SERVERS.COIN_REGEXES]
Bitcoin = "[13][a-km-zA-HJ-NP-Z1-9]{25,34}"
@ -40,3 +37,31 @@ This setting should be enabled for the bot in the discord developer panel for it
[SERVERS.CHANNEL_BLACKLIST]
CHANNELS = []
```
### Explaination
```toml
[DISCORD]
BOT_TOKEN = ""
[[SERVERS]]
# ID of the server in which all the channels should be monitored
SERVER_ID = "1050204101826334999"
# Channel where everything should be send to
OUTPUT_CHANNEL_ID = "1250585834726621999"
# Wether to show the coin prefix or not
PREFIX_ENABLED = true
# Display name of server a message has been send in
SERVER_ID_ENABLED = false
# Display clickable channel object of server a message has been send in
CHANNEL_ID_ENABLED = true
# Provides a link to the message where the regex has been matched
MESSAGE_LINK_ENABLED = false
[SERVERS.COIN_REGEXES]
# Prefix = Regex pair of the coin(s) to be matched; can theoretically be used for other stuff
Bitcoin = "[13][a-km-zA-HJ-NP-Z1-9]{25,34}"
Ethereum = "0x[a-fA-F0-9]{40}"
[SERVERS.CHANNEL_BLACKLIST]
# IDs of the channels that should NOT be monitored
CHANNELS = ["1250537334550827078"]
```