jhgaylor/statbot

A chat bot and web tools for League of Legends

StatBot

A chat bot and web tools for League of Legends

Live

• NA - StatBot
• OCE - StatBot
• EUW - StatPal
• LAS - StatBot

Purpose

The purpose of this project is to demonstrate how I work as well as build a useful tool for the community. It will be developed entirely in the open. Check the wiki for writeups describing the process, use the issue tracker to ask questions or report bugs, use pull requests to suggest fixes or add features.

What is it?

This project includes several components. Each component is documented further in its respective home.

LoLHubot

A hubot instance configured to connect to the Riot XMPP network. It also uses some custom scripts to enable other users on the XMPP network, LoL players, to send chat commands and get meaningful responses.

Built using:

• Hubot
• Hubot-xmpp
• Coffeescript

WebApp

The codebase that serves the web interface. The web app provides a way to manage the settings that the chat interface uses. While the chat interface can configure these things, a web application provides a more useable interface.

The WebApp will work as a LoL xmpp client allowing visitors to log in to chat with their LoL friends without having the full game client open. [Need to check into the rules for being a chat client]

Everything served by the web app will be served via HTTPS.

The application is built using the following tools:

• Meteor
• CSS - LESS
• HTML - jade?
• Javascript - Ecmascript5
• Bootstrap 3
• XMPP

MobileApp

The codebase to build the mobile application. It provides basically the same functionality as WebApp.

StatBotAPI

An application that serves the network APIs used by all the user facing applications. It provides a common end point for processing commands. This lets the codebase remain DRY.

This serves HTTP and WS apis. The HTTP api is used to receive commands from clients like WebApp, MobileApp, and LoLHubot. The WS api is used to proxy XMPP connections and stream data.

Built using:

• node - Ecmascript5
• express.js
• websockets

statbot's Issues

document the data structure the data sources are returning

Document: Tatum.io for docker orchestrations

document use of docker

can dockerhub automated builds work for multiple dockerfiles per branch?

lolhubot: help command should include link to HTML help

integrate logentries.com

send a welcome message when receiving a msg from someone for the first time this boot

privacy policy?!?!?

add support for other regions

I should be able to add support for each new region just by starting a new lolhubot on a different LoL account. Will just require registering an account on each region.

screen recordings?

lolhubot: pro builds

how do i manage statbot's friends list?

persistant datastore to store "authorized" users

this would let anyone friend statbot but be required to be an authorized user to send messages other than help and about.

This would provide me a way to approve people slowly at the beginning (by updating the db) and then use it in reverse as a ban list once it is open to the world.

lolhubot: useful links

links - provides a set of useful links rather than going to each site and clicking to the champion desired.

make an account for statbotdev

this is the bot running on my local machine while i mess with it.

LoLHubot: Test hear fns

It might be easiest to do this by stubbing out the robot and msg objects and testing them individually rather than booting the entire hubot

fuzzy name matching

chat command response formatting

always send new messages rather than trying to mess with newlines. it'll make things better in game and works fine in the lobby.

integrate statuspage

bug: errs out when getting ranked stats for someone with no stats

it does so silently as well...

track referrals - give points

considering https://logentries.com/ - waiting for response regarding pricing

Determine how to document Redis and MongoDB

promises are the basic unit of async

Configure CI+CD to keep lolhubot deployed

production - statbot

development - serve on a different handle

statbot: make it do *something* useful

api: rewrite

refactor the binding of commands to express routes.

pattern of /command/:name/: fn shouldn't be too hard.

Build Launch Page

After determining the tool to use. Since the marketing page isn't really part of the open source bit of this, I don't mind using a third party tool and just documenting what I do.

handle "twisted fate" as a champion name

find a way to clear cache (api server) w/o wiping the brain (lolhubot)

2 redis servers? or a more targeted flush?

lolhubot: ranked stats vs normal stats vs 3s stats

lolhubot: best and worst

best [ --role --season --region]

worst [ --role --season --region]

Feature Request: List all commands by themselves

Add ability to list all commands in one line, when I type help, I get full info and most commands scroll by.

Id like to be able to see this:

counter,rules,help,free,stats

Probably in alphabetic order.

This could be another command or at the end of help.

everything talks json over the wire

server load monitoring

demo video

lolhubot: track the "friend" action

lolhubot: most bought items for a champion

@Amos90 threw this one into the ring

To connect to league node-xmpp 0.3.2 won't work Instead use 0.12.0

lolhubot: clean up and document scripts.

lolhubot: lolnexus like data

game - provide a lolnexus like overview of the game summoner is in

example hubot

https://github.com/nhoag/bot

figure out how to lowercase all the references to summoner and champion names or to ignore case in the comparisons

Dockerize lolhubot

lolhubot: refer <summoner_name>

statbot sends a friend request to sajak, and upon acceptance, sends welcome message

api: errors getting swallowed

This thing swallows up errors... failed http requests, type errors, etc. Need better error handling on promises

Great example: https://github.com/jhgaylor/statbot/blob/master/statbot_api/src/DataSources.coffee#L20

Any exception from LoL is just going to disappear

get summoner names in hubot data. id is hard to work with

add lolhubot to this repo

and get it running ✨

lolhubot: full on CLI parser?

datasource: lookup roles (sorted by popularity) of a champion