Login Logout Preferences
Jump to: navigation, search

Server installation

This page contains changes which are not marked for translation.

Other languages:
English • ‎français

This guide will cover installing Pixelmon to a server.

If you are looking for instructions on installing Pixelmon client-side (for singleplayer or joining an existing server), check out the Installation page.

Requirements

  • At least 3 GB of available (and allocated) RAM, preferably more.
    • Exact requirements will depend on your player count, and which plugins/mods you install.
  • A 64-bit Java 8 version. Earlier or later versions of Java will not work!

Notes

  • This guide is meant to explain local hosting, which generally means only people on your own local network can connect! See below.
    • If you wish to open your local server to remote connections, check out this page.
    • For bigger servers, using a paid hosting service is strongly recommended for performance, stability and safety.
      • If you are using such a service, installation steps may differ. Check with your host for the specifics.
  • This guide will only cover installing Forge and Pixelmon, along with some common extras. Other mods may work, but will not be covered here.
  • The Pixelmon .jar file is universal, meaning that the same file can be used on both clients and servers. A smaller server-specific file is also available, which is missing files that a server would never use. Files with "-server" in the name will not work on things that aren't servers.

Versions

Pixelmon is compatible with several versions of Minecraft, shown in the table below. Each version of Minecraft requires a different version of Pixelmon to be used. Note that versions of Pixelmon for older versions of Minecraft will no longer receive updates or bug fixes.

There is no Pixelmon version for Minecraft version 1.11.

Players connecting to a server must use the same version of Pixelmon that the server is using. If their version differs, they will be shown a "Mod Rejection" error and will be unable to join.

Minecraft version Pixelmon version
1.12.2 6.2.3+
1.10.2 5.1.2
1.8.9 4.3.1
1.8 4.1.4
1.7.10 3.5.1

Step 1: Forge installation

  1. Find the recommended Forge version on this page.
  2. Depending on your operating system, download either "Installer-win" (Windows) or "Installer" (macOS/Linux).
    • Note: Make sure you download Forge 2655 or later. Older versions currently break Pixelmon.
  3. Run the downloaded installer, select "Install server", pick the location you want your server installed to, and then click "OK".
    • Note: The location chosen here will contain your server's files. An easily accessible folder is recommended.
  4. Open the folder that you installed Forge to. Proceed with the steps for your specific operating system.

Starting on Windows

  1. If you haven't yet, enable the showing of file extensions by following these steps.
  2. Within the server's base ("root") folder, create a new file named start.bat or something similar.
    • Note: You can give the file another name, but make sure it ends in .bat.
  3. Right click this file, and click Edit.
  4. Copy the following contents into the file:
    java -Xmx3G -Xms3G -jar forge-[VERSION]-universal.jar nogui
    PAUSE
  5. Replace [VERSION] with the version of Forge you installed. Example:
    java -Xmx3G -Xms3G -jar forge-1.12.2-14.23.3.2705-universal.jar nogui
    PAUSE
  6. If necessary, change the amount of allocated memory (-Xmx3G) and the minimum (-Xms3G) to your desired amount.
  7. Save the file and double-click it to start the server.

Starting on macOS/Linux

  1. Open the Terminal or its equivalent and navigate to the folder you installed Forge to.
  2. In the Terminal, enter the following command but do not run it yet:
    java -Xmx3G -Xms3G -jar forge-[VERSION]-universal.jar nogui
  3. Replace [VERSION] with the version of Forge you installed. Example:
    java -Xmx3G -Xms3G -jar forge-1.12.2-14.23.3.2705-universal.jar nogui
  4. Copy the command somewhere safe for later use.
  5. Run the command to start the server.

Step 2: Accepting the EULA

  1. Check the console. You should see a message stating that the server has been stopped.
  2. In the server's root folder, open the newly generated eula.txt file with a text editor.
  3. Read Minecraft's End User License Agreement carefully.
  4. If you agree, change eula=false to eula=true, and save the file.
  5. Start the server again, and wait for it to create a fresh world.

Step 3: Installing Pixelmon

  1. Shut down the server by typing stop into the console and hitting the "Enter" key.
  2. In the server's root folder, open the mods folder.
  3. Download the most recent version of Pixelmon, and drop it into this folder.
    • Do not extract or otherwise change this file!
  4. Start the server again. Your server should now be running Pixelmon!
  5. To customize your server, you can use Pixelmon's config file, located in the config folder.
    • Note: Changes made to the config generally require a server restart to take effect.

Optional: Sidemod installation

This section is optional. If you do not want to use any Pixelmon sidemods, skip this part of the guide.

  1. View the sidemods page for a list of sidemods that are compatible with your version of Pixelmon.
  2. If you find a sidemod that looks interesting, check its page for a list of requirements and fulfill them.
    • Note: Sidemod configuration files are generally created alongside Pixelmon's own config.
  3. Visit the Pixelmon downloads page to grab the files you want.
  4. After downloading a sidemod, drop its .jar file into your server's mods folder.
    • Note: You will need to restart the server for it to load up any new mods/sidemods.


Most sidemods need, at a minimum, SpongeForge (covered below) as well as a permissions plugin like LuckPerms.

Optional: SpongeForge installation

This section is optional. If you do not want to use plugins or sidemods that rely on SpongeForge, skip this part of the guide.

  1. Download a SpongeForge build that matches your Forge version from this page. Recommended builds are preferred for stability.
    • Note: To find out which Forge version a specific SpongeForge build is built for, check the second number in the file's name.
  2. Drop the downloaded SpongeForge .jar into your server's mods folder.
  3. Restart the server again.


You can now install plugins and sidemods that rely on SpongeForge. To find plugins, please visit this page.

Troubleshooting

  • If you need any further help, head on over to the Pixelmon Discord and drop your questions in #server-support.
  • If you are using SpongeForge, be sure to read the SpongeForge documentation on the Sponge site.
  • If you are having issues with a site-listed sidemod, report the issue to the sidemods bug tracker.