Server installation

If you are using a hosting service, please note that this is a guide to server installation for personal usage. Directions may differ, so ask your provider for specific details regarding your setup.

Requirements

• A paid version of Minecraft.
• 4 GB of available RAM.
• A 64-bit Java 8 version.

Notes

• Pixelmon is a universal mod - both the client and the server must share the same version. Please first select the version that your server will run and that your players will therefore use. This wiki provides a listing for all versions, which you can use to know the details of each release.
• You must use the corresponding Minecraft and Forge version to the Pixelmon version. For example, Pixelmon 5.0.1 is for Minecraft version 1.10.2, and for Forge 2185. Using unmatched versions will crash the client or the server.
• The more players use your server, the more memory it will need. For low player count purposes, this guide will use 4 GB.
• This guide will only cover local hosting of a server - meaning only players that are using the same internet connection will have access to the server through their multiplayer menu in-game. If you wish to publish your server, please see this page on port-forwarding.
• This guide will only go through the Forge, Pixelmon, Sidemods and SpongeForge installation. The latter is optional, but allows the usage of plugins and extended server management.
• Do not attempt to setup a cracked server. Players' Pokémon will not save on game exit; this is a bug that will not be fixed.
• Using a Technic platform will cause save issues and other game-breaking bugs. This will not be fixed. If you are interested in modpacks, visit the Pixpack page.
• If you are looking for additional support, please contact our Support team in Pixelmon's support tracker or by join the Pixelmon Discord.

Forge Installation

1. Select the appropriate Forge that will work for the Pixelmon version that you are looking for. Recommended version can be found in our downloads page. After choosing, click the Forge link provided to download the installer according to your operating system.
2. Once you have downloaded the file, place it in a folder where you will setup your server. Creating a folder which is easy to access is recommended.
3. Run the downloaded file and when asked, select 'server' installation and change the resulting directory to the folder you have just created.
4. Once it is completed, open the directory with the newly created files and open command prompt from the directory where the forge-[version]-universal.jar is located.
5. In the command screen, run the following command:

     java -Xmx4G -Xms4G -jar forge-[version]-universal.jar nogui

1. You'll notice that the screen will state the server has stopped. In the main server folder (where the Forge jar is), open the newly generated EULA.txt and edit "eula=false" to state, "eula=true". Save the file.
2. Run the command prompt again, noticing that now, the server has fully loaded up, creating a fresh world. Congratulations, Forge is now installed on your server.

Pixelmon Installation

1. In the main directory of the server, open the /mods folder.
2. Download the corresponding Pixelmon to the Minecraft that you chose. If you do not remember which one it is, note how Forge's jar states `forge-[minecraft version]-[forge version].jar' . Keeping in mind the different Pixelmon versions, visit our downloads page and select the appropriate Pixelmon release.
3. In the command GUI - your server's console - type "/stop" to shut down the server.
4. With the Pixelmon jar downloaded, drop the fresh file into the /mods directory and restart the server.
5. Your server is now a Pixelmon server. Note, players joining will need to have the same version of Pixelmon that exists in your /mods folder.
6. To customize your server, you can use Pixelmon's config file, located in the /config directory.

Sidemod Installation

Please note that this is an optional section of the tutorial. If you do not want any sidemods, skip this part of the guide.

1. Pixelmon sidemods require the appropriate Pixelmon to be installed. Please look to the previous section on how to install Pixelmon.
2. Much like Pixelmon, sidemods must be paired with the corresponding versions. See the sidemod page for more details.
3. Once you have selected the sidemod version that matches your Pixelmon, visit our downloads page to fetch the files.
4. The download over, place the fresh jar into the /mods folder of your server. If your server is on, restart it for the change to take hold. If not, simply starting the server will enable the sidemod.
5. Sidemod configuration files can be found alongside Pixelmon's, in the /config folder. For more information, please visit the specific pages related to the sidemod you have installed.

SpongeForge Installation

Please note that this is an optional section of the tutorial and it is not needed to run a Pixelmon server. If you do not plan on needing plugins, skip this part of the guide.

1. SpongeForge requires the appropriate Forge to be installed. Much like Pixelmon, it also requires the corresponding Minecraft.
2. In the main directory of the server, open the /mods folder.
3. Download the appropriate SpongeForge through this page. Please note that Minecraft version 1.8.9 and below are not recommended if you are using SpongeForge.
4. After selecting the SpongeForge version (latest stable build is the recommended), download the file.
5. Once the download is over, note that the fresh jar's name states the Forge version that it corresponds to: spongeforge-[Minecraft version]-[Forge version]-[API]-BETA-[Spongeforge version].jar.
6. Copy the fresh SpongeForge jar to the /mods folder of your server's directory.
7. Double-check that SpongeForge's Forge version matches the one in your server's main directory. If not, update as required, following the Forge Installation above.
8. Restart the server using the command prompt. Upon booting up, your server now has SpongeForge. To add plugins, please visit this page to find a list of plugins.

Troubleshooting

• If you are experiencing issues, please report to Pixelmon's support tracker or seek help from our Support team in the Pixelmon Discord.
• If you are using the optional SpongeForge plugin, read the provided documentation on the Sponge Forums.
• If you are having issues with a sidemod, report to the Sidemod tracker here.