SlashBot

---

A chatbot for Discord A chatbot currently focusing on bringing as much information about your games as possible to Discord.

Setting up

• Install Python 3.5
• Clone the repository
• Set the paths to your credentials files (JSON) in slash_bot/config.py
• Open a terminal or command prompt and cd into the cloned repository
• $ pip install -r requirements.txt
• On macOS or Linux $ ./run.sh
• On Windows > cd slash_bot && python core.py && cd ..

The Discord credentials are mandatory, other required credentials depend on your activated modules.

Example discord.json credentials file:

{
  "discord": {
    "token":"xxxxxxxxxxxxxxxxxxxxx",
    "client_id":"xxxxxxxxxxxxxxxxxxxxx",
    "bot_id":"xxxxxxxxxxxxxxxxxxxxx",
    "owner_id":"xxxxxxxxxxxxxxxxxxxxx",
    "invite_link": "https://discordapp.com/oauth2/authorize?&client_id=<your_client_id>&scope=bot"
  },
  "riot": {
    "api_key": "xxxxxxxxxxxxxxxxxxxxx"
  },
  "osu": {
    "api_key": "xxxxxxxxxxxxxxxxxxxxx"
  },
  "bungie": {
    "api_key": "xxxxxxxxxxxxxxxxxxxxx"
  },
  "yahoo": {
    "client_id": "xxxxxxxxxxxxxxxxxxxxx",
    "client_secret": "xxxxxxxxxxxxxxxxxxxxx"
  }
}

The token value is mandatory to run the bot. The remaining depends on which modules are activated.

---

Commands

The bot uses the prefix , for all commands. If a module has listed a module prefix, the command syntax will be ,<module_prefix> <command> <parameters>. For example, the command for League of Legends summoner information would be ,lol summoner Faker KR. This prefix can be changed in slash_bot/config.py. If no module prefix is listed, simply use the command with the prefix as ,<command> <parameters>. The parameters column lists acceptable combinations of parameters that can be given for a command. Some commands can be invoked by the bot owner only (as defined in the Discord creds file), and the descriptions for these commands mention this.

General

Command	Parameters	Description	Bot Permissions	User Permissions
stats, st		Displays some bot info.
commands, cl, help, h		Shows the link to this page
invite, inv, invitelink, add, addlink		Owner only. Displays the Discord OAuth URL to add the bot

Administration

Command	Parameters	Description	Bot Permissions	User Permissions
slowmode, sm	Optional @<discord_user>, <interval_in_seconds>, @<discord_user> <interval_in_seconds>	Toggles slow mode in a channel. If no parameters are given, allows only 1 message per 5 seconds in the channel where it is invoked. Slow can be applied to individual users by mentioning them. If users are slowed on a channel and then slow is invoked for the whole channel, the per-user slows will be reset. Note: Currently slows are reset when the bot is restarted.	Manage Messages	Administrator
slowlist, sl, sml		Displays a list of users who are currently in slow mode on that channel. Command doesn't respond to users who are in the slow list.

Utilities

Command	Parameters	Description	Bot Permissions	User Permissions
setlocation, setloc	<city>	Store your location for things like weather.

League of Legends

Module prefix: lol

Command	Parameters	Description	Bot Permissions	User Permissions
setname, setn	<summoner_name> <region>	Register your summoner name with the bot so that users can mention you/you don't have to type it in for every command.
summoner, sumn, player	@<discord_user> or <summoner_name> <region>	General summoner information, including champion masteries and ranked stats for current season.
game, g, live	@<discord_user> or <summoner_name> <region>	Shows current game info for summoner.
runes, r, runepages	@<discord_user> or <summoner_name> <region>	Show all runes pages and stats for summoner
masteries, m, masterypages	@<discord_user> or <summoner_name> <region>	Show all mastery pages for summoner.
freechamps, fc	Optional <region>	Show the free champion rotation. If <region> is specified, the bot queries that region otherwise assumes NA.

Note that all region values must be abbreviated as per Riot's speicification (NA, EUW, EUNE etc.)

osu!

Module prefix: osu

Just calling the osu module itself with just ,osu will display osu! user information for the command invoker.

Command	Parameters	Description	Bot Permissions	User Permissions
setname, setn	<username>	Register your osu! name with the bot so that users can mention you/you don't have to type it in for every command.
player, p	Optional @<discord_user> or <username>	General player information. Searches for user by Discord username if no parameters are given

---

SlashBot isn't meant to be a public bot because some APIs impose limits which make it unfeasible for use in a larger number of servers with many users. For best results you should host your own instance for use in your server.

SlashBot isn't endorsed by Riot Games and doesn't reflect the views or opinions of Riot Games or anyone officially involved in producing or managing League of Legends. League of Legends and Riot Games are trademarks or registered trademarks of Riot Games, Inc. League of Legends © Riot Games, Inc.