Installing PKHeX Plugins

Installing Stable Releases

Stable builds are recommended for the vast majority of users. They are are posted on GitHub. Please note that you must install the correct stable release of PKHeX-Plugins for each stable version of PKHeX. Mismatched plugins will not work.

To update, simply redo the installation in a new, empty folder. Move the trainers folder along with any other folders from your PKHeX installation from your old PKHeX directory and discard the rest.

Automatic Installation (only if latest release matches latest PKHeX)

This installation method simply requires you to download an exe and run it.

• If you still cannot get this to work or if both latest versions are not the same, follow the Manual Installation.
• If PKHeX-Plugins is not yet available, install an older release.

1. Download the almsetup_stable.exe executable from the Releases page. Do not download the source code.
   

2. Put almsetup_stable.exe in a clean, empty folder. Be sure that you are in a location where you have permissions. Good locations are within your Documents folder or on your Desktop. Do not place this folder in OneDrive or in any system location such as System32.

3. Warning: The next step will close all open PKHeX windows. Save your progress before continuing.

4. Double-click almsetup_stable.exe. Allow the program to run.

5. This should install stable PKHeX-Plugins properly and complete all other tasks required.

Installing Older Releases (or if automatic installation does not work)

PKHeX-Plugins only works with the matching version of PKHeX. This is how you can check that the versions are the same.

1. Go to the PKHeX-Plugins Releases page and find the release you want to install. The red box highlights the version. Download the PKHeX-Plugins.zip file.

2. Go to the PKHeX Download page and find the matching version from the drop-down. Click to change to that version and then download it.

3. Follow the Manual Installation guide (every single step, including UNBLOCKING THE PLUGINS).

Manual Installation

These are the installation instructions for manually installing the plugins.

1. Download the latest stable PKHeX release from Project Pokémon.

2. Download the latest stable PKHeX-Plugins release from the Releases page. Do not download the source code.
   

3. Right-click and extract the PKHeX archive to a location where you have permissions. Good locations are within your Documents folder or on your Desktop. Do not place this folder in any folder named "OneDrive" or in any system location such as System32.

4. Create a new folder named plugins in the same directory as PKHeX.exe.
   

5. VERY IMPORTANT. DO NOT SKIP THIS STEP. Right click the PKHeX-Plugins zip file, click "Properties", and select to Unblock.
   

   Because this is the reason most people fail to install the plugins:
   MAKE SURE TO UNBLOCK THE PLUGINS.
   MAKE SURE TO UNBLOCK THE PLUGINS.
   MAKE SURE TO UNBLOCK THE PLUGINS.
   MAKE SURE TO UNBLOCK THE PLUGINS.
   MAKE SURE TO UNBLOCK THE PLUGINS.

6. Extract the dll files from the PKHeX-Plugins zip file and put them in the plugins folder. The pdb files can be safely ignored. You can delete the PKHeX-Plugins zip and extracted folder afterwards.
   

7. Open PKHeX.exe. The program icon should be blue if you did this correctly. All mod functions and settings should be located in the Tools > Auto-Legality Mod menu.
   

8. You may optionally choose to set up custom Trainer Data.

Installing Bleeding Edge Releases

This is for testing new features only. NOT RECOMMENDED FOR GENERAL USE. DO NOT PROCEED UNLESS YOU ARE WILLING TO ACCEPT ERRORS. Revert to stable builds if problems arise.

1. To test PKHeX-Plugins on the latest commit, you must build the plugins yourself. If you do not know how to do this, this is likely not the release for you.
2. Bleeding Edge PKHeX-Plugins should be paired with the Development Build of PKHeX.

Updating PKHeX-Plugins

Follow any of the methods for installing. If you have problems using your original directory, start over with the steps below in a new, clean folder. Reusing old files can cause conflicts.