Game bot

Teamspeak bot which syncs stats from games with teamspeak server groups

Supported games

League of Legends
- Most recent played champion
- Solo/Duo rank
- Flex rank
- Preferred lane
Team fight Tactics
- Solo rank
- Double up
Apex Legends
- Rank
- Arena rank
- Most played legend

Main features

Keep track of in-game stats via teamspeak 3 sever groups through multiple games.
Use the auto setup to create teamspeak server groups for you automatically, so you can get stated even faster.
Use admin features like blocking to prevent user from abusing the bot.

Setup

Development

Copy .env.example file to .env file and fill necessary values

composer install

php game-bot migrate

Run

Commands

Run the bot

php game-bot run

Shows setup menu to set up supported games (recommended)

php game-bot setup

Revers all changes done by the setup (Removes teamspeak server groups and assignments)

php game-bot clean

Shows menu to creat and edit assignments manually. (Not recommended)

php game-bot menu

Setup for production

Create a query user on the teamspeak server, see necessary permission down below
Whitelist the ipaddress of the bot or turn off anti-flood-protection
Get Api keys
- Apex Legends: Tracker.gg (optional)
- League of Legends: Riot developers (optional)
- Teamfight Tactics: Riot developers (optional)
Create database, i recommend using "utf8mb4_general_ci" (same as ts3 uses)
Create a bot admin by copying ts3 client identity to admins env variable (optional)
Run bot setup

Docker-compose example

version: "3.1"

services:
  game-bot:
    container_name: game-bot
    image: domenikus/game-bot
    depends_on:
      - mariadb
    restart: unless-stopped
    env_file:
      - .env
    volumes:
      - ./logs:/app/logs

  mariadb:
    container_name: mariadb
    image: mariadb
    restart: unless-stopped
    environment:
      MYSQL_ROOT_PASSWORD: "super-secret-password"
    volumes:
      - ./data/mariadb/db:/var/lib/mysql
      - ./data/mariadb/sql:/docker-entrypoint-initdb.d

Example .env file

# IP of the teamspeak server
TEAMSPEAK_IP=

# Teampspeak port, default is 9987
TEAMSPEAK_PORT=9987

# Query username
TEAMSPEAK_QUERY_USER=

# Query user password
TEAMSPEAK_QUERY_PASSWORD=

# Query user port, default is 10011
TEAMSPEAK_QUERY_PORT=10011

# Chat command prefix, default is !
TEAMSPEAK_CHAT_COMMAND_PREFIX=!

# Bot default channel, if not provided bot will stay in servers default channel
TEAMSPEAK_DEFAULT_CHANNEL=

# Database type, you can choose between mysql and pgsql
DB_CONNECTION=mysql

# Database Host
DB_HOST=

# Database name
DB_DATABASE=

# Database username
DB_USERNAME=

# Database password
DB_PASSWORD=

# Database port
DB_PORT=3306

# Apex Legends API key
APEX_API_KEY=

# Allowed requests per minute for Apex Legends API, default is 30. Adjust it as needed for a production API key
APEX_RATE_LIMIT=30

# League of Legends API key
LOL_API_KEY=

# Allowed requests per second for League of Legends API, default is 1. Default value will fit for personal API key, for production you can enter 5
LOL_RATE_LIMIT=1

# Teamfight Tactics API key
TFT_API_KEY=

# Allowed requests per second for Teamfight Tactics API, default is 1. Default value will fit for personal API key, for production you can enter 5
TFT_RATE_LIMIT=1

# Specifies the region in which you are playing.
LOL_REGION=euw1

#Auto update period in seconds 1800 = 30m
AUTO_UPDATE_INTERVAL=1800

#Comma seperared list of teamsepak identity id's which should be able to use !admin commands
ADMINS=

#Specify how the application will log messages like erros. Default will be daily.
LOG_CHANNEL=daily

# Default is 'info' if you want to debug the application may you want to change this to 'debug'
LOG_LEVEL=info

Interacting with the bot in the container

docker exec -it game-bot php game-bot

Necessary bot permissions in ts3 server

b_serverinstance_permission_list
b_virtualserver_servergroup_permission_list
b_virtualserver_client_list
b_serverquery_login
b_virtualserver_notify_register
b_virtualserver_notify_unregister
i_channel_subscribe_power
b_virtualserver_servergroup_list
b_virtualserver_channelgroup_list
b_virtualserver_servergroup_create
b_virtualserver_servergroup_delete
i_permission_modify_power
b_icon_manage
i_icon_id (grant)
i_group_sort_id (grant)
i_max_icon_filesize
b_client_ignore_antiflood
i_group_modify_power
i_group_member_add_power
i_client_max_channel_subscriptions

Usage

User commands

Interacting with the bot from the teamspeak server using the chat

Show user commands

!help

Show admin commands

!admin|help

Configure

There is no need to configure the application manually, just run the setup and you are good to go. In case you want to do it manually the following explanation may help you.

Assignments

What is an assignment? Assignments are the mapping between a game stat and a ts3 server group. Which means, if you want that players who reach "GOLD I" tier in League of Legends, gets the server group "Gold", you have to provide "gold i" as a value and the id of the server group "gold". You can do this while using the provided cli menu.

Quality tools

PHPStan (Code quality) via Larastan

This command is used for analyzing your code quality.

composer analyse

For IDE integration refer here.

PHP CS Fixer (Code style) via Pint

This command is used to show code style errors.

composer sniff

This command will try to auto fix your code.

composer lint