Skip to content

Latest commit

 

History

History
129 lines (114 loc) · 4.83 KB

README.md

File metadata and controls

129 lines (114 loc) · 4.83 KB
Raw

OS3 Rocket League Ladder

Build Status pre-commit Code style: black License: MIT

This repo is a Python(3) implementation of the original OS3 Rocket League Ladder written in PHP.

This implementation makes heavy use of the Python discord bot.
The idea is that players participating in the ladder can control the challenges and result entirely from discord.

Current bot commands

Last updated 01-05-2020

A competition manager bot. This bot manages the Rocket Leage ladder.

Admin:
  add_player            Allows RLL Admins to add players to the Rocket League...
  reset_password        Allows RLL Admins to reset a players password.
  start_new_season      Resets the player ranking, scrambles a new leader bor...
Debug:
  announce_challenge    Test call to announce a challenge. This does nothing ...
  debug_reset_challenge Resets the challenge you are parcitipating in.
  hi                    Say hi to the bot, maybe it'll greet you nicely.
  what                  Allows you to ask a random question to the bot.
Members:
  cool                  Says if a user is cool.
  joined                Says when a member joined.
RLL:
  complete_challenge    Completes the challenge you are participating in.
  create_challenge      Creates a challenge between you and who you mention.
  get_active_challenges Returns the number of active challenges.
  get_my_challenges     Gives your current challenge deadline.
  get_ranking           Returns the current player ranking leaderboard.
  get_stats             Returns the current player stats.
  reset_challenge       Resets the challenge you are parcitipating in.
RNG:
  choose                Chooses between multiple choices.
  roll                  Rolls a dice in NdN format.
​No Category:
  help                  Shows this message
  listavailable         Lists extensions available
  listloaded            Lists extensions currently loaded
  load                  Loads an extension into the bot
  unload                Unloads an extension from the bot.

Type $help command for more info on a command.
You can also type $help category for more info on a category.

The bot will listen to commands in the Discord channel specified in the settings.
For the most recent version type $help in the Discord channel the bot is connected to.

Running the bot

Creating the database

cd OS3-RLL-Python
mysql -e "CREATE DATABASE IF NOT EXISTS os3rl"
cat deployment/database_schema.sql | mysql os3rl

Running on CLI

cd 
python setup.py install
export DISCORD_TOKEN="<token>"          # Token from https://discordapp.com/developers/applications
export DISCORD_GUILD="<guild name>"     # Which guild (discord server) to connect to
export DISCORD_CHANNEL="<channel name>" # The guild text channel to connect to
export DB_USER="<database_username>"
export DB_PASS="<database_password>"
os3-rocket-league-ladder

Running as a service

# Create the env and service files
cat <<EOF > /etc/default/os3-rocket-league-ladder
DISCORD_TOKEN="<token>"
DISCORD_GUILD="<guild name>"
DISCORD_CHANNEL="<channel name>"
DB_USER="<database_username>"
DB_PASS="<database_password>"
EOF

cat <<EOF > /etc/systemd/system/os3-rocket-league-ladder.service
[Unit]
Description=Rocket League Ladder Python
After=network-online.target
StartLimitIntervalSec=0

[Service]
EnvironmentFile=/etc/default/os3-rocket-league-ladder
Type=simple
Restart=always
RestartSec=5
User=rrl
ExecStart=/usr/local/bin/os3-rocket-league-ladder

[Install]
WantedBy=multi-user.target
EOF

# Add the user
useradd --system --shell /bin/false rrl

# Enable and start the service
systemctl daemon-reload
systemctl enable os3-rocket-league-ladder.service
systemctl start os3-rocket-league-ladder.service

Setting up a development environment

If you want work on the OS3-RLL-Python bot, great!
Here is how to setup your env

git clone [email protected]:Erik-Lamers1/OS3-RLL-Python.git
cd OS3-RLL-Python
apt-get install virtualenvwrapper tox
mkvirtualenv -p $(which python3.8) -a $(pwd) OS3-RLL-Python
pip install -r requirements/development.txt
pre-commit install
# And you are good to go

Running the tests

Set the correct settings module first

export SETTINGS_MODULE=os3_rll.settings.test

Then either run tox or run pytest from within your venv.