The bot is written in discord.py and is currently being developed in cooperation with the RITE Outfit. Its primary purpose is the distribution of temporary accounts for the Jaeger Server of the MMOFPS Planetside 2.
- Set the UTC-Offset of your timezone using the
!utc-offset set <value>command.
This is necessary to make sure the bot enters the correct date and time in your google sheets. - Set the google sheets url using the
!jaeger-url set <url>command.
The bot's service account needs to have read and write access, so you may need to add it to the sheet.
The service account's address is ps2jaegeraccountbotsa@ps2jaegeraccountbot.iam.gserviceaccount.com. - Set the outfit name using
!outfit-name set <name>. - Please keep in mind, that some Settings commands are restricted to users with mod or admin privileges.
All commands marked by an A are only usable by users with mod or admin privileges.
All commands can also be called without the hyphen for convenience. (e.g. !utc-offset->!utcoffset)
Most commands are available as Slash Commands. Due to Discord limitations the syntax may differ slightly.
() = optional, <> = argument
| Command | Description |
|---|---|
| Miscellaneous | |
!help (command) |
Lists commands and displays help for the command specified |
!ping |
Displays the Bot's latency |
!info |
Shows some information about the bot |
!invite |
Shows the bots invite link |
| Settings | |
!utc-offset (set) <hours>A |
Displays/Sets the utc offset used for the google sheet |
!jaeger-url (set|delete) <url>A |
Displays/Sets/Deletes the google sheets url the bot will try to provision accounts from. |
!outfit-name (set|delete) <name>A |
Displays/Sets/Deletes the outfit name the bot will try to use. |
| Prefixes | |
!prefix |
Lists all active prefixes |
!prefix add <prefix>A |
Adds a new prefix |
!prefix delete <prefix>A |
Delete a prefix |
| Account Distribution | |
!account |
Displays the the name of the users currently provisioned account |
!account book <hours> |
Book an account for the specified time if there are any available. |
!account distribute (force) <hours> <mentions>A |
Distribute accounts to all mentioned members. If the distribution is forced, prior allocation is ignored. |
| Parity Check | |
!paritycheck |
Compares the Name and Role structure of your Discord to your Planetside 2 Outfit and points out the outliers |
!paritycheck show_excluded |
Lists users excluded from the parity check |
!paritycheck exclude <mention>A |
Exclude a user from the parity check |
!paritycheck unexclude <mention>A |
Removes a user from the exclusion list |
There are many ways to host a python program. Here i will describe my approach.
OS: Debian 11 bullseye (stable at the time of writing)
Python: Version 3.10
cd ~
Since we dont do any real releases, we treat the stable branch as the production branch. Not that this may not be the best approach for other repositories.
git clone "https://github.com/ZeroOne010101/PS2_Jaeger_Accountbot"
cd PS2_Jaeger_Accountbot
At the time of writing only python 3.9 was available for bullseye. So i followed this guide to install 3.10:
https://tecadmin.net/how-to-install-python-3-10-on-debian-11/
All the dependencies of the bot are listed in this txt file.
pip3.10 -r requirements.txt
sudo apt install postgresql
Change PG_PASS in DB_user.sql to the password your bot should use for sql communications.
sudo -u postgres psql -U postgres -f DB_user.sql
sudo -u postgres psql -U postgres -f DB_schema.sql
Populate data/settings.json with your credentials
sudo cp ps2jaegeraccountbot.service /etc/systemd/system/ps2jaegeraccountbot.service
sudo systemctl enable ps2jaegeraccountbot.service
sudo systemctl start ps2jaegeraccountbot.service
To Asorr for providing the resources neccesary to host the bot instance.
To TheJerry/vilgovskiy for helping me code this bot.