Welcome to VectorBot’s documentation!

Bot Documentation

Here I will explain how the bot starts up and more

Note

The document can change immensely as I program more features!

Warning

I don’t write many docs therefor some of the items may be explained wrong or badly.

I don’t have anything to say for now. Installation Guides are on the repositories wiki!

COGs Documentation

The following is the documentation on how the cogs work!

Note

I will have an example.py cog that won’t be imported but will be explaining all of the things I repeat in all the other cogs so that I can stop them from over filling the Documentation

Database

Feeds

Image Manipulation

Miscellaneous

Profile

Steams

Support

Utilities

Music

Twitch

Utils Documentation

Checks

Databases

Draw

Email Manager

Parser

Steam Manager

Footnotes

[1]This is only a spacer for when I need to do the documentation to remind me!

Frequently Asked Questions

This is a list of Frequently Asked Questions regarding the VectorBot and its cogs and utils.

General

General questions!

MultiServer Splash Support

This is will not be programmed in because of many things.

I will name some:

  • High Storage
    • A user will have a banner per server
  • High CPU/Memory Usage
    • Each time a user is updated he will get a new splash

I have more, I won’t and will not script MultiServer Splash Support. If you want me to do it as an example then I will. Even then it will not be enabled even in dev mode!

Database

Questions regarding database logging will answerd here!

Ask a question!

I have no questions right now.

Parser Util

Questions regarding cogs.utils.parser.Parser

Why does some of the Server[Members/Roles/Channels] have blank perms or confs

That is to do with config and permission handleing for each server separately.

Tests

Colour

class test.Colour(r: int, g: int, b: int)

Role

class test.Role(name: str, color: test.Colour, position: int)

Make shift Role Class

Game

class test.Game(name: str)

Make shift Game Class

Server

class test.Server

Member

class test.Member(name: str, id: str, avatar_url: str, roles, status: str, game: test.Game)

Indices and tables