Customizing Grading Modes

Intro

This is a simple guide on how to customize your grading modes or add new ones.

The Configuration File

The file that determines grading modes should be saved in your config folder as gradingModes.txt

Open that file in a text editor like NotePad++.

The Syntax

Each GRADING_MODE entry corresponds to an entry in the grading modes available for sorting results. The format is rather simple:

GRADING_MODE <NAME> <SORT_ARGS> <true/false>

• GRADING_MODE is mandatory, to designate that this line defines a grading mode.
• <NAME> can be either a key from the i18n file here, or your own UNIQUE name (any duplicate names are ignored/erased).
• <SORT_ARGS> is a list of sorting comparators, as defined below.
• <true/false> is either true or false to specify if the given name is a custom name or not. If you want it to look it up as i18n then specify false. If you want it to ignore i18n then specify true.

Note: All SORT_ARGS lists given will be internally appended by the default grading mode description as specified here which as of v0.3.33 is GOLD,SCORE,COMBOS,DISRUPTIONS,BLOCKS,PROGRESS,MOVE.

Sort Arguments

All available sorting arguments are specified here, but here is a simple list with a description for each:

• GOLD: Sorts descending by Gold
• SCORE: Sorts descending by Score
• COMBOS: Sorts descending by Combos matched
• DISRUPTIONS: Sorts descending by disruptions cleared (number of thaws + number of wood cleared + number of metal cleared)
• BLOCKS: Sorts descending by number of blocks cleared in total (thaws don't count)
• PROGRESS: Sorts by descending final mega progress
• MOVE: Sorts ascending by move coordinates
• NOCOIN: Sorts by putting all non-gold moves at the top, followed by the descending order of Gold
• GOLD_THRESHOLD: Sorts by putting all Gold-producing moves at the top, and all non-gold moves at the bottom (no order within the groups)
• COMBOS_THRESHOLD: Sorts by putting all Combo-producing moves at the top, and all non-combo moves at the bottom (no order within the groups). This may seem useless, since it doesn't do anything on its own, but it is meant to be used with the threshold value in front of it - like 3COMBOS_THRESHOLD making all 3+ combos go to the top and everything else get sent below, to allow them to be sorted within the two categories without any issues.

Extra Syntax

Threshold

For all of the sorting methods except for Move and NoCoin you can specify a number in front of the argument, moving a threshold. Anything above the threshold is treated normally, and anything below it is treated as equal to all others below the threshold.

An example of using the threshold:

700GOLD

• This will sort descending by Gold, but anything below 700 Gold will be unsorted and placed at the bottom.

Negation

For all sorting methods you can negate the result by leading the argument with a - sign.

An example which would sort this way:

-700GOLD

• This will sort putting all results below 700 Gold at the top (unsorted) followed by an ascending amount of Gold towards the bottom.

Putting it all together

Example 1

GRADING_MODE WeekendMeowth 700GOLD,3COMBOS_THRESHOLD,BLOCKS,COMBOS,GOLD true

Called WeekendMeowth, this will sort all gold above 700 first, then in the remainder put 3+ combos at the top, and the rest at the bottom. In these two halves they are then sorted by blocks, combos, and gold in descending order. The name "WeekendMeowth" will be used as-is and not looked up in the i18n.

Example 2

GRADING_MODE 4CombosOrMore 4COMBOS_THRESHOLD true

Called 4CombosOrMore, this will put all moves that produce 4 or more combos in the top and the rest at the bottom. The name "4CombosOrMore" will be used as-is and not looked up in the i18n.