From 9dfecba756d3aa48b95b5a00f4eff909dbd07615 Mon Sep 17 00:00:00 2001 From: Jonas_Jones <91549607+J-onasJones@users.noreply.github.com> Date: Mon, 23 Oct 2023 21:26:10 +0200 Subject: [PATCH] Added Setup guide --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 2f94cfd..aa9e9e6 100644 --- a/README.md +++ b/README.md @@ -11,4 +11,21 @@ A simple mod to connect the in-game chat with a Discord channel. +## Why another one? +- This one focuses on simplicity. It is as light as it gets with only the basic functionality and very little required setup! +**Setup:** +1. Go to https://discord.com/developers and create a new application +2. Copy the ID and invite the bot with the following url (dont forget to change the ID or else the link won't work: +```url +https://discord.com/oauth2/authorize?permissions=2953964624&scope=bot%20applications.commands&client_id=APPLICATION_ID +``` + +3. Enable developer mode on discord to be able to right-click a channel and copy its channel ID +4. Download the mod into the mods folder and let it generate the config file. The server will crash on first launch since the Bot Token is invalid. +5. Paste the copied channel ID of the channel that you would like the chat to be linked to into the config file +6. On the discord developer dashboard, in your application, go to the bot tab on the sidebar and reset and copy the bot token and paste it into the config file. +7. Restart the server and you should be good to go. Check that the bot has read/write permission in that channel. + +*Alternative suggested Setup Guide (not by me):* +https://erdbeerbaerlp.de/projects/discord-integration/quick-setup \ No newline at end of file