-
Notifications
You must be signed in to change notification settings - Fork 132
Plugin Settings
Lusamine edited this page May 25, 2023
·
18 revisions
This page describes further settings that you can change to customize PKHeX-Plugins for your own use.
These can be accessed under Tools > Auto-Legality Mod > Plugin Settings
.
- LatestIP: Stores the last IP used by LiveHeX.
- USBBotBasePreferred: Allows LiveHeX to use USB-Botbase instead of sys-botbase.
- UseCachedPointers: If set to "true", Pointer Lookup (pointer reads and block key reads) will cache resolved pointer offsets, which makes them faster to access for later reads. Do not enable this unless you are certain that your pointer reads do not change during game operation, or else you may be reading/writing data at incorrect locations.
- EnableDevMode: DEVELOPERS ONLY. This setting ignores version mismatch errors between PKHeX.Core and Auto-Legality Mod, and skips Switch connection checks for correct game, correct versions, and correct sys-botbase. This should only be used if you understand what you have chosen to ignore; you may cause bad behavior in-game by writing into unknown RAM if you continue using this normally without understanding what you have done.
-
ForceSpecifiedBall: Attempts to use
Ball:
to specify the Poké Ball if legal. -
PrioritizeGame / PrioritizeGameVersion:
- If PrioritizeGame is set to
False
, ALM will ignore PrioritizeGameVersion and look for Pokémon encounters starting from the most recent game to the oldest game. - If PrioritizeGame is set to
True
and PrioritizeGameVersion is set toAny
, ALM will try to generate a Pokémon from the current loaded save game version first before checking other games. - If PrioritizeGame is set to
True
and PrioritizeGameVersion is set to a specific game, ALM will try to generate a Pokémon from that game first.
- If PrioritizeGame is set to
- SetAllLegalRibbons: Adds all ribbons that are legal according to PKHeX legality. In Generation 8 games, a random Mark will be added if it is legal. If you are setting ribbons with batch commands, disable this setting.
- SetBattleVersion: If enabled, ALM will set all past-generation Pokémon as Battle Ready for games that support it.
- SetMatchingBalls: Attempts to match a Poké Ball to the color of the Pokémon when legalizing. Nonshiny Pokémon colors are based on the Pokédex color, while shiny Pokémon colors are implemented specially for ALM.
- PrioritizeEncounter: Allows the user to set a custom priority order of encounters that will be used to generate Pokémon.
- EnableEasterEggs: Produces an Easter Egg Pokémon if the provided set is illegal.
- ** Timeout**: Maximum time in seconds to try a Pokémon set. This prevents the plugin from hanging on bad sets, but can fail to generate extremely niche sets if set to low.
- UseXOROSHIRO: Generates legal nonshiny raid Pokémon based on the game's RNG. Due to the restrictions of Xoroshiro, Pokémon IVs will very likely be imperfect and then Hyper Trained afterwards.
- Include Forms: Generates all alternate forms for available species. Some games/generations may not have enough box space for all of them.
- SetShiny: Try to generate Living Dex Pokémon as shiny if possible.
- AllowMismatch: If enabled, allows version mismatches between PKHeX and PKHeX-Plugins. Resets to warn again after each PKHeX.Core update.
- GPSSBaseURL: Base URL for GPSS features.
-
PromptForSmogonImport: Used for
Generate Smogon Sets
. If set to true, ALM will ask for approval for each set before attempting to generate it. -
UseCompetitiveMarkings / UseMarkings: If UseMarkings is enabled, markings will be applied when applicable for the Pokémon's IVs. These do not take Hyper Training into account and should not be confused with Marks.
- If UseMarkings is enabled and UseCompetitiveMarkings is disabled, ALM uses PKHeX's default behavior. An IV of 31 will be set to blue, and an IV of 0 will be set to red.
- If UseMarkings and UseCompetitiveMarkings are both enabled, ALM sets IVs of 31 blue and IVs of 30 to red.
-
AllowTrainerOverride: Accepts
OT:
,TID:
,SID:
, andOTGender:
as additional elements of a Showdown set. These may not be preserved if it is not possible for legality. - DefaultOT: Default OT name to use while generating Pokémon if no trainer data is found.
-
DefaultTID16/DefaultSID16: Default 5 digit TID and SID to use while generating Pokémon if no trainer data is found.
- Refer to this image to learn how to find these values; you should not be entering a 6 digit TID if you did this correctly.
- UseTrainerData: Enables use of custom trainer data. See the Using Custom Trainer Data page for how to set this up.
Information
Installation / Configuration
Features and Guides