Speedrun.com Knowledge Base
Editing A Leaderboard
Clicking on the Edit Game option in the left navigation bar of the Game Page allows moderators to configure and set up their leaderboards. The first tab is the Info tab and is home to a number of options to configure the leaderboard.
Name is the display name of the leaderboard. This is the name by which it can be found using the navigation bar at the top of Speedrun.com.
The Twitch Name is the name of the game as it's shown in the Twitch directory and could be slightly different from the name used on Speedrun.com. This allows Speedrun.com users who are currently streaming using a matching game name to have their streams appear in the Streams tab accessible through the left navigation bar of the leaderboard.
- URL: The URL is the link to the leaderboard as browsed over the web and should be kept short and adequate. It’s usually set as an acronym. Examples: /oot /mm /mp /sms
- Cover / Japanese Cover: Moderators can set the cover of a game here. Preferable sizes are around 256x360.
- Platforms: Set and remove platforms here. Click on “Show obscure platforms…” below the list to show additional, less common platforms.
- Regions: Set the Regions applicable to the game. If a game was released worldwide, regions are best kept empty.
- Game types: Game types are a separate variable to the leaderboard that define a different type of leaderboard, ex. a leaderboard being a modification to an already existing game, a fangame, a category extension, or various others. These game types can only be set by Speedrun.com Site Staff and must be requested through this thread.
Many specific variables for the leaderboard can be adjusted at the bottom of the Info tab.
- Times in milliseconds: Flipping this option ON will allow the leaderboard to show milliseconds by default. Please note that does not affect actual submissions, but rather how the leaderboard is displayed. Milliseconds can be used in submissions by default, but a community can choose to not display milliseconds on the leaderboard itself. \ \ Additional note: Flipping off Times in milliseconds does not remove the milliseconds from runs. It only hides them, causing runs that should be tied after flipping off the option to still be separated in placement.
- Separate Load times: Flipping this option ON will change the options in the Default Timing Method to Time with loads and Time without loads. It also adds these two options to new run submissions. Which of these variables are used by default is determined by the option Default Timing Method. These two options use the Real Time (RTA) timing method.
- In-game timer: Flipping In-game timer ON will (also) add the In-game time option to the Default timing method. This option can be flipped on in combination with Separate load times. The “Ingame time” refers to an internal clock/timer within a game that tracks in-game progress.
- Default timing method: This option determines what default timing method the leaderboard will filter submissions by. Communities can choose to allow multiple timing methods to be included in their submissions, such as RTA and IGT, but leaderboards can only filter submissions through one default timing method.
- Show empty time columns (ON by default): Flipping this option OFF will hide empty columns if a leaderboard tracks additional timing methods, but hides the additional timing method column if a run doesn’t have that timing method filled in.
- Runs require verification (ON by default): Flipping this option OFF will allow speedruns to be submitted and verified without moderator verification. We recommend you do not flip this option OFF.
- Runs require a video (ON by default): Flipping this option OFF will allow speedruns to be submitted without including a video link.
- Emulator runs (Shown by default): This option will determine whether Emulators are shown or hidden by default, or banned completely. If emulators are banned, the below message appears when submitting a run:
- Regions obsolete each other (ON by default): Determines whether runs by the same player(s) with different regions should both be shown or only the fastest.
- Platforms obsolete each other (ON by default): Determines whether runs by the same player(s) on different platforms should both be shown or only the fastest.
- Default view: This option determines whether the main page of the respective leaderboard will display the Full Game or Individual levels by default.
In the Categories tab, a moderator can create categories on the leaderboard and set up leaderboard rules. Categories should be kept distinct. Each one should have a unique objective to warrant being its own category. Category names should be kept short and be made explicit to their objective. Example: “Any%” refers to the goal of a game's completion regardless of how much is unlocked.
Main Rules: These contain the leaderboard’s main rules, and are to be applied to all leaderboard full-game categories as well as individual level (categories). Category-specific rules should further specify rules that apply to a unique category. Main rules should ideally be as exhaustive and extensive as possible, although a rule should only be considered a ‘Main Rule’ if it’s a rule that applies to a large majority of the board, if not the entire leaderboard.
Main Rules should typically look to (but not limit themselves to) contain the following rules:
- Leaderboard’s timing method(s). That includes the necessity of a LiveSplit timer. Ex. in a situation of a loadless real-time timing method, or in-game timing methods.
- Run requirements; settings, frame rate, audio, UI visibility, etc..
- Submission handling; video proof, use of milliseconds, variable information, platforms, etc..
- Other restrictions that apply to the whole leaderboard; banned hardware (controllers, adapters), emulators, console specific rules, version handling, run pausing, etc..
Full-game categories: These are categories that apply to the extent of the full game and should be created with objectives in which a user plays the full game (or at least most of it), as opposed to an individual level of a game. Click the New category button to create a new category.
The Arrow keys can be used to change the order of the categories on the leaderboard. The category at the top will always display the first category when clicking the leaderboard and starts on the left side of the leaderboard.
Clicking the vertical ellipsis (three dots) icon will reveal two more options: Edit Category and Delete Category. Delete Category will give a prompt- warning a moderator that deleting the category will also delete any runs associated with it.
Clicking Edit Category will reveal a new window in which additional options can be set and edited.
Name: The name of the category.
- Rules: Set the rules of the game here. The rules of the game should usually be as extensive as possible and typically include:
- The objective of the category/speedrun
- Category restrictions
- Category specific rules
- Version specific information
- Resources and tools that can/are to be used in the specific category
- Player count: This determines how many players perform the speedrun in a category.
- Misc. : Flipping this ON will make the category miscellaneous and hide the category from the “main” categories:
- Timer asc. : This will make the times in the category be sorted highest first instead of lowest first.
Individual levels (ILs) refer to tracking individual levels of a full game and consists of a player completing a single level as fast as possible. What dictates an “individual level” differs from game to game.
Individual level categories should be used to further split individual levels into different, unique categories, as demonstrated in the example above. Subcategories from individual level categories can be further defined within the board’s Variables tab, and can be applied to single levels or All levels.
Under the vertical ellipsis, unique rules can be set for both ILs and ILCs. Note that the board’s Main Rules also apply under the IL and ILC rules.
While the Default View of your leaderboard is Full Game at the bottom of the Edit Game option, ILs can be found in the left navigation bar at the main page of the leaderboard.
In the Moderators tab, leaderboard moderators can be added and removed as well as have their level of control on the leaderboard adjusted. Only Regular and Super Moderators can view this page, and permissions of Super moderators can not be adjusted by Regular moderators. All moderator permissions can be reviewed in the Moderator Rules.
The Tags tab allows moderators to set a number of tags on their leaderboard.
- Series: These are set by Speedrun.com Site staff when a game is part of a series.
- Genre: Set the genre applicable to your game. Examples: RPG / Action / Horror / Puzzle.
- Engine: Set the engine on which the game runs / is created on. Examples: Unreal Engine, Frostbite, CryEngine, id Tech, etc..
- Developer: Set the developer of the game. Examples: Bethesda, EA, Activision, etc..
- Publisher: Set the publisher of the game. Examples: Nintendo, Sony, Xbox Game Studios, Tencent Games, etc..
Under the Variables tab moderators can create extra variables for the leaderboard to track. Variables can be used in a number of ways, such as to allow users to insert a custom, unique variable during their submission or to split categories further into Sub categories
Adding variables should be handled with care as it further separates categories, creating multiple new sub categories when applied to every category or individual levels, and should therefore be properly considered before applying to a category or even a leaderboard in general.
Variables can be a confusing aspect when handling leaderboards. Speedrun.com recommends approaching Site staff if a moderator or community has questions about how these work before applying them to the leaderboard.
Click on the New Variable button to start creating the first variable. In this particular example, the objective is to create a variable that lets us track a Difficulty option in a speedrun.
After creating a new variable, a value is necessary. The values in this case will be Easy, Normal, and Hard as these are the three difficulty values that will be tracked.
Clicking the vertical ellipsis (three dots) icon next to the variable will reveal three more options:
- Set the default for all runs without a value: If a leaderboard is filtering by a variable that was created after runs were submitted, the original runs may not show up on the leaderboard due to their lack of the variable. By setting a default value for all the runs without a value, runs submitted before the variable was created will be assigned a value and will show up on the leaderboard.
- Delete variable: This will delete the current variable and make all runs invisible that had this variable attached. These invisible runs can be made visible again by pressing the Set the default for all runs without a value option for a new or existing other variable that is applicable to these runs. Note that these runs are not gone/deleted, they are simply invisible until a new variable has been assigned to them.
- Edit Variable: This allows for further editing of the variable that has just been created. A new window should appear with new options:
- Name: The name of the variable.
- Level: This option determines whether the variable is applied to the Full Game and all Levels, only the Full Game, or only All Levels.
- Category: This option determines whether the variable is applied to All categories, or only a specific category.
- Required: Flipping this ON will require a value for this to be entered when submitting a run of whether it can be left blank.
- User defined: Flipping this ON will allow users to enter custom values in addition to the ones predefined on this page.
- Values obsolete each other: Determines whether runs by the same player(s) with different values should both be shown or only the fastest.
- Use as sub-category: Shows each value as a separate subcategory. This requires a default value. Flipping ON the option Use as a sub-category will result in that our variable called Difficulty with values Easy, Normal, Hard is now applied as a sub category for all categories.