Server Setup

From Pixelmon Generations Wiki
(Redirected from Server)
Jump to navigation Jump to search
//Page to update with 1.19 informations


This will guide you through installing and setting up a Pixélmon Generations server.

Before starting the installation, it is recommended to read the Prerequisites and Information sections to learn about the requirements and differences between a local and online hosted server.


Grid Warning.pngThis tutorial will primarily focus on a Localhost setup as online hosts vary depending on the host.Grid Warning.png

It is recommended to research and read the FAQ for your host prior to installing.

Prerequisites

  • Latest (and only supported) version of Pixelmon runs on Minecraft 1.19 currently. Using any other version with the mod will cause massive issues and may not work at all. We strongly recommend using the latest available version.
    • It is still possible to play Pixelmon on Minecraft 1.12.2 and 1.10.2 by selecting the correct version of the mod, but any bug or issue you may encounter will not be supported by the Pixelmon team.
  • Pixelmon always runs on the Recommended version of Forge for 1.19.
    When referred to as the current Forge version in this guide, please use the version listed above unless the version has been updated.
  • The server must have at least Java 8 Installed on the host's machine. Please check your server or asking your hosting company for information on this. If you don’t have it installed, install guides should be available for your system's operating system.
  • Other mods may be used together with Pixelmon, though we cannot guarantee that there will be no conflicts between mods. Do so at your own risk!
    Please check the incompatibility list for more information before installing them.
  • In order for players to join your server, they must be running the same version of Minecraft, Forge, and Pixelmon Generations for a successful, bug-free experience. A different Forge version may be used client-side, but bugs will likely appear.


Note: If you are creating a modpack, please use the current Forge version listed above as your version.

Server Performance

We highly suggest to give a read to our Server Performance Guide, to offer your players the best Pixelmon experience possible!

Main article: Server Performance Guide

Localhost vs Online Hosts

Before creating your server, there are a few differences between hosting methods. please read the information below to understand which you should go with.

Local Hosting

Local hosting is best used when creating a server for close friends to join or for personal testing. Localhost servers run off your own machine which means they are dependent upon the specifications of your computer. If you decide to allow external connections your computer can be at risk due to the requirement of Port Forwarding, which essentially opens a hole in your Firewall, so it’s recommended to only use a localhost setup when playing with close friends.

If you do choose to localhost and are looking to allow remote connections, please read this guide from the Minecraft Wiki to learn how to port forward.

Online Hosting

Online Hosts are always the preferred solution unless you have a dedicated at-home setup and you know what you are doing! However, online hosts must typically be paid for, but do provide significant benefits.
Stability is typically higher but is dependent on the hosting company. Vulnerability is lower as most hosts provide DDOS protection and general protections.

Some hosts do provide free plans, but these can become very ineffective in hosting solutions. Online hosts are recommended when creating a public server or if you want something dedicated.

In case you don't plan to self host your server, consider checking our server hosting Partners to receive a discount and full support on setup:
Need a website for your server? Check out our website hosting Partners:
Need some premade or commissioned buildings for your server? Check out our builders Partner:
Looking for a cheaper alternative? They also offer a dollar builds option!


Note: If you plan to make your server public, consider joining the Server Owner's Discord!

Installation

Sections below are required to set up a Pixelmon server. Steps may be generalized for certain systems for an easier explanation. If your system is not listed here, you may need to research information.

Forge Installation

Forge Installer application. Important buttons highlighted in red.

There are multiple methods of installing Forge on your server. Listed below is the simplest way to do so. If you are using an online host, they may provide simple tools to install Forge, mods, or even entire modpacks.

  1. Navigate to the Forge Downloads website and download the recommended version for the mod (2847 as of Version 8.X.X).
    • You may need to press + Show All Versions and scroll down to find the necessary version.
  2. Download the file that most suits your operating system. If you are on Windows, download the Installer-win, or is on MacOS/Linux download the Installer.
    • Versions beyond 2847 may not have a Installer-win version available. If so, try the Installer.
  3. Run the downloaded file by double-clicking it to begin the installation.
    • If nothing happens, ensure you've downloaded the suitable version for your system and have a 64-bit version of Java 8 installed (in prerequisites).
  4. Once the application window appears, select Install Server on the installer, select a location to install the files to, and click OK.
  5. Move the files that were installed by the Forge Installer into the server's main folder.


Starting the Server

Starting the server can also be done in multiple ways. Again, below is generally the way to do so. Depending on the operating system of your computer/the server, please choose one of the following instructions. If you are using an online host, there may be ways to start the server by clicking Start or similar.

Windows

  1. In the server main folder, create a text new text file.
  2. Right Click the file and select Edit (note that a better text editor is recommended. Ex; Notepad++).
  3. Copy and paste the following text into the text file:
    @ECHO OFF
    java -Xms2G -Xmx2G -jar forge.jar nogui
    pause
  4. Edit the dedicated memory amount to your liking by changing the maximum -Xmx2G and minimum -Xms2G. Xms should always be equal to, or smaller than Xmx.
    • The amount changes dependent upon mods, players, and world size. 3GB is minimum for a very small server and around 10GB for medium-large size servers.
  5. Save the file as start.bat. This file should no longer have .txt at the end.
    • You may need to enable file extensions by selecting View in your File Explorer and checking the checkbox labeled File name extensions.
  6. In the servers main folder, rename the forge-<version>.jar file to forge.jar.
  7. Run the start.bat file to run the server.

MacOS

  1. In the server’s main folder, open TextEdit and set the format to plain text.
  2. Copy and paste the following text into the file:
    #!/bin/bash
    exec java -Xms4G -Xmx4G -jar forge.jar nogui
  3. Edit the dedicated memory amount to your liking by changing the maximum -Xmx2G and minimum -Xms2G. Xms should always be equal to, or smaller than Xmx.
    • The amount changes dependent upon mods, players, and world size. 4GB is minimum for a very small server and at least 10GB for medium-large size servers.
  4. Save the file as start.command in the server’s main folder.
  5. Grant the execute permissions on the start file to Owner and Public Groups. To do so, type in chmod a+x , with a space after it. Drag and drop the start.command file into the terminal window, and then press enter.
  6. In the servers main folder, rename the forge-<version>.jar file to forge.jar
  7. Run the start.command by double clicking the file to run the server

Linux

  1. In the server’s main folder, create a new file called start.sh.
  2. Copy and paste the following text into the file:
    #!/bin/bash
    java -Xms4G -Xmx4G -jar forge.jar
  3. Edit the dedicated memory amount to your liking by changing the maximum -Xmx1G and minimum -Xms1G.
    • The amount changes dependent upon mods, players, and world size. 4gb is minimum for a very small server and at least 10gb for medium-large size servers, with typically no more than 16gb. Please ask in our Discord Support Channel if you are unsure.
  4. Save the file.
  5. Grant permissions to the start file by running chmod +x start.sh in a terminal that’s in the server’s main folder.
  6. In the servers main folder, rename the forge-<version>.jar file to forge.jar
  7. Run the start file by typing ./start.sh into the terminal that’s in the server’s main folder.

Accepting EULA

After running the server, it stopped and gave a warning message that the EULA must be accepted.

  1. In the servers main folder, open the file eula.txt.
  2. Read through the End User License Agreement linked in the document.
  3. Change eula=false to eula=true to show you read and accept the License Agreement.
  4. Run the start file again.

Pixelmon Installation

Now that the server is started all that's required is to install the Pixelmon Generations mod. Note that some online hosts may have easy tools for adding mods.

  1. Download the latest version of the Pixelmon Generations mod from the downloads page.
  2. Drop the mod file into the mods folder in the main directory of the server.
  3. Restart the server to finish the install.

Connecting

The address you connect with is different depending on your hosting setup.

  • If you are using a local host server, anyone on your network can connect via 127.0.0.1 or localhost. External connections can be made via <your-ip-here>:25565 after Port Forwarding.
  • Online Hosts are dependent upon the IP address that your host has assigned you. Check with your host provider.

Server Setup

Sections listed below are optional settings that are beyond the basic requirements to run a server.

(Optional) Installing other mods/side mods

Other mods can be installed as long as they work with the current supported Minecraft version, current Forge version, and are not on the incompatibility list.

  1. Download the jar of the mod or side mod. Side mods can be found on the Sidemods page.
  2. Drop the mod file into the mods folder in the main directory of the server.
  3. Restart the server to finish the install.

(Optional) Installing SpongeForge and Sponge Plugins

Installing SpongeForge gives access to all sorts of plugins offered by Sponge! These plugins will allow for server additions without the requirement of an additional mod. If you're looking for good plugins, go to Sponge's Ore page and sort by Most Downloaded to get a sense of popular plugins.

  1. Download the latest SpongeForge for the latest Forge version from the SpongeForge downloads page. The current version for Forge 2847 is the latest recommended version.
  2. Drop the mod file into the mods folder in the main directory of the server.
  3. Restart the server to finish the install.
  4. Install any Sponge plugins by placing then into the mods folder. Plugins can be found on Sponge's Ore page.