DISCONTINUATION NOTICE (MOD MOVED TO THIS REPOSITORY) The development on this repository has been discontinued since 23/11/2018. The project is being continued in the form of plugins, which is a much more elegant way of handling mods. It is also easier to build and distribute to users. The plugins are being developed and released in the PKHeX-Plugins repository Thank you for your continued support with this 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
The latest builds can be tested by users. They are available for download in the #builds channel in the Discord server. These builds may be unstable sometimes so there might be some bugs. For a more stable experience with tested features, use the latest releases!
A COMPLETE LIST OF FEATURES CAN BE SEEN HERE
mgdb
database providedn
available slots in the current box (n
is the number of pokemon being imported)Ctrl
key while mass importing to replace the first n
slots in the boxCtrl + I
txt
file as long as it is properly formatted.If you plan to build the mod with all of its sub modules, the instructions below are more helpful (Installing the Mod + Addons)
(Requires a C# IDE such as Visual Studio 17 or Mono Develop)
First of all download PKHeX by doing the following.
$ git clone https://github.com/kwsch/PKHeX.git
.sln
solution file using Visual Studio 17 / Mono Develop.AutoLegality
folder by dragging and dropping the AutoLegality
folder inside PKHeX.WinForms
subproject.AutoLegality/Resources/text
folder click on evolutions.txt
file and set it as an Embedded Resource
in the property box below.MainWindow
folder and open the Main.Designer.cs
file.this.Menu_Showdown.DropDownItems
using Ctrl + F
.;
) write this line of code on the next line this.Menu_Tools.DropDownItems.Insert(0, EnableMenu(resources));
this.Menu_AutoLegality.DropDownItems.Add(EnableAutoLegality(resources));
PKHeX\PKHeX.WinForms\bin\Debug
folder.lxml
installed, use the following command to install lxml
pip3 install lxml
AutoLegality
folder, the Addons (Optional)\PGL QR Auto Legality\PGLRentalLegality
folder and the Addons (Optional)\MGDB Downloader\MGDBDownloader
folder over to PKHeX.WinForms
folder in your PKHeX directorybuild-mod.py
to PKHeX.WinForms
PKHeX.WinForms
and type the following command
py -3 build-mod.py
https://www.youtube.com/watch?v=Yak_eNAUO7I&feature=youtu.be
trainerdata.txt
in the same directory as PKHeX.exe
Automatic TID, SID, OT, Country, Sub Region, Console Region settings
trainerdata.txt
write auto
and save.Specific/Fallback TID, SID, OT, Country, Sub Region, Console Region settings
trainerdata.txt
format should be as follows:
TID:12345
SID:54321
OT:PKHeX
Gender:M
Country:Canada
SubRegion:Alberta
3DSRegion:Americas (NA/SA)
M
or F
or Male
or Female
trainerdata.txt
is auto
, it will check for the above values in the SAV file first. If it cannot find those values, it will use the values specified below in the rest of the fileCredits to the several people who requested this in GitHub Issues
Specific trainerdata settings for specific games using trainerdata.json
trainerdata.json
{
<Game ID string>: {
"TID":"",
"SID":"",
"OT":"",
"Gender":"",
"Country":"",
"SubRegion":"",
"3DSRegion":""
}
}
33: Ultra Moon
32: Ultra Sun
31: Moon
30: Sun
26: Alpha Sapphire
27: Omega Ruby
24: X
25: Y
21: Black
23: Black 2
20: White
22: White 2
10: Diamond
11: Pearl
12: Platinum
7: Heart Gold
8: Soul Silver
2: Ruby
1: Sapphire
3: Emerald
4: Fire Red
5: Leaf Green
15: Colosseum/XD
35: Red
36: Green
37: Blue
38: Yellow
39: Gold
40: Silver
41: Crystal
trainerdata.json
file would be (This is specific data for Ultra Sun and Omega Ruby. This JSON can be extended to include games you like. If the JSON does not have the game, it will fall back on trainerdata.txt
or the hardcoded default values):
{
"32":{
"TID":"12345",
"SID":"61234",
"OT":"PKHeXer",
"Gender":"M",
"Country":"Canada",
"SubRegion":"Alberta",
"3DSRegion":"Americas (NA/SA)"
},
"27":{
"TID":"23455",
"SID":"23444",
"OT":"ORAS",
"Gender":"F",
"Country":"Singapore",
"SubRegion":"Singapore",
"3DSRegion":"Americas (NA/SA)"
}
}
The instructions for each one of these will be located within their own folders within the Addons (Optional)
folder in the repository
Current Addons:
mgdb
folder.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.Just me right now, but if you want to contribute, feel free to contact me on Discord at thecommondude#8240