lol-ranks-bot

A Discord bot to assign roles based on League of Legends Rank!

Requirements

• Node.js > v16.0
• VS Code

Installation

• Install NPM
• Clone the repo (in VS Code press CTRL + P and type >git:clone (Tutorial))
• Open the terminal on project folder and type npm install
• Rename the config.json.example file to config.json
• Adjust your settings (tutorial below) and run npm run-script debug

Settings

• channels = Set the ID of the channels that will be used for the Bot to send the messages

  • role - Default channel for bot messages (required)
  • debug - Default channel for bot logs/debug messages (required)
  • help - Default channel to help members with bot-related issues (optional)

• guildID = ID of your server (Tutorial)

• discordToken = Tokens of your bot, used to authorize API requests and carry all of your bot user’s permissions (Tutorial)

• riotToken = Riot development API key (Tutorial)

• timeZone = Your timezone, you can find all timezones here

• language = Select your language according to the filename inside the locales folder (name only, no extension)

• enableCronJob = Enables automatic update of ranks every X time, defined in cronTab

• cronTab = Defines how often the ranks will be updated if enableCronJob is true

• concurrentRequests = Defines the number of concurrent requests to the API (See Rate Limits after login)

• requestTime = Set the request time in milliseconds

• setVerifiedRole = Sets the verified role, when somebody has got an elo role

• enableVerification = Enables summoner name verification

• enableTierUpdateMessages = Enable bot to send messages on configured channel for rank up/down

• To enable rank icons on messages (like this (You need to add custom emojis on your server (Tutorial)). The icons are inside the assets/img folder (Please do not change the name of the icons or the bot will not be able to identify them)

LICENSE

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.