From 3e0c814d59735516280d8f8216567d9b29b0ca3b Mon Sep 17 00:00:00 2001 From: Erdragh Date: Tue, 28 May 2024 18:09:26 +0200 Subject: [PATCH] Update README instructions --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 265709b..9ec7276 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@ The following things will be configurable: 2. (If possible) Minecraft user imitation (The Minecraft usernames and heads will be used for messages) 3. (Only available if requiring linking for whitelist) Discord user imitation (The messages will be written under the linked Discord name) - Default: No user imitation + Default: Minecraft user imitation (if webhook URL is set, otherwise no imitation) - Managing FAQs through a command interface (default: `off`) - Database connection. Uses an SQLite database by default @@ -56,9 +56,9 @@ on the [Discord Developer Portal](https://discord.com/developers/applications) a to have the three privileged gateway intents: `PRESENCE`, `SERVER MEMBERS` and `MESSAGE CONTENT`. Copy the bot token and store it somewhere safe (like a Password Manager) and never show it to -anybody else. To make sure the token gets read by the bot, it has to be in an [Environment Variable](https://en.wikipedia.org/wiki/Environment_variable) -`DISCORD_TOKEN` where the running Minecraft server can access it. You could for example modify a `start.sh` script -on a Unix-like system to `export` it or start the shell script with it set directly: +anybody else. To make sure the token gets read by the bot, it has to be in either an [Environment Variable](https://en.wikipedia.org/wiki/Environment_variable) +`DISCORD_TOKEN` where the running Minecraft server can access it or in the config file under the key `token`. +You could for example modify a `start.sh` script on a Unix-like system to `export` it or start the shell script with it set directly: `startmc.sh`: ```shell @@ -75,4 +75,8 @@ DISCORD_TOKEN= startmc.sh # Start the script with the env vari After starting the server, you can go into the OAuth2 URL builder on the Discord Developer Portal and generate a URL with the `bot` and `applications.command` permissions. -Use the generated URL to have the bot join your server. \ No newline at end of file +Use the generated URL to have the bot join your server. + +To be able to use user imitation, which makes the chat synchronization more readable, you will have to add a +webhook to your Discord server that uses the same chat you configured for the normal chat synchronization. Copy its +URL and add it to the `webhook.url` key in the config. \ No newline at end of file