Add docs

Author: holzmaster

.github/config.json

@@ -1,8 +1,8 @@
 {
     // This file supports comments and trailing commas
     "auth": {
-        "clientId": "${CLIENT_ID}",
-        "token": "${BOT_TOKEN}"
+        "clientId": "${DISCORD_CLIENT_ID}",
+        "token": "${DISCORD_TOKEN}"
     },
     "sentry": {
         "dsn": null,

.github/workflows/CI.yml

@@ -117,8 +117,8 @@ jobs:
 
     - name: Update configuration
       env:
-        BOT_TOKEN: ${{ secrets.CI_BOT_TOKEN }}
-        CLIENT_ID: ${{ secrets.CI_CLIENT_ID }}
+        DISCORD_TOKEN: ${{ secrets.CI_BOT_TOKEN }}
+        DISCORD_CLIENT_ID: ${{ secrets.CI_CLIENT_ID }}
       run: |
         envsubst < .github/config.json > config.json
 

CONTRIBUTING.md

@@ -1,3 +1,7 @@
+## Setup
+
+See [docs/SETUP.md](./docs/SETUP.md) for a guide on setting up your local bot.
+
 ## Commands
 
 We differentiate between the following types of commands:

README.md

@@ -63,14 +63,14 @@ cp config.template.json config.json
 $EDITOR config.json
 ```
 > [!TIP]
->  Die Datei kann Kommentare und Trailing-Commas (JSONC). Wenn du nicht VSCode verwendest, musst du das ggf. noch einstellen.
+> Die Datei kann Kommentare und Trailing-Commas (JSONC). Wenn du nicht VSCode verwendest, musst du das ggf. noch einstellen.
 
 2. Das Template ist für die [Coding-Test-Zentrale](https://discord.gg/ekJA6GA3BJ) vorausgefüllt. Es fehlen noch:
     - Um einen Bot zum Testen anzulegen, einfach den Instruktionen im [Discord Developer Portal](https://discord.com/developers/applications) folgen.
         - Die Applikation muss als "Bot" gesetzt werden.
         - Es müssen beide [Gateway Intents](https://discordjs.guide/popular-topics/intents.html#gateway-intents) eingeschalten werden.
-        - Ersetze `<CLIENT_ID>` durch die Application-ID
-        - Ersetze `<BOT_TOKEN>` durch das Bot-Token
+        - Ersetze `<DISCORD_CLIENT_ID>` durch die Application-ID
+        - Ersetze `<DISCORD_TOKEN>` durch das Bot-Token
     - Um IDs kopieren zu können, den "Developer Mode" in den Discord Einstellungen aktivieren. Mit Rechtsklick kann man dann die IDs kopieren.
 3. Das Script starten.
 

config.template.json

@@ -1,8 +1,8 @@
 {
     // This file supports comments and trailing commas
     "auth": {
-        "clientId": "<CLIENT_ID>",
-        "token": "<BOT_TOKEN>"
+        "clientId": "<DISCORD_CLIENT_ID>",
+        "token": "<DISCORD_TOKEN>"
     },
     "sentry": {
         "dsn": null,

docs/SETUP.md

@@ -0,0 +1,40 @@
+# Initial Dev Setup
+This has to be done once, usually.
+
+## Getting Tokens and Stuff
+If you already have your `DISCORD_CLIENT_ID` and `DISCORD_TOKEN`, you can skip these steps and go straight to `Add Bot Config`.
+
+### Create an application here: https://discord.com/developers/applications
+
+![Creating an Application](./images/0-create-application.png)
+
+### Copy the "Application ID". This is your `DISCORD_CLIENT_ID`.
+
+![Example Application Id](./images/1-application-id.png)
+
+### Add a Bot
+1. Go to "Bot" on the left side.
+2. Click "Add Bot" and confirm.
+
+### Bot Permissions
+Set these permissions:
+
+![Needed Bot Permissions](./images/2-permissions.png)
+
+### Create a Bot Token
+Click on "Reset Token" and copy the token that is generated. This is your `DISCORD_TOKEN`.
+
+![Creating a Token](./images/3-create-token.png)
+
+## Add Bot Config
+
+Once you have your `DISCORD_CLIENT_ID` and `DISCORD_TOKEN`, you can create a new config and fill in these values:
+```sh
+cp ./config.template.json ./config.json
+$EDITOR config.json
+```
+
+The config template is pre-filled with valid values for [Coding-Test-Zentrale](https://discord.gg/ekJA6GA3BJ). If you add new config values, also add them in the config template.
+
+> [!TIP]
+> As the config.json is actually a `.jsonc` file, it supports comments and trailing commas. If you use VSCode, you can set the syntax mode to `JSONC`.