LoLCupid Champion Recommendations - Rito API Challenge 2016
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
bin
config
db
doc
id_seeds
lib
log
public
test
vendor/assets
.gitignore
Gemfile
Gemfile.lock
LICENSE
Procfile
README.md
Rakefile
config.ru
riot.txt

README.md

LoLCupid

LoLCupid is a champion recommendation engine created for the April 2016 Riot Games API Challenge. The goal of the API Challenge was to:

Submit a piece of software that utilizes Champion Mastery data which excels primarily in one of the following categories:

  1. Entertainment
  2. Usability/Practicality
  3. Creativity/Originality

We chose to focus on usability/practicality, and created a tool that offers champion recommendations based on what you and thousands of other Summoners have already mastered. Are you a Wukong one-trick-pony looking to break out of your lane? We look at other Summoners who play a ton of Wukong and provide recommendations based on the champions they've also loved.

Due to time constraints, the website was optimized for the Chrome web browser. We recommend using Chrome for the complete experience.

This project was jointly created by Troy Baker (rekabat) and Zach Allaun (mutinyonthebay).

Tools and techniques

Ruby, Rails, and PostgreSQL are used on the backend to fetch and analyze Summoner and Champion Mastery data and serve recommendations. React and Redux are used on the frontend to render content and build interactive user interfaces. Heroku is used as a hosting platform.

Data fetching and analysis. Champion recommendations are the result of aggregating champion mastery information from thousands of Summoners; to provide quality recommendations, we must both continue to grow our dataset and keep it up-to-date. To that end, data fetching and analysis is done as a background process on an ongoing basis:

  • Hourly tasks fetch new mastery information from Summoners we already know about, helping ensure we have recent match data.
  • Daily tasks recompute champion recommendation scores based on our most recent mastery data. (The algorithm behind recommendations takes our entire corpus of Summoner and mastery data into account; it is a process that would take too long if repeated per-request, so we've developed it such that we can cache intermediaty results and final recommendation scores.)
  • Periodic (manually kicked-off) tasks grow our set of Summoners using recent match data from those Summoners we already know about. This process uses weighted sampling to ensure that our set of Summoners has a distribution of ranked tiers comparable to that of the entire playerbase (though we do sample Challenger and Master players disproportionately).

User interface. To convey results, we focused on creating a user experience that was simple, familiar, and compelling. We took cues from some of our favorite existing tools to create a set of UI elements that we hope League players will immediately understand.

Building up a team of champions using a Champion Select-inspired interface dynamically updates the set of recommendations you see on the right. We break it down by lane, highlighting the strongest recommendation and providing four secondary recommendations.

champion select

Hovering over one of our recommendations drops the Champion Select menu, providing an overview of that champion's abilities and some helpful links to learn more should you choose to try them out.

champion overview

Searching by Summoner name removes the Champion Select widget, offering recommendations tailored to that Summoner. Instead of weighting all of the input champions equally, we weight recommendations based on what the Summoner plays most. While it's fun to see how recommendations change as you add and remove champions, searching by Summoner will offer the best personalized recommendations.

summoner recommendations

Data collection

Integral to the application is a large collection of summoners on which to base the recommendations. Our collection of summoners on live is ~90k, coming from both the NA servers and EUW. Collecting this data was not a trivial task, and the script app/services/gen_ids.rb is interesting independent of the rest of the application. It first requires a seed of summoner names collected manually; we used ourselves, our friends, and some pros. Next we grow the database by selecting a random summoner already in the database and adding all of the summoners in their past ten matches (we only wanted players active since champion mastery came out.)

However, we also wanted the database to be approximately balanced by ranked tier, based on the assumption that this would give the most well-rounded recommendations. We found a breakdown of tiers from a third party source and manually added this to the script. Instead of randomly drawing from the database every time we wanted to grow, we determined the distribution of our database by tier and selected a summoner from the tier with the least summoners relative to the true distribution. Since people in a tier tend to play against summoners also in their tier, over a large number of samples this resulted in a well-balanced database.

Determining recommendations

For a detailed explanation of the math behind recommendations, see our About page.

Running the code

We assume you have the following installed and available:

  • Ruby 2.3.0 (we recommend rvm if you're on a Unix system)
  • PostgreSQL (if you're on a Mac, we recommend Postgress.app)

We also assume you have a Riot Games Developer account and an API key available to you.

Clone the project and install basic Ruby dependencies.

git clone https://github.com/zachallaun/lolcupid.git lolcupid
cd lolcupid
gem install bundler foreman

Set up your production API key.

If you have a temporary production API key available, you can create a .env file in the root of the project that looks like the below. If you have a developer API key, you can skip this step.

RIOT_API_KEY=MY_API_KEY
RIOT_REQUESTS_PER_10_SECONDS=1400
RIOT_REQUESTS_PER_10_MINUTES=85000

Set up your database and environment.

This will take a while, as it needs to make a number of requests to the Riot API to seed your database. This command will:

  • Create the database
  • Pull in all champions and their data
  • Fetch Summoner and mastery data using a seed of 50 Summoners
  • Pre-compute recommendation scores between each pair of champions
bin/setup

Start the server.

foreman start # visit http://localhost:5000