Giter VIP home page Giter VIP logo

ps2_jaeger_accountbot's Introduction

This Project has been deprecated - i do not recommend further production use

PS2 Jaeger Accountbot

master

About

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.

Setup

  • 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.

Features

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

Selfhosting

There are many ways to host a python program. Here i will describe my approach.

Environment

OS: Debian 11 bullseye (stable at the time of writing)

Python: Version 3.10

Setup

Ensure you are in the home directory

cd ~

Get master

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 to Repository

cd PS2_Jaeger_Accountbot

Install python

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/

Install dependencies

All the dependencies of the bot are listed in this txt file.

pip3.10 -r requirements.txt

Install postgresql

sudo apt install postgresql

Create sql user and set password

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

Create Database

sudo -u postgres psql -U postgres -f DB_schema.sql

Change bot settings

Populate data/settings.json with your credentials

Copy, enable and start service

sudo cp ps2jaegeraccountbot.service /etc/systemd/system/ps2jaegeraccountbot.service

sudo systemctl enable ps2jaegeraccountbot.service

sudo systemctl start ps2jaegeraccountbot.service

Special Thanks

To Asorr for providing the resources neccesary to host the bot instance.
To TheJerry/vilgovskiy for helping me code this bot.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.