ts-gw2-verifyBot

This script is intended to be used as an automatic form of Teamspeak authentication for Guild Wars 2.

How it works:

Using the ts3 module, the bot logs into the teamspeak server by IP via the serverquery account. See teamspeak documentation on this account, password would have been generated on server creation.

Bot will sit in any specificed channel (defined in the bot.conf)and wait for commands to be sent. Currently the commands are limited, but the framework is there add custom ones yourself.

The guild wars authentication uses the API keys from user's accounts. It also requires at least 1 character on said account to be level 80 ( level is configurable in bot.conf).

Installation and running

System Requirements:

• python3 + pip3 installed

Via pip install

1. Install module and dependencies: $ pip3 install git+https://github.com/FlussuferOrga/ts-gw2-verifyBot.git@master
2. Copy the bot.conf.example to bot.conf and modify the variables as needed.
3. Run the executable $ ts-gw2-verify-bot

Manual

1. Clone the repo
2. Install requirements: $ pip3 install -r requirements.txt or $ pip install -r requirements.txt
3. Copy the bot.conf.example to bot.conf and modify the variables as needed.
4. Run the module $ python3 -m bot

Usage

Command line parameters are available. See help: $python3 -m bot -h:

usage: ts-gw2-verify-bot [-h] [-c CONFIG_PATH]

ts-gw2-verifyBot

optional arguments:
  -h, --help            show this help message and exit
  -c CONFIG_PATH, --config-path CONFIG_PATH
                        Config file location

#API This project has an OpenAPI Specification, that is available under http://localhost:10137/v2/api-docs once the service started. A corresponding Swagger UI is available under http://localhost:10137/.

There are no api security mechanisms in place. It is assumed, that either a network based access policy will be enforced, or a reverse proxy handles authentication.

Docker Compose

version: "3.8"
services:
  ts-bot: 
    build: https://github.com/FlussuferOrga/ts-gw2-verifyBot.git
    volumes:
     - ./bot.conf:/app/bot.conf
     - ./BOT.db:/app/BOT.db
    deploy:
      restart_policy:
        condition: on-failure
        delay: 5s

Contributing

Development dependencies are definded in dev.requirements.txt.

After checkout install requiremetens and dev dependencies (for test & linting) by using $ pip install .[dev]

Linting

Linting is done by flake8 and pylint.

Flake8

Simply run flake8 . in the root folder. Flake8 is configured in the .flake8 file.

pylint

Run pylint bot in the root folder

Tests

Tests are done using pytest.

Execute the pytest command in the project root directory to run test.