-
Notifications
You must be signed in to change notification settings - Fork 0
Custom Rulesets
Rulesets are specified in .json files. A number of default rulesets ship with the mod download, but additional custom rulesets can be added by creating new ruleset files in the Modding Folder. The default location for this folder is <LLB install location>/ModdingFolder/TourneyMod/rulesets-custom/.
The mod automatically loads all default and custom rulesets on startup, displaying a description of each of them in ModMenu.
To see an example for formatting a ruleset file, see rulesets-default/ in the repository.
Rulesets require the following information:
This is the code by which your ruleset can be selected in the mod's config or in ModMenu. This is case sensitive and should be unique to ensure the mod can find your correct ruleset.
This is the full name of your ruleset. It is currently only shown in the ruleset descriptions in ModMenu.
Stages are specified by their id in the LLB game code. The mod will automatically lay out the stages specified in each list, up to a maximum of 9 total stages between both lists. The order in each list will change the order that the stages are displayed on screen. The valid stage ids are:
-
"OUTSKIRTS"- Outskirts -
"SEWERS"- The Sewers (Sewers) -
"JUNKTOWN"- Scrap Desert (Desert) -
"CONSTRUCTION"- New Rise District (Elevator) -
"FACTORY"- Workbot Factory (Factory) -
"SUBWAY"- The Subways (Subway) -
"STADIUM"- Paradise Field (Stadium) -
"STREETS"- Central Streets (Streets) -
"POOL"- Abandoned Pool (Pool) -
"ROOM21"- Room 21 -
"OUTSKIRTS_2D"- Outskirts (Retro Outskirts) -
"POOL_2D"- Abandoned Pool (Retro Pool) -
"SEWERS_2D"- The Sewers (Retro Sewers) -
"ROOM21_2D"- Room 21 (Retro Room 21) -
"STREETS_2D"- City Streets (Retro Streets) -
"SUBWAY_2D"- Hammer Express (Retro Subway) -
"FACTORY_2D"- Workbot Factory (Retro Factory)
A list of the stages that can be selected during any game.
A list of stages that are locked in game 1. These will appear grouped separately from the neutral stages and will be banned automatically with a special indicator for game 1 of a set.
A 2D array specifying a list of ban amounts in each game of the set. For each game, the list of ban amounts specifies the amount of bans a player should get before switching to the next player. Once the bans run out, the next player enters pick mode.
Some examples of ban amount lists include:
-
[0]- The first player picks. -
[3]- The first player bans 3, then the second player picks. -
[1, 2, 1]- The first player bans 1, then the second player bans 2, then the first player bans 1, then the second player picks.
The ban amount list used corresponds to the current game being played in the set. If the current game number is greater than the number of lists provided, the last ban amount list will be used.
The player who starts the order on game 1. This is specified by the player index, so 0 is P1 and 1 is P2.
The player who starts the order after game 1. This can be either "WINNER" or "LOSER", referring to the winner/loser of the previous game.
Whether DSR is used, which prevents players from picking a stage they have previously won on. This can be one of the following:
-
"OFF"- DSR is not used: no restrictions on stage picks -
"FULL_SET"- DSR is used: players can't pick a stage they have won on at all this set -
"LAST_WIN"- DSR is used: players can't pick the last stage they won on