Skip to content

This plugin extends the sinusbot to connect with the RIOT API and get the correct rank, level, role and ingame-status

License

Notifications You must be signed in to change notification settings

frizzant/league-of-legends-rankify

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

93 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

league-of-legends-rankify

for the TS3 Sinusbot

rankify

Build Status GitHub GitHub issues GitHub closed issues GitHub repo size GitHub last commit

liberapay liberapay_give

Donate using Liberapay

This script connects your Sinusbot with the League Of Legends API, to get the rank of your users. Simply add the LOL username as the client/user description in Teamspeak.

Features

Automatically add

  • ELO Rank (Iron...Challenger)
  • Level (30+, 50+...500+)
  • Role (Top, Mid, Bot, Jungle, Support)
  • In Game Status

Installation

Simply copy the script lol-rankify.js to your Sinusbot scripts/ folder. Or install it via NPM install.

NPM Install

npm i league-of-legends-rankify


Usage

  1. Get your Riot API Key: https://developer.riotgames.com/ --> Register Product --> Personal API Key.
  2. Install/upload the script
  3. Fill out/Select options in the backend (API Key etc.) & make your server groups with the LOL icons ready
  4. Activate the lol-rankify script
  5. Fill in the Summoner Name as the description of the client. Yes names with spaces inside work.
  6. !lolreload (client must do this himself), !lolreload all, or wait until the client reconnects to the server.
  7. Let it do its magic.

Hints

  1. It will not work without a verified RIOT API key. If you request it, chances are very high that you will get it.
  2. If you NEED your client descriptions for something crucial, and don't want to replace them with the clients summoner names, you can now use the TS3 nickname of the client instead.

User Nickname or Description*

*default

Select your preference in the backend. If you prefer to use the TS3 User Nickname instead of the TS3 User Description select the option in the backend.


Commands

Write the command to the Bot with the active script.

!lolreload

reloads the rank of the client who executes the command

!lolreload all

reloads the rank of all clients. BEWARE that this script has no reate limiting included.

!lolignoreme

adds you to the ignore list (store) so that your in-game status is not displayed. This is simply a toggle. Write it a second time and you are removed from the list.

Optional Commands

!lolsetname <SummonerName>

sets the name for the user in his description. This is needed for clients to rename their own description, if the servergroups do not allow this. It is toggled to false in the SB backend by default.


Minimal Resources

The group gets added on event clientVisible. This means, in most cases it will update only when a user connects/reconnects, not on every channel switch. This means less script executions, in favor of your server performance.

"I chose this method purposely over event clientMove."

Provided by the Happy-Forever Gaming Community

Die Happys (link)


Credits

DrWarpMan from the SinusBot Forums -> drwarpman@gmail.com https://forum.sinusbot.com/members/drwarpman.12874/

DrWarpMan assisted me through parts of getting to know the SinusBot API. He has the capability to make any of your scripting needs reality in exchange for a donation. Hit him up at the above mentioned email, or via the Sinusbot Forums.

About

This plugin extends the sinusbot to connect with the RIOT API and get the correct rank, level, role and ingame-status

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published