From 23a3ff1da252023b4e0ae3c48f25833f48ae6eb3 Mon Sep 17 00:00:00 2001 From: Joren Date: Thu, 27 Jun 2024 12:52:41 +0200 Subject: [PATCH] Update README.md --- README.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index bb2763d..1a66c77 100644 --- a/README.md +++ b/README.md @@ -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"] +``` \ No newline at end of file