From 850a59f1f629e2ec9d858013e8d65ad72398bbf8 Mon Sep 17 00:00:00 2001 From: Eccentric Date: Sun, 31 Dec 2023 15:09:21 +0000 Subject: [PATCH] feat: add wiki to readme --- oauth.md | 50 -------------------------------------------------- readme.md | 7 +++---- 2 files changed, 3 insertions(+), 54 deletions(-) delete mode 100644 oauth.md diff --git a/oauth.md b/oauth.md deleted file mode 100644 index 816c4fa..0000000 --- a/oauth.md +++ /dev/null @@ -1,50 +0,0 @@ -# Configure Discord OAuth - -## Getting your OAuth Credentials - -![image](https://github.com/ectrc/snow/assets/13946988/8eeab2bc-6056-4329-8c8a-40c908f399d9) - -![image](https://github.com/ectrc/snow/assets/13946988/8bdfb31e-9669-47a5-a76e-80c42e01bb84) - -Part of the file `config.ini` should look like this: - -```ini -[discord] -; discord id of the bot -id="1234567890..." -; oauth2 client secret -secret="abcdefg..." -; discord bot token -token="OTK...." -``` - -Replace the values with your own, save and rebuild to apply the changes. - -## Setup the bot - -Add the correct redirects to your discord application: - -![image](https://github.com/ectrc/snow/assets/13946988/73fa37b8-3cc2-4b35-85bc-14e4121c6ebd) - -This will be from the `config.ini` file: - -```ini -[api] -port=":3000" -host="http://localhost" -``` - -Make sure to add `/snow/discord` to the end of the redirect url. - -## Inviting the bot - -Generate an invite link for the bot with the following permissions: - -![image](https://github.com/ectrc/snow/assets/13946988/04364150-0a93-42a7-a1b8-743b25f49ee9) -![image](https://github.com/ectrc/snow/assets/13946988/90ad3429-ca22-43f6-b426-4d0a6aa83d7c) - -The invite link should look like this: - -```url -https://discord.com/api/oauth2/authorize?client_id=CLIENT_ID&permissions=34816&redirect_uri=CALLBACK_URL&scope=bot+applications.commands -``` diff --git a/readme.md b/readme.md index c3a0d3e..d1618cc 100644 --- a/readme.md +++ b/readme.md @@ -30,11 +30,10 @@ Performance first, universal Fortnite private server backend written in Go. - **_Chapter 1 Season 4_** `Fortnite+Release-4.5-CL-4159770-Windows` I cannot get JWT Tokens to correcly work. I need to supplt a KID for the JWT Token to work however I cannot find a way to get the KID from the game. If you know how to get the KID from the game please open an issue or pull request. -## How do I use this? +## Support -- **[Discord OAuth Setup Guide](oauth.md)** How to setup Discord OAuth for your backend. This enabled the ability to login to the web app with Discord. - -**I would recommend waiting until the backend is more stable and has more features before using it.** +- **[Github Wiki](https://github.com/ectrc/snow/wiki)** View all of the setup guides and usefull information on how to setup the backend. +- **[Discord Server](discord.gg/kBefMZA4Qp)** Get help from community members on anything else! ## Contributing