Skip to content

Installing PKHeX Plugins

Jump to bottom
Lusamine edited this page Apr 16, 2023 · 42 revisions

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.

  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. This should install stable PKHeX-Plugins properly and complete all other tasks required.

    • If this fails, then the latest version of PKHeX does not match the latest version of Auto-Legality Mod. Read the section below for manual installation.

Here is a video of the above 4 steps if it is still confusing. Essentially, you are downloading a file and double-clicking it.

Manual Installation or Installing Older Releases

These are the installation instructions for manually installing the plugins.
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. Do not download the source code.
    image

  2. Go to the PKHeX Download page and find the matching version.

    • The regular Download button on the top right will give you the latest version.
    • Older versions are available from the drop-down. Click to change to the correct version and then download it.
      image

  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. 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.

  6. 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.

  7. 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 version for you.
  2. Bleeding Edge PKHeX-Plugins should be paired with the Development Build of PKHeX.

More Help

If you have followed everything on this page and still cannot get your installation to work, visit Troubleshooting for more help.

Information

Installation / Configuration

Features and Guides

Clone this wiki locally