[READ-ONLY] Mirror of https://github.com/glacials/splits-io. a speedrunning data store and analysis engine splits.io
splits-io README.md
3.6 kB · 101 lines
Markdown

Splits I/O #

Splits I/O is a website similar to Pastebin or GitHub Gist, but for splits generated from speedruns rather than text or code. It's written in Ruby on Rails.

Splits I/O currently supports splits from ShitSplit, Splitty, Llanfair2, FaceSplit, Portal2LiveTimer, LlanfairGered, Llanfair, Urn, LiveSplit, SplitterZ, TimeSplitTracker, WSplit.

API #

For full API documentation, see the API readme.

Running locally #

Splits I/O runs on Docker, which makes it easy and consistent to set up and run on any machine despite any unusual dependencies. The one downside is that you must first install Docker!

Requirements #

First run #

The first time you run Splits I/O with Docker is the best, because you'll have time to get a coffee! Yum! After the first run, it will be much quicker.

make

Once the output looks settled, you're good to go! Access localhost:3000 in your browser. The first page load after a new build may also take a minute.

Accounts (optional) #

Splits I/O accounts are built on top of Twitch accounts, so if you want sign up / sign in to work, you will need to register a Twitch application at dev.twitch.tv/dashboard. Use this redirect URI when asked:

http://localhost:3000/auth/twitch/callback

Twitch will give you a client ID and a client secret. Open Dockerfile and find the spots to fill in. Then run

make build

before starting the server again and you're set!

Note: Never commit your client ID or secret!

Debugging #

Getting up and running #

If you're having trouble getting Splits I/O running at all using the above instructions, please make a GitHub issue so we can work it out! Even if you think it's a silly issue, the fact that it's happening to you means we haven't ironed out everything (even if the only thing preventing you from setting up is better documentation!).

Working with the code #

If you have the app up and running but are looking for insight into debugging your own changes, you can access a Rails console inside the Docker container with

make console

Running tests #

To run tests from inside the Docker container, use

make test

Linting #

We use Rubocop for code cleanliness and styling. To run it against changed files, commit your changes and run

make lint

Updating gems or Docker #

If you change the Dockerfile or Gemfile, you'll need to run

make build

to rebuild the Docker image for your changes to apply.

Library information #

LiveSplit Core #

Splits I/O uses livesplit-core for parsing. The parser is located in lib/parser/*. To upgrade it, run

make update_lsc

and commit the changes.

Highcharts #

To generate run history charts Splits I/O uses Highcharts, which requires a written license. Licensing is based on the honor system, so you do not need to enter a key anywhere. Highcharts is free to use for testing purposes.