jbah.skp/csgo-hub-backend
1
0
Fork 0
mirror of https://github.com/jesperh1/csgo-hub-backend.git synced 2025-05-17 01:38:13 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Jesper 2022-09-21 22:36:18 +02:00
parent 4b3137eb6c
commit c2fec41161
1 changed files with 13 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,5 +1,15 @@
# CS:GO Hub backend # CS:GO Hub backend
Use with [csgo-hub-discord](https://github.com/jesperbakhandskemager/csgo-hub-discord)
## About
This is the backend, which works with Steam's OpenID to gather their Steam ID and convert it to the corresponding CS:GO friend code.
It functions with the [CS:GO Hub Discord bot](https://github.com/jesperbakhandskemager/csgo-hub-discord).
A user can request a token from the bot by issuing the `/link-steam` command in any server where the bot is present or in the bot's DM's.
The bot takes note of the Discord Id, and sends it along in the token request (the endpoint can only be accessed from localhost for security).
The bot responds to the user with a formatted link to the `steam.csgohub.xyz` site appended by their token, and the backend gathers various informations from both the database along with data from Discord's API.
Once a user is linked, anyone can issue the `/show-team` command in any channel the server owner permits and the bot will reply with a list of friend codes for any linked users in the same voice channel.
## Database ## Database
You need the following tables in MySQL You need the following tables in MySQL
@ -8,7 +18,7 @@ You need the following tables in MySQL
CREATE TABLE CREATE TABLE
`tokens` ( `tokens` (
`id` int(10) unsigned NOT NULL AUTO_INCREMENT, `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
`discord_id` varchar(18) COLLATE utf8mb4_unicode_ci NOT NULL, `discord_id` varchar(21) COLLATE utf8mb4_unicode_ci NOT NULL,
`token` varchar(8) COLLATE utf8mb4_unicode_ci NOT NULL, `token` varchar(8) COLLATE utf8mb4_unicode_ci NOT NULL,
PRIMARY KEY (`id`) PRIMARY KEY (`id`)
) ENGINE = InnoDB AUTO_INCREMENT = 17 DEFAULT CHARSET = utf8mb4 COLLATE = utf8mb4_unicode_ci ) ENGINE = InnoDB AUTO_INCREMENT = 17 DEFAULT CHARSET = utf8mb4 COLLATE = utf8mb4_unicode_ci
@ -16,7 +26,7 @@ CREATE TABLE
`users` ( `users` (
`id` int(10) unsigned NOT NULL AUTO_INCREMENT, `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
`created_at` timestamp NOT NULL DEFAULT current_timestamp(), `created_at` timestamp NOT NULL DEFAULT current_timestamp(),
`discord_id` varchar(18) COLLATE utf8mb4_unicode_ci NOT NULL, `discord_id` varchar(21) COLLATE utf8mb4_unicode_ci NOT NULL,
`friend_code` varchar(10) COLLATE utf8mb4_unicode_ci DEFAULT 'NULL', `friend_code` varchar(10) COLLATE utf8mb4_unicode_ci DEFAULT 'NULL',
PRIMARY KEY (`id`) PRIMARY KEY (`id`)
) ENGINE = InnoDB AUTO_INCREMENT = 6 DEFAULT CHARSET = utf8mb4 COLLATE = utf8mb4_unicode_ci ) ENGINE = InnoDB AUTO_INCREMENT = 6 DEFAULT CHARSET = utf8mb4 COLLATE = utf8mb4_unicode_ci