RouteThree is a Pokémon game speedrun routing tool designed for Generation 3 games (Ruby/Sapphire/Emerald/FireRed/LeafGreen).
It is derived from Dabomstew & entrpntr's RouteTwo, itself derived from HRoll's RouteOne.

Syntax :
[YYYY/MM/DD] - version
► Compatibility-breaking update.
○ Usual update.

[2022/01/17] - v0.3.1
○ Added -noDoubleBattle/-nodouble command to force single battles.
○ Fixed a bug involving the -double battle modifier.

[2022/01/16] - v0.3
○ Added FireRed/LeafGreen support, and Fire Red Squirtle High Exp route file.
○ Added Emerald abraful route file.
○ Added battle option -doublebattle to force a double battle. Updated the .xml file accordingly.
○ Added most residual damages : poisoned, badly poisoned, burned, trapped, confused, seeded, nightmared and cursed.
○ Fixed a bug involving Special Defense of opponents not being modified properly.

[2022/01/13] - v0.2.1
○ Refactoring of the damage calculation and printing.
○ Implementation of Psywave, Flail, Rage, Rollout, Fury Cutter, Magnitude, Low Kick and Future Sight.

[2022/01/05] - v0.2
○ Added Emerald support (and trainer data).
○ Added Notepad++ .xml formatting file for route files.

[2022/01/02] - v0.1
○ Initial beta release.

The tool as been tested and is proven to work with Java 1.7 .

Download the latest release from this page.
Run the .jar file.

Download source files, and build the executable jar with Java 1.7 .
IntelliJ IDEA is known to NOT work, as the ini4j package doesn't seem to be compatible with this IDE.

All tag-value fields are of the following format : tag = value.
When values are filenames, they are case sensitive. Otherwise, they are case insensitive.
Filenames can traverse folders. For instance, test.txt, routes/route1.txt or ../../configs/config.ini are valid filenames.

The master.ini file is the entry point of the program. It allows you to choose which configuration file will be loaded by the tool.

A configuration file (generally with the .ini extension) gathers the primary information used in the route.

"command" : Every command will be put between quotation marks. You SHOULD NOT be writing these quotation marks in your routing files.
"alias" : An alias refers to a shorter name for a given command.
"CoMMAnd" : Every command is case-incensitive. You can capitalize at will.
○ The convention from the initial release is to keep commands lowercase, and names/moves/etc uppercase.
○ You can disobey this convention at will.
○ For readability purposes, the commands here will display some uppercase letters.
<ARGUMENT> : When using angle brackets, it refers to a mandatory argument. You SHOULD NOT be writing these brackets in your routing files.
[ARGUMENT] : When using square brackets, it refers to an optional argument. You can omit it if you don't need it. You SHOULD NOT be writing these brackets in your routing files.

The resources folder contains most of the data the tool loads. You can look into the different files to check on trainer names, item names, etc.

"//" : Starts a comment. Either at the start of a line or at the end of instructions. Used as documentation for the reader/router.

"money" : Displays the current Player money.

"ranges" : Displays a table of the main Pokemon stats for all DV values.
"stats" : Displays the main Pokemon stats as they are in the Pokemon menu.

Stats options :
"-b" : Add to account for stat badge boosts.

"evolve <SPECIES>" : Changes your Pokemon to SPECIES.
alias: "e"

Example : evolve COMBUSKEN // I'm Ryziken

"learnMove <MOVE>" : Learns move MOVE. MOVE is written with only letters (no spaces, no dashes, no underscores, etc.)
alias: "lm"

Example : learnmove HIDDENPOWER // "Any Pokémon is runnable with a proper Hidden Power" - Nobody, ever

"unlearnMove <MOVE>" : Unlearns move MOVE. MOVE is written with only letters (no spaces, no dashes, no underscores, etc.)
alias: "um"

Example : unlearnmove GROWL // Useless move

"rareCandy" : Uses a Rare Candy on your Pokemon.
alias: "rc"

"hpup" : Uses an HP Up on your Pokemon.
"protein" : Uses a Protein on your Pokemon.
"iron" : Uses an Iron on your Pokemon.
"calcium" : Uses a Calcium on your Pokemon.
"zinc" : Uses a Zinc on your Pokemon.
"carbos" : Uses a Carbos on your Pokemon.

"pokerus" : Infects your Pokémon with Pokérus. Allows to double EV yields until maximum values are reached.

"setBoostedExp" : Activates the x1.5 multiplier from traded Pokémon. (Should be useless, as it's an available setting in the config file.)
"unsetBoostedExp" : Deactivates the previous multiplier.

"equip <ITEM>" : Equips the item ITEM. If an item was already held, it is replaced by the specified one.

Example : equip SOFTSAND // Mud Slap go brrrr

"unequip" : Unequips the held item.

Here is an exhaustive list of items which effects are implemented :

These commands only affect money, since there is no inventory management.
"buy [QUANTITY] <ITEM>" : Buys ITEM QUANTITY times. ITEM only in letters. If QUANTITY is omitted, it defaults to 1.
"sell [QUANTITY] <ITEM>" : Sells ITEM QUANTITY times.

Example : buy 46 XATTACK // Zigzagoon, go !
Example : sell HPUP // Sells 1 HPUP

"addMoney <NUM>" : Adds NUM to player's money.

Example : addmoney 5000 // Long live the casino !

"spendMoney <NUM>" : Spends NUM money.

Example : spendmoney 50 // Museum entrance fee ...

Defeating Roxanne, Wattson, Norman or TateAndLiza automatically activates their respective badge boost.

The following commands give you the desired badge without fighting its corresponding Gym Leader.
This is useful when you route Pokémon you don't acquire/catch straight away.

"<NAME>" : Triggers a trainer battle against the trainer with name NAME.

"L<NUM> <SPECIES> <NATURE>" : Triggers a wild battle against a level NUM SPECIES with nature NATURE and perfect IVs.

Wild encounters options :
"<HP> <ATK> <DEF> <SPA> <SPD> <SPE>" : Gives IVs HP ATK DEF SPA SPD SPE to the wild encounter.

Example : L45 KYOGRE HASTY 27 31 7 25 18 26 // Fast Boi

"-trainer" : Sets the wild encounter as a trainer Pokemon. Mainly gives access to the x1.5 experience multiplier.
alias: "-t"

Example : L31 MILOTIC GENTLE -trainer // I don't remember this trainer name

"-wild" : Sets the wild encounter as wild. A wild encounter is wild by default, this option can be omitted.
alias: "-w"

For all battle options, x refers to the player, y refers to the enemy.
Any option starting with -x can be written starting with -y to have the same effect on the enemy team.

"-xitems <ATK>/<DEF>/<SPA>/<SPD>/<SPE>[/ACC][/EVA]" : Sets ATK X Attacks, DEF X Defends, etc.
alias: "-x"

Example : NORMAN -xitems 4/3/0/0/3/1 // Sets up 4 X Attacks, 3 X Defends, 3 X Speeds & 1 X Accuracy for the player for the whole battle

All the following commands apply for the entire duration of the battle.
NUM should be an integer between -6 and +6. Positive numbers can omit the + sign.
"-xatk <NUM>" : Sets up NUM X Attacks.
"-xdef <NUM>" : Sets up NUM X Defends.
"-xspa <NUM>" : Sets up NUM X Specials. Only applies to the Special Attack stat.
"-xspd <NUM>" : Boosts Special Defense NUM times. Useful for Amnesia, etc.
"-xspe <NUM>" : Sets up NUM X Speeds.
"-xacc <NUM" : Sets up NUM X Accuracies.
"-xeva <NUM" : Boosts EvasionNUM times.

Example : LANCE -xspd 1 -xspc 2 // Sets 1 X Speed & 2 X Specials forthe entire fight

"-xatks <FIRST>[/SECOND...]" : Sets up FIRST X Attacks for the 1st Pokemon, SECOND X Attacks for the 2nd, etc.
"-xdefs <FIRST>[/SECOND...]" : Sets up FIRST X Defends for the 1st Pokemon, SECOND X Defends for the 2nd, etc.
"-xspas <FIRST>[/SECOND...]" : Sets up FIRST X Specials for the 1st Pokemon, SECOND X Specials for the 2nd, etc. Only applies to Special Attack.
"-xspds <FIRST>[/SECOND...]" : Applies FIRST Special Defense boosts for the 1st Pokemon, SECOND Special Defense boosts for the 2nd, etc.
"-xspes <FIRST>[/SECOND...]" : Sets FIRST X Speeds for the 1st Pokemon, SECOND X Speeds for the 2nd, etc.
"-xaccs <FIRST>[/SECOND...]" : Sets FIRST X Accuracies for the 1st Pokemon, SECOND X Accuracies for the 2nd, etc.
"-xevas <FIRST>[/SECOND...]" : Applies FIRST Evasions boosts for the 1st Pokemon, SECOND Evasions boosts for the 2nd, etc.

Example : GLACIA -xspas 0/0/2/2/2 // Sets up 2 X Specials on her third Pokemon

"-sxp <NUM>" : Divides all earned experience by NUM.
"-sxps <FIRST>[/SECOND...]" : Divides first enemy Pokemon experience by FIRST, the second by SECOND, etc.

Example : TATEANDLIZA -sxps 2/1 // First Pokémon is KOed with an ally on the field, but the second one is defeated alone

"-weather <WEATHER>" : Sets the weather for the entire battle.
"-weathers <FIRST>[/SECOND...] Sets the weather FIRST for the first enemy Pokémon, weather SECOND for the second one, etc.

Arguments : within NONE/RAIN/SUN/SANDSTORM/HAIL (NONE can be replaced by 0).
Example : FLANNERY -weather SUN // Sunny Day !

"-xstatus <STATUS>" : Sets the "desired" status.

Arguments : within SLEEP/POISON/BURN/FREEZE/PARALYSIS/TOXIC.
Example : BRAWLY -xstatus BURN // Gust all the way !

"-xstatus2 <MOD1>[/MOD2...]" : Sets a list of battle modifiers.

Example : TATEANDLIZA -ystatus2 REFLECT/LIGHTSCREEN // The enemy side sets up both screens

Here is the exhautive list of implemented modifiers :

-xtorrent, -xblaze, -xovergrow, -xswarm : Activates the corresponding abilities.

"-order <FIRST>[/SECOND...]" : Switches the enemy team order.

Note : Useful for good AI trainers who send stronger Pokemon first.
Example : "WATTSON -order 1/3/2 // Sends 1st Pokémon, then the 3rd, then the 2nd

"-doubleBattle" : Forces the battle to be a double battle. Useful for move damage calculation only.
alias: "-double"
"-noDoubleBattle" : Forces the battle to be a single battle. Useful for move damage calculation only.
alias: "-nodouble"

"-lvstats" : Outputs player Pokemon stats when a level up occurs during a battle.
"-lvranges" : Outputs player Pokemon ranges when a level up occurs during a battle.

"-verbose <LEVEL>" : Activates output for the desired battle.
alias: "-v"

Argument : within NONE/SOME/ALL/EVERYTHING or 0/1/2/3.
Note : -v 0 is equivalent to skipping output for the battle.

○ Probably a lot.

○ Much more than this page can ever contain.

PokemonSpeedruns Discord server (archived)

Gen 1-3 Pokemon Speedrunning Discord server

HRoll (2) - for making the original RouteOne which contributes 80% of the code for this

Mountebank - for contributing to the development of the original RouteOne

SpeedRunsLive - for inspiration/awesome races

Dabomstew - for porting RouteOne to fit Gen 2

entrpntr - for the attention to details and the various ideas