Skip to content

Commit

Permalink
Update README instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Erdragh committed May 28, 2024
1 parent 3f6f1a4 commit 3e0c814
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand All @@ -75,4 +75,8 @@ DISCORD_TOKEN=<place token here> 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.
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.

0 comments on commit 3e0c814

Please sign in to comment.