Page cover

⚙️Command docs

All commands available in our bot are described here

Content
  • Command syntax

  • Bot setup

  • Account statistics

  • In game sessions

  • Customization

  • Server setup

  • Other commands

Command syntax:

/command [param_1] <param_2> <param_3>

  • Some commands have parameters that can be mandatory or optional /command [param]

  • If an argument is specified in square brackets [], it is mandatory

  • If the argument is specified in triangle brackets <>, it is optional

Example:

/parse_replay [replay] [region] <output_type>

  • The replay parameter is mandatory.

  • The output_type argument is optional, so it can be omitted.

Mandatory parameters are displayed immediately, optional parameters must be added separately or ignored (see screenshot below).

Example of displaying mandatory and optional arguments

Bot setup:

1: /set_lang [lang]

Parameters:

  • lang List of available languages (string)

What it does:

  • Sets the localization language of the bot for you.

Note:

  • Language default enables automatic language selection. The automatic selection is based on the language set in the Discord application interface.

  • It may not work with older versions of Discord.


2: /set_player [nickname] [region]

Parameters:

  • nickname Player's nickname for saving (string)

  • region Region to search (string)

What it does:

  • Saves the player to the database for later use, e.g. for the /astats command

Account statistics:

1: /stats [nickname] [region]

Parameters:

  • nickname Player's nickname to search for (string)

  • region Region to search (string)

What it does:

  • Searches for a player with a given nickname in a given region. If the player is found, a picture with detailed statistics is returned. Otherwise an error is returned.


2: /astats

What does:

  • Same as /stats only the data does not need to be entered, they are taken from the database after registering them with the command /set_player

In game sessions:

Attention:

1: /start_session

What it does:

  • Starts a session, after starting a session you need to play a few fights to generate a session.


2: /start_autosession <timezone> <restart_time>

Parameters:

  • timezone : int Offset of your time from UTC (Greenwich Mean Time). For example, the time zone is UTC + 3, so the parameter should be set to 3 if you want the time to be UTC. Default 0 (UTC time)

  • restart_time : str The time at which the session will be restarted is specified as a time string in 24-hour format.

Example of correct time values: 12:30, 19:22, 00:10, 03:45

Example of incorrect values: 3:45, 12:34:20, 09:22PM, 26:32

What it does:

  • Starts an automatic session or restarts an existing one (resets statistics) which will be restarted at a specified time.


3: /get_session

What it does:

  • Generates a player session and sends back a picture with session stats.


4: /session_state

What it does:

  • Displays whether the session is active, how long the session has been active, and other useful information.


Customization:

1: /set_background [image] <server> <resize_mode>

Parameters:

  • image The image file (700x1350), has the following limitations:

  • PNG, JPEG formats

  • Size of one of the sides not more than 2048 px and not less than 256 px

  • Weight not more than 2MB

  • server If True, the image is applied as the default image for the server in which the command was invoked. Administrator rights on the server are required.

  • resize_mode Method of fitting the image to size (if it is not 700x1350)

    • AUTO Automatic detection of the best resizing method

    • RESIZE Resizing by ignoring proportions is automatically applied when the deviation from nominal size is less than 10% in X and 15% in Y

    • CROP_OR_FILL - Cropping the image and centering if it is larger than necessary or centering and adding filler in the form of blurred parts of the original image if the size of the picture is smaller than necessary. Does not disturb the image proportions. It is applied automatically if RESIZE method is impossible because of strong distortion of proportions.

What is does:

  • Saves the selected image as a background for images with statistics for you or to the server where the command was called (Depends on the server parameter).

Warning:

Note:

If you are the administrator of the server on which you are using the bot you can disable the ability for users to use custom backgrounds for statistics on your server and set your own background that will be displayed to users.


2: /unset_background

What it does:

  • Resets the custom background by literally removing it from the database.


3: /image_settings <params>

Parameters:

  • use_custom_bg : bool Ability to use your own background (True by default)

  • glass_effect : int Parameter of background blurring behind blocks with statistics on the image. 0 - Disables blurring.

  • blocks_bg_brightness : int Background brightness behind blocks with statistics in %

  • nickname_color : str Nickname color in HEX Color format. Example #ff0000 - red. You can select a color and copy it here -> Google palette

  • clan_tag_color : str Clan tag color

  • stats_color : str Color the numbers with basic statistics, such as the number of fights on the account

  • main_text_color : str Color of the main text, such as categories of statistics

  • stats_text_color : str - Color of inscription statistics by type: average damage or rating which are under the main statistics

  • disable_flag : bool - Turning off the region flag on the image

  • disable_cache_label : bool - Turns off the cache icon if saved data has been used

  • hide_nickanme : bool - Nickname hiding. If enabled, the nickname changes to Player

  • hide_clan_tag : bool - Hiding clan tag in statistics. If enabled, the clan tag is not displayed

  • disable_stats_blocks : bool - Disables rendering of contrast blocks that make statistics stand out from the background image. It can be useful if you have prepared your own background image and the standard statistics highlighting interferes with it

  • disable_rating_stats : bool - Disables displaying the block with rating statistics when session statistics are requested

  • positive_stats_color : str - Determines the color of positive session statistics

  • negative_stas_color : str - Determines the color of negative session statistics

What it does:

  • Saves and applies preset settings to the image.

Note:

All parameters of this command are optional, change as many settings at a time as you see fit, untouched settings will simply not change.


4: /image_settings_get

What it does:

  • Sends the user their current image settings as a picture.

A picture of the image settings.

5: /image_settings_reset

What it does:

  • Reset all image settings to default.

Note:

Does not affect the background image, if you need to reset the background image then use: /unset_background


Server setup:

1: /server_settings <params>

Parameters:

  • allow_custom_backgrounds - Parameter determining whether users are allowed to use their backgrounds for statistics on this server.

What it does:

  • If False, it replaces the user's image with the default image for this server or with a standard image if the server does not have a default background.


2: /server_settings_get

What it does:

  • Display the current server settings to the user.

Other commands:

1: /parse_replay [replay] [region] <output_type>

Parameters:

  • replay file .wotbreplay

  • region Region in which the battle was played

  • output_type Output type, ignore if you don't know what JSON is

What it does:

  • Shows basic information about the replay, the list of participants of the battle from the replay and their statistics.


2: /ping

What it does:

  • Shows basic information about the replay, the list of participants of the battle from the replay and their statistics.

Attention:

Last updated

Was this helpful?