Skip to content

Latest commit

 

History

History
101 lines (76 loc) · 5.43 KB

README.md

File metadata and controls

101 lines (76 loc) · 5.43 KB
Raw

PKHeX Automatic Legality Mod

PKHeX Automatic Legality Mod is for being able to make instant legal Pokémon on PKHeX using just a Pokémon Showdown teambuilder template.

What is a mod exactly? In this case a mod is somewhat like a macro being used in the given framework without being greatly changed from the original and also making the Pokemon legal.

This repository contains the files needed to set up your own PKHeX build with all the amazing stuff that it has as well as the Pokemon Showdown Mod in it.

For more information on building and usage, contact me on Discord at thecommondude#8240

The teambuilder for the Pokemon templates can be found on: Pokémon Showdown

Features

  • Legality for all egg based Pokemon
  • Legality for all legendary Pokemon from all generations
  • Auto Legality support for all Pokemon in all generations except Colosseum and XD
  • Mystery Gift Legality based on mgdb database provided
  • Supports HaX easter egg in PKHeX
  • Supports box/team imports (Sets it to the current box)
  • Supports custom OT, TID, SID setting whereever possible.
  • Supports error handling for -Mega and -Busted pokemon (All megas and mimikyu)

Known Issues

  • Issues with legalizing Shiny Groudon and Shiny Kyogre. This is because of PID mismatches in Gen 4 Games. (Its being resolved) [RESOLVED]
  • No proper error handling for -Mega or -Busted forms. (This should be added in the next commit) [RESOLVED]

(Requires a C# IDE such as Visual Studio 17 or Mono Develop)

How to quick set-up the mod.

  • First of all download PKHeX by doing the following.
$ git clone https://github.com/kwsch/PKHeX.git
  • Copy the files in this repository to the PKHeX repository while following the directory structure.
  • Open the .sln solution file using Visual Studio 17 / Mono Develop.
  • It is always a good practice to build the solution first to resolve any unresolved errors with the solution.
  • To do this, right click on the main PKHeX project and click on Rebuild all. Wait for the whole process to finish.
  • Add the AutoLegality folder by dragging and dropping the AutoLegality folder inside PKHeX.WinForms subproject.
  • Inside the AutoLegality/Resources/byte folder click on reset.pk7 file and set it as an Embedded Resource in the property box below.
  • Inside the AutoLegality/Resources/test folder click on evolutions.txt file and set it as an Embedded Resource in the property box below.
  • Go to MainWindow folder and open the Main.Designer.cs file.
  • Search for the line this.Menu_Showdown.DropDownItems using Ctrl + F.
  • After the semicolon (;) write this line of code on the next line
            this.Menu_Showdown.DropDownItems.Add(EnableAutoLegality(resources));
  • Right click on the main PKHeX project and click Rebuild all.
  • The output of the PKHeX file should be in PKHeX\PKHeX.WinForms\bin\Debug folder.

[OPTIONAL] Custom TID, SID, OT settings.

  • Create a new text file called trainerdata.txt in the same directory as PKHeX.exe
  • Inside the directory paste your TID, SID ,OT, Gender, Country, SubRegion and 3DSRegion based on the sample given below.
  • Note: Follow the format of the sample given below. DO NOT change the format. Just edit the values.
  • The trainerdata.txt format should be as follows:
TID:12345
SID:54321
OT:PKHeX
Gender:M
Country:Canada
SubRegion:Alberta
3DSRegion:Americas (NA/SA)
  • Gender can be specified as M or F or Male or Female
  • Country, SubRegion and 3DSRegion have to be spelt exactly as one of the options on PKHeX. Any spelling errors WILL fail.
  • To ensure proper legality in regards to Country, SubRegion and 3DSRegion, make sure that the SubRegion actually belongs to the Country, and the Country actually lies in the 3DSRegion.

Credits to the several people who requested this in GitHub Issues

[OPTIONAL] Addon Legality mods:

The instructions for each one of these will be located within their own folders within the Addons (Optional) folder in the repository Current Addons:

  • PGL Rental QR Teams auto legal genning. Also copies the Showdown spread to clipboard for convenience.
  • .... Work in Progress :]

Adding Priority to event searches.

  • If you would like to have certain events to be scanned first (eg Gen7 events or Gen6 events etc.) do the following:
  • Set an order of priority to your folders in the mgdb folder.
  • For example if you want Gen7 folder to be scanned first, you can rename the folder as 01_Gen7 to set its priority as 1 so it will be scanned first. You can do the same for any folder you wish to have second/third/fourth priority and so on.
  • This will help reduce time in event scanning since with all events in the folder, a full top to bottom scan can take upto a good five minutes.
  • The time complexity right now is O(n) and is planned on being reduced for faster searches, but this is a nifty trick for now.

Maintainers

Just me right now, but if you want to contribute, feel free to contact me on Discord at thecommondude#8240

Credits

  • IV to PID conversion code taken RNGReporter by Admiral-Fish which is under the GNU General Public License v2.0.
  • My good friend TORNADO for helping me with Test Cases
  • Speed Improvement ideas by Bernardo Giordano
  • kwsch for the original PKHeX repository.