Server Setup

From Pixelmon Generations Wiki
Jump to: navigation, search

This page will go over the steps to set up a Pixelmon Generations server! Before reading through the steps, it is recommended to read the Information and Requirements and the Local Host vs Online Host sections to understand differences and requirements.

This tutorial will primarily focus on Local Host setups as Online Host methods vary depending on the host. It is recommended to look around and read FAQs about your host prior to installing.

Information and Requirements

  • Pixelmon Generations currently runs on Minecraft 1.12.2. Using any other version with the mod will cause massive issues and may not work at all. We strongly recommend using the current version.
  • Pixelmon Generations currently runs on Forge version 2847 for 1.12.2. 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 machine. Please check your machine or asking your hosting company for information on this. If you don’t have it installed, look up install instructions for your operating system.
  • Other mods may be used together with Pixelmon Generations. We cannot guarantee that there will be no conflicts between mods, so please do so at your own risk. Please check the incompatibility list page for more information before installing them.
  • In order for players to join your server, they must be running the same version of Pixelmon Generations, Minecraft, and Forge for a successful, bug-free experience. A different Forge version may be used client-side, but bugs may appear. If you are creating a modpack, please use the current Forge version listed above as your version.


Local Host vs Online Host

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

Local Hosts

Local Hosts are best used when creating a server for close friends to join or for personal testing. Local Host servers run off your own machine which means their dependence 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! If you plan to allow external connections, we recommend not using local hosting.

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 Hosts

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.

Generally, it’s recommended to use Local Hosts when playing with close friends for easy hosting, while Online Hosts are recommended when going public or something dedicated. However, if you still want to rent one online, or are deciding to make a public server, we recommend BisectHosting to host them.

Note: If your server is going public, consider joining the Server Owner's Discord!

Step 1: Initial Forge Setup

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.

  1. Find the current recommended Forge version by Pixelmon on the official Forge Downloads page.
  2. Depending on your computer, download either (Windows) Installer-win or (Linux/MacOS) Installer.
  3. After downloading, run the file and select the option Install Server and choose the installation location.
  4. Move the files that were installed by the Forge Installer into the main server folder.


Step 2: Starting the Server

Starting the server can also be done in multiple ways. Again, below is the simplest way to do so. Depending on the operating system of your computer/the server, please choose one of the following instructions. Note that if you are using an online host, there may be ways to start the server by clicking Start or things 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. 3gbs is minimum for a very small server and at least 10gbs for medium-large size servers. Please ask in our Discord Support Channel if you are unsure.
  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, with typically no more than 16gb. Please ask in our Discord Support Channel if you are unsure.
  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.


Step 3: Installing Pixelmon

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


Step 4: 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 given you. Check with your host provider.


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

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