A Discord bot that provides STKAddons services and other STK-related needs.

Go to file

kita b4c98d7efe bub fix		2024-04-08 09:04:15 +05:00
cogs	bub fix	2024-04-08 09:04:15 +05:00
utils	more cleaning up	2024-01-28 20:10:23 +06:00
.gitignore	Initial commit	2023-12-31 11:27:32 +06:00
bot.py	bub fix	2024-04-08 09:04:15 +05:00
launch.py	add pokemap table	2024-02-10 11:10:43 +06:00
LICENSE	Initial commit	2023-12-31 11:27:32 +06:00
README.md	Update README.md	2024-03-15 08:06:42 +05:00
requirements.txt	Initial commit	2023-12-31 11:27:32 +06:00

README.md

linaSTK

linaSTK is a Discord bot that provides SuperTuxKart Online Services ("STKAddons") and other goodies to your Discord server. This bot is meant to be self-hosted for now.

This bot is currently used for the SuperTuxKart Discord, but you can self host it yourself.

Features

General

Player tracking
STK Seen
Top 10 ranked players
Player searching
Friends list
Server list
PokeMap
Addon querying
Ranking info of a player

Internal

Authentication
Polling
Session revalidation
Player caching (saves username and ID for future use)

How to set up

This assumes you have knowledge on how to create a Discord bot and set up the proper intents and invite it, as well as how to use the Linux command line, and how to create a PostgreSQL database.

Only Linux is supported. Other platforms will not be supported.

But feel free to contact me for help setting up the bot.

Initial set up

git clone https://codeberg.org/linaSTK/bot linastk-bot
cd linastk-bot
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Create a file named constants.py in the root of the folder. Then fill in the information.

# Accent color (used for embeds)
# You must use the hexadecimal representation of the color, or it won't work!
# Example: if your color is #fbce3a then put 0xfbce3a
ACCENT_COLOR = 0xfbce3a

# SuperTuxKart credentials
# This is required to make most features work.

# It is not recommended to use your main account for this.
# You can create an account here: https://online.supertuxkart.net/register.php

STK_USERNAME = ""
STK_PASSWORD = ""

# This is where you put your bot's Discord token. In any circumstances, DO NOT share this
# to anyone, not even your best friend that you trust! If you accidentally share it,
# IMMEDIATELY reset it.
TOKEN = ""

# Prefix for the bot.
# While lina mostly uses slash commands, some are hybrid and some only use
# the old prefix-based command system.
PREFIX = '&'

# PostgreSQL connection
POSTGRESQL = "postgresql://user:pass@localhost/db" 

# Max amount of players a user can track.
# If the user goes above this value, they will not be able to add additional
# players to track unless a user removes one to free up space.
MAX_PTRACK = 15

Run the bot

python launch.py

License

Bot

This bot is licensed under the GNU Affero General Public License, version 3.

Certain portions of the source code are from Rapptz's RoboDanny bot, licensed under the Mozilla Public License, version 2.

The Lina character

Lina is a cute character I came up with during development. All artwork related to her is licensed under the Creative Commons Attribution Share Alike 4.0 International license. You can use her (or maybe even improve her) as long as you comply with the license. (also treat her with care)