Kwik_bot

This is my discord bot.

1 - Install and Run

• Clone this repo

git clone https://github.com/KwikKill/Kwik_bot.git

• Create a database

follow the instructions from this tutoriel and setup a local database with user postgres and password . Theses values can be change in the ready listener file.

• Install dependencies

yarn Install

• Configure your env file

cp environnement-example.sh environnement.sh
# Edit to add you personnal token, Apex API key, Google API key and Riot Games API token

• Load environnement variables containing your token and key
• Launch the bot
• Enjoy !

. ./environnement.sh
node index.js

2 - Organisation

This repository is a discord bot using slash commands, listeners, componenents and using a local database.

2.1 - Slash commands

Every slash commands are in the commands folder. Each command is in a command.js file that contains the command code and the command description and usage.

Theses files are formated as bellow :

module.exports = {
    name: 'command_name',
    group: 'command_group',
    description: 'command_description',
    permission: 'owner || none',
    hidden: true || false,
    serverid: ['server_id',...],
    place: 'guild || dm || both',
    deploy: true || false,
    help: [
        {
            "name": "- __command__ :",
            "value": "command_help_description"
        },
        ...
    ],
    options: [
        {
            ...
        }
    ]
    async run(message, client, interaction) {
        // Command code
    },
    async autocomplete(client, interaction) {
        // Autocomplete code
    }
};

2.2 - Listeners

Every listeners are in the listeners folder. Each listener is in a listener.js file that contains the listener code and description.

Theses files are formated as bellow :

module.exports = {
    name: 'listener_name',
    group: 'listener_group',
    description: 'listener_description',
    type: 'listener_type',
    async run(client, ...args) {
        // Listener code
    }
};

2.3 - Components

Every components are separated in two folders. the context-menu folder and the buttons folder. Each component is in a component.js file that contains the component code and description.

Theses files are formated as bellow (for context-menu) :

module.exports = {
    name: 'component_name',
    description: 'component_description',
    permission: 'owner || none',
    serverid: ['server_id',...],
    type: 'component_type',
    async run(interaction, client) {
        // Component code
    }
};

Or as bellow (for buttons) :

module.exports = {
    name: 'component_name',
    description: 'component_description',
    permission: 'owner || none',
    serverid: ['server_id',...],
    async run(interaction, client) {
        // Component code
    }
};

2.4 - Timers

Every timers are in the timers folder. Each timer is in a timer.js file that contains the timer code and description.

Theses files are formated as bellow :

module.exports = {
    name: 'timer_name',
    group: 'timer_group',
    description: 'timer_description',
    on_setup: true || false,
    timer: integer,
    async run(client) {
        // Timer code
    }
};

2.5 - Database

The database is a local postgresql database. The database is used to store league of legends matchs and summoners info.

The database is formated as bellow :

CREATE TABLE summoners (
 puuid TEXT NOT NULL,
 username TEXT NOT NULL,
 accountid TEXT NOT NULL,
 id TEXT NOT NULL,
 discordid TEXT NOT NULL,
 
 rank_solo TEXT NOT NULL,
 tier_solo TEXT NOT NULL,
 LP_solo INT NOT NULL,

 rank_flex TEXT NOT NULL,
 tier_flex TEXT NOT NULL,
 LP_flex INT NOT NULL,

 region TEXT NOT NULL,
 priority INT NOT NULL,

 PRIMARY KEY (puuid)
);

CREATE TABLE matchs (
 puuid TEXT NOT NULL,
 player TEXT NOT NULL,
 gamemode TEXT NOT NULL,

 champion TEXT NOT NULL,
 matchup TEXT NOT NULL,
 support TEXT NOT NULL,

 gold INT NOT NULL,
 lane TEXT NOT NULL,
 kill INT NOT NULL,
 deaths INT NOT NULL,
 assists INT NOT NULL,
 result TEXT NOT NULL,
 total_damage INT NOT NULL,
 tanked_damage INT NOT NULL,
 heal INT NOT NULL,
 neutral_objectives INT NOT NULL,
 wards INT NOT NULL,
 pinks INT NOT NULL,
 vision_score INT NOT NULL,
 cs INT NOT NULL,
 length DECIMAL NOT NULL,
 total_kills INT NOT NULL,

 first_gold BOOLEAN NOT NULL,
 first_damages BOOLEAN NOT NULL,
 first_tanked BOOLEAN NOT NULL,

 double INT NOT NULL,
 tripple INT NOT NULL,
 quadra INT NOT NULL,
 penta INT NOT NULL,

 time_spent_dead INT NOT NULL,
 timestamp BIGINT NOT NULL,

 player2 TEXT NOT NULL,
 player3 TEXT NOT NULL,
 player4 TEXT NOT NULL,
 player5 TEXT NOT NULL,

 summoner1id INT NOT NULL,
 summoner2id INT NOT NULL,

 item0 INT NOT NULL,
 item1 INT NOT NULL,
 item2 INT NOT NULL,
 item3 INT NOT NULL,
 item4 INT NOT NULL,
 item5 INT NOT NULL,
 item6 INT NOT NULL,

 rune_0_perk INT NOT NULL,
 rune_0_var1 INT NOT NULL,
 rune_0_var2 INT NOT NULL,
 rune_0_var3 INT NOT NULL,

 PRIMARY KEY (puuid, player),
 FOREIGN KEY (player) REFERENCES summoners (puuid)
);

CREATE TABLE mastery (
 discordid TEXT NOT NULL,
 first_mastery_champ TEXT NOT NULL,
 first_mastery INT NOT NULL,
 second_mastery_champ TEXT NOT NULL,
 second_mastery INT NOT NULL,
 third_mastery_champ TEXT NOT NULL,
 third_mastery INT NOT NULL,
 total_point INT NOT NULL,
 mastery7 INT NOT NULL,
 mastery6 INT NOT NULL,
 mastery5 INT NOT NULL,

 PRIMARY KEY (discordid)
);

This implementation is not perfect and can/will be improved. If you have any idea to improve this database, feel free to contact me.

The LoL fetching game code's frequency was tested with a 200 summoners DB over a long period.