Import note: a new version is in development for Win10 platforms. This version was poorly written, and uses threading rather than using the full extend of the speedrun.com API. You can follow the repository here: https://github.com/TimeTravelPenguin/SRCom-Leaderboard-Downloader
SLE is a program that exports basic speedrun.com leaderboard information for data analysis. It helps to aid in the documentation of speedruns at a given time from speedrun.com
Important Note: SLE currently does NOT list all usernames for speedruns where more than one user participates. SLE will export the first user per run.
To export a speedrun's leaderboard from speedrun.com, simply edit the config file, run the program, and click the appropriate prompts.
In the config file, you can modify the target user, game, category, and any query you wish to apply. This is where a little bit of research and knowledge come in. Locate your speedrun leaderboard on the speedrun.com website, and find the game's ID. This is in the URL. An example would be SMO for Super Mario Odyssey, or, https://www.speedrun.com/smo.
Similary, you need to find the category ID by doing a similar method. Once on the website, click on the category and find it in the URL. For example:
- https://www.speedrun.com/smo#Any -> category = 'any'
- https://www.speedrun.com/smo#100 -> category = '100'
- https://www.speedrun.com/smo#All_Missions -> category = 'All_Missions'
Note that some leaderboards can be a little funky due to how they have been set up, and filtering with "variables" may be a neccisary requirement for optimal results. This will be made simpler in future updates. For more information about query types, check it out here.
More information can be found by looking into the speedrun.com API, which can be found here.
As you will see within the config file, there is a query option. By doing some simple research here and here especially, you can filter things out!
On top of this, there are variables, which are a little more complex. Some speedrun categories, such as the SM64 16 Star category, has several 'variables'. On this leaderboard in particular, there are 3 choices for 'Platform'. That is, Platform can be N64, VC, or EMU. If you wish to filter N64 runs ONLY, you can add the variable to the query.
Adding to the query is simple. Assume you wish to filter out all Emulator runs. Do do so, in the query section of the config file:
query = '?emulators=False'
If you also wish to limit this to the top ten, you can do so by:
query = '?emulators=False&top=10'
Variables work the same, although slightly more complex. Within the program, there is an option to search for variables. This is based off the game within the config file. It will then return a list of, what I call, 'Parent' varibles. From before, 'Platform' would be the parent variable, and the child variables would be 'N64', 'VC', and 'EMU'.
Once you run the script, you will need to copy the VARIABLE IDs, which are conveniantly enclosed in parenthesis. Once you have you parent and child IDs, throw them into the query as followed:
query = '?var-{PARENT ID}={CHILD ID}'
To give a complex example, let's say you wanted the top 10 N64 runs of SM64 0 Star. The query would be as followed:
query = '?top=10&var-e8m7em86=9qj7z0oq'
Once the script is completed, you will have a .txt file with each line containing something similar to these
Each line has each data separated by a tab space, allowing for an easy import into spreadsheets (e.g. Microsoft Excel), for easy graphing, or analysis
The latest release can be downloaded from the Releases Page. From here, the .zip file of recent build can be found. The files can then be extracted and opened.
As of the current build, it has the following system requirements:
- python 3
- the following python libraries (there is an installer to aid you in the download): Gevent
Some leaderboards have 'subcategories', filtered by things called 'variables'. At current, my program cannot filter these (easily) automatically, but there is a helpful variable search tool built in, so you can add a variable querey in the config.py file.
Some exmples are:
- Super Mario 64 - 16 star: N64, EMU, VC
- Super Mario Odyssey - any%: 1 Player, 2 Players
The leaderboard currently combines ALL runs. But, it will handle this in the future!