2vb/snow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: add wiki to readme

Browse Source
This commit is contained in:
Eccentric 2023-12-31 15:09:21 +00:00 committed by GitHub
parent 0a735aaf8a
commit 850a59f1f6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
oauth.md
View File

@ -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
```

7
readme.md
View File

@ -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