Difference between revisions of "Server installation"

Revision as of 11:42, 5 May 2018

This is a guide to installing Pixelmon on a multiplayer 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.

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.
- If you are installing other mods alongside Pixelmon, check the incompatibilities list first to avoid issues.
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.
If you get stuck anywhere, feel free to join the Pixelmon Discord and post what you need help with in #server-support.

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 a player attempts to connect to the server with a different version of Pixelmon, that player 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

Find the recommended Forge version on this page.
Depending on your operating system, download either "Installer-win" (Windows) or "Installer" (macOS/Linux).
- Note: Make sure you download Forge 2655 or earlier. Newer versions currently break Pixelmon.
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.
Open the folder that you installed Forge to. Proceed with the steps for your specific operating system.

Starting on Windows

If you haven't yet, enable the showing of file extensions by following these steps.
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.
Right click this file, and click Edit.

Copy the following contents into the file:

java -Xmx3G -Xms3G -jar forge-[VERSION]-universal.jar nogui
PAUSE

Change [VERSION] to the version of Forge you installed. Example:

java -Xmx3G -Xms3G -jar forge-1.12.2-14.23.3.2655-universal.jar nogui
PAUSE

If necessary, change the amount of allocated memory (-Xmx3G) and the minimum (-Xms3G) to your desired amount.
Save the file and double-click it to start the server.

Starting on macOS/Linux

Open the Terminal or its equivalent and navigate to the folder you installed Forge to.
In the Terminal, run the following command to start your server:
```
java -Xmx3G -Xms3G -jar forge-[VERSION]-universal.jar nogui
```

Step 2: Accepting the EULA

Check the console. You should see a message stating that the server has been stopped.
In the server's root folder, open the newly generated eula.txt file with a text editor.
Read Minecraft's End User License Agreement carefully.
- Note: If you violate the terms outlined in this legal document, you will risk legal action being taken against you.
If you agree, change eula=false to eula=true, and save the file.
Start the server again, and wait for it to create a fresh world.

Step 3: Installing Pixelmon

Shut down the server by typing /stop into the console and hitting the "Enter" key.
In the server's root folder, open the mods folder.
Download the most recent version of Pixelmon, and drop it into this folder.
- Do not extract or otherwise change this file!
Start the server again. Your server should now be running Pixelmon!
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.

View the sidemods page for a list of sidemods that are compatible with your version of Pixelmon.
If you find a sidemod that looks interesting, check its page for a list of requirements.
Visit the Pixelmon downloads page to grab the files you want.
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.

Note that certain sidemods may have extra installation or usage instructions. Consult their pages to see what you need to do to get them working. Sidemod configuration files can generally be found alongside Pixelmon's config file, in the config folder. SpongeForge is commonly required, and is covered below.

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.

Download a SpongeForge build that matches your Forge version from this page.
- Note: To find out which Forge version a specific SpongeForge build is built for, check the second number in the file's name.
Drop the downloaded SpongeForge .jar into your server's mods folder.
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.

@@ Line 1: / Line 1: @@
-This is a guide to installing [[Pixelmon]] on a multiplayer server. If you are looking for instructions on installing Pixelmon client-side (for singleplayer or joining an existing server), see the [[installation]] page.
+This is a guide to installing [[Pixelmon]] on a multiplayer 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 ==
-*A paid copy of the computer edition of ''Minecraft''. This is the version that is obtained by purchasing ''Minecraft'' at [https://minecraft.net/en-us/store/minecraft/ minecraft.net] using a Mojang account.
+* At least 3 GB of available (and allocated) RAM, preferably more.
-**Only the computer edition can run Pixelmon. ''Minecraft'' Pocket Edition (including Windows 10 Edition) and console editions (Xbox, PlayStation, Wii U, Switch) cannot run Pixelmon.
+** Exact requirements will depend on your player count, and which plugins/mods you install.
-* 4 GB of available RAM.
 * A 64-bit Java 8 version.
 == Notes ==
-* This guide only contains instructions on local hosting of a server, which means that only players that are using the same internet connection will have access to the server through the multiplayer menu in-game. If you wish to publish your server so that players can connect remotely, please see [https://minecraft.gamepedia.com/Tutorials/Setting_up_a_server#Port_forwarding this page].
+* This guide is meant to explain local hosting, '''which generally means only people on your own local network can connect!''' See below.
-*If you are using an external hosting service, installation will differ, so ask your provider for specific details regarding setup.
+** If you wish to open your local server to remote connections, check out [https://minecraft.gamepedia.com/Tutorials/Setting_up_a_server#Port_forwarding this page].
-* This guide will only go through the installation of Forge, Pixelmon, Pixelmon [[sidemods]], and SpongeForge. Sidemods and SpongeForge are optional to install, but can provide extra features and server management functionality.
+** For bigger servers, using a paid hosting service is strongly recommended for performance, stability and safety.
-*The Pixelmon JAR file is universal, meaning that the same JAR is used for both client and server.
+*** If you are using such a service, installation steps may differ. Check with your host for the specifics.
-* The more players use your server, the more memory it will need. For low player count purposes, this guide will use 4 GB as a minimum.
+* This guide will only cover installing Forge and Pixelmon, along with some common extras. Other mods may work, but will not be covered here.
-* 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.
+** If you are installing other mods alongside Pixelmon, check the [[incompatibilities list]] first to avoid issues.
-* If you are looking for additional support, please contact our Support team by joining the [[Pixelmon Discord]].
+* 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.
+* If you get stuck anywhere, feel free to join the [[Pixelmon Discord]] and post what you need help with in ''#server-support''.
 ==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 only the ''Minecraft'' 1.12.2 unofficial version of Pixelmon currently receives updates; versions of Pixelmon for older versions of ''Minecraft'' will no longer receive updates or bug fixes.
+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.
-All players that connect to a server must use exactly the same version of Pixelmon that the server is using. If a player attempts to connect to the server with a different version of Pixelmon than the server's Pixelmon version, that player will not be able to join the server.
+Players connecting to a server must use the same version of Pixelmon that the server is using. If a player attempts to connect to the server with a different version of Pixelmon, that player will be shown a "Mod Rejection" error and will be unable to join.
 {|class="wikitable"
 !''Minecraft'' version
@@ Line 25: / Line 30: @@
 |-
 |style="text-align:center"|1.12.2
-|style="text-align:center"|6.+
+|style="text-align:center"|6.2.3+
 |-
 |style="text-align:center"|1.10.2
@@ Line 40: / Line 45: @@
 |}
-== Forge installation ==
+== Step 1: Forge installation ==
-#Find the recommended Forge version for your chosen ''Minecraft'' version on [https://files.minecraftforge.net this page]. Depending on your operating system, download either the "Installer-win" (Windows) or "Installer" (macOS/Linux) file.
+# Find the recommended Forge version on [https://files.minecraftforge.net this page].
-# 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.
+# Depending on your operating system, download either "Installer-win" (Windows) or "Installer" (macOS/Linux).
-# Run the downloaded file. When asked, select "server" installation and change the target directory to the folder you have just created.
+#* ''Note: Make sure you download Forge 2655 or earlier. Newer versions currently break Pixelmon.''
-# Once it is completed, open the directory with the newly created files and open Command Prompt (Windows) or Terminal (macOS/Linux) from the directory where the <code>forge-[version]-universal.jar</code> is located.
+# Run the downloaded installer, select "Install server", pick the location you want your server installed to, and then click "OK".
-# In the command screen, run the following command:
+#* ''Note: The location chosen here will contain your server's files. An easily accessible folder is recommended.''
-#:<pre>java -Xmx4G -Xms4G -jar forge-[version]-universal.jar nogui</pre>
+# Open the folder that you installed Forge to. Proceed with the steps for your specific operating system.
-# The screen will state that the server has stopped. In the main server folder (where the Forge JAR is), open the newly generated <code>eula.txt</code> file with a plain text editor, change <code>eula=false</code> to <code>eula=true</code>, and save the file.
-# While not required, you are advised to follow the instructions in <code>eula.txt</code> and read ''Minecraft'''s [https://account.mojang.com/documents/minecraft_eula End User License Agreement]. If you violate the terms outlined in this legal document, you will risk legal action being taken against you.
-# Run the command prompt again, noticing that now, the server has fully loaded up, creating a fresh world. Forge is now installed on your server.
+==== Starting on Windows ====
+# If you haven't yet, enable the showing of file extensions by following [https://www.bleepingcomputer.com/tutorials/how-to-show-file-extensions-in-windows/ these steps].
+# Within the server's base ('''"root"''') folder, create a new file named <code>start.bat</code> or something similar.
+#* ''Note: You can give the file another name, but make sure it ends in <code>.bat</code>.''
+# Right click this file, and click <code>Edit</code>.
+# Copy the following contents into the file:
+#: <pre>java -Xmx3G -Xms3G -jar forge-[VERSION]-universal.jar nogui&#10;PAUSE</pre>
+# Change <code>[VERSION]</code> to the version of Forge you installed. Example:
+#: <pre>java -Xmx3G -Xms3G -jar forge-1.12.2-14.23.3.2655-universal.jar nogui&#10;PAUSE</pre>
+# If necessary, change the amount of allocated memory (<code>-Xmx3G</code>) and the minimum (<code>-Xms3G</code>) to your desired amount.
+# Save the file and double-click it to start the server.
+==== Starting on macOS/Linux ====
+# Open the Terminal or its equivalent and navigate to the folder you installed Forge to.
+# In the Terminal, run the following command to start your server:
+#: <pre>java -Xmx3G -Xms3G -jar forge-[VERSION]-universal.jar nogui</pre>
+== Step 2: Accepting the EULA ==
+# Check the console. You should see a message stating that the server has been stopped.
+# In the server's root folder, open the newly generated <code>eula.txt</code> file with a text editor.
+# Read ''Minecraft'''s [https://account.mojang.com/documents/minecraft_eula End User License Agreement] carefully.
+#* ''Note: If you violate the terms outlined in this legal document, you will risk legal action being taken against you.''
+# If you agree, change <code>eula=false</code> to <code>eula=true</code>, and save the file.
+# Start the server again, and wait for it to create a fresh world.
+== Step 3: Installing Pixelmon ==
+# Shut down the server by typing <code>/stop</code> into the console and hitting the "Enter" key.
+# In the server's root folder, open the <code>mods</code> folder.
+# Download the most recent version of Pixelmon, and drop it into this folder.
+#* '''Do not extract or otherwise change this file!'''
+# Start the server again. Your server should now be running Pixelmon!
+# To customize your server, you can use Pixelmon's [[config]] file, located in the <code>config</code> 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.''
+# View the [[sidemods]] page for a list of sidemods that are compatible with your version of Pixelmon.
+# If you find a sidemod that looks interesting, check its page for a list of requirements.
+# Visit the Pixelmon [https://pixelmonmod.com/downloads.php downloads page] to grab the files you want.
+# After downloading a sidemod, drop its .jar file into your server's <code>mods</code> folder.
+#* ''Note: You will need to restart the server for it to load up any new mods/sidemods.''
+Note that certain sidemods may have extra installation or usage instructions. Consult their pages to see what you need to do to get them working. Sidemod configuration files can generally be found alongside Pixelmon's [[config]] file, in the <code>config</code> folder. SpongeForge is commonly required, and is covered below.
-== Pixelmon installation==
+== Optional: SpongeForge installation ==
-# In the main directory of the server, open the <code>/mods</code> folder.
+''This section is optional. If you do not want to use plugins or sidemods that rely on SpongeForge, skip this part of the guide.''
-# If your server is currently running, use your server's console (the command GUI) to enter the <code>/stop</code> command and shut down the server.
+# Download a SpongeForge build that matches your Forge version from [https://www.spongepowered.org/downloads/spongeforge/stable/1.12.2 this page].
-# Go to the Pixelmon downloads page and download the most recent version of the mod.
+#* ''Note: To find out which Forge version a specific SpongeForge build is built for, check the second number in the file's name.''
-# With the Pixelmon JAR downloaded, drop the fresh file into the <code>/mods</code> directory.
+# Drop the downloaded SpongeForge .jar into your server's <code>mods</code> folder.
-#*'''Do not extract or unzip the file'''.
+# Restart the server again.
-# Restart the server. If you followed the steps above correctly, your server is now a Pixelmon server.
-# To customize your server, you can use Pixelmon's [[config]] file, located in the <code>/config</code> directory. Note that if you change the config file, you will have to restart the server in order for your changes to take effect.
-== Sidemod installation ==
-''This is an optional section of the tutorial that is '''not''' needed to run a Pixelmon server. If you do not want any Pixelmon [[sidemods]], skip this part of the guide.''
-#View the [[sidemods]] page for a list of sidemods that are compatible with your version of Pixelmon.
-#* Sidemods have different versions that must be paired with specific Pixelmon versions. The [[sidemod]] page contains details about the required sidemods versions for your chosen Pixelmon version.
-# Once you have selected the sidemod version that matches your Pixelmon version, visit the Pixelmon [https://pixelmonmod.com/downloads.php downloads page] to download the files.
-# After downloading a sidemod, place the fresh JAR file into the <code>/mods</code> folder of your server. If your server is on, restart it for the change to take hold. If not, starting the server will enable the sidemod.
-#* Certain sidemods may have extra installation instructions. Consult the page of the sidemod that you installed to check if any extra setup must be done with the sidemod.
-#* Sidemod configuration files can be found alongside Pixelmon's [[config]] file, in the <code>/config</code> folder. For more information, please visit the specific page related to the sidemod you have installed.
-== SpongeForge Installation ==
+You can now install plugins and sidemods that rely on SpongeForge. To find plugins, please visit [https://forums.spongepowered.org/c/plugins/plugin-releases this page].
-''This is an optional section of the tutorial that is '''not''' needed to run a Pixelmon server. If you do not need to use plugins, skip this part of the guide.''
-# In the main directory of the server, open the <code>/mods</code> folder.
-# Download the recommended SpongeForge build from [https://www.spongepowered.org/downloads/spongeforge/stable/1.12.2 this page]. Please note that ''Minecraft'' version 1.10.2 and below are not supported if you are using SpongeForge.
-#* SpongeForge requires the appropriate Forge version to be installed. Much like Pixelmon, it also requires the corresponding ''Minecraft'' version.
-# After selecting the SpongeForge version (the latest stable build is the recommended version), download the file.
-# Once the download has finished, copy the fresh SpongeForge JAR to the <code>/mods</code> folder of your server's directory.
-#*Note that the fresh JAR's name states the Forge version that it corresponds to: <code>spongeforge-[Minecraft version]-[Forge version]-[API]-BETA-[Spongeforge version].jar</code>. Make sure that this version matches the version of Forge that you have installed on the server.
-# Restart the server. Upon booting up the server, your server will now have SpongeForge installed. To add plugins, please visit [https://forums.spongepowered.org/c/plugins/plugin-releases this page] to find a list of plugins.
 == Troubleshooting ==
-* If you are experiencing issues, please post a support request for our Support team in the [[Pixelmon Discord]].
+* If you need any further help, head on over to the [[Pixelmon Discord]] and drop your questions in ''#server-support''.
-* If you are using the optional SpongeForge, read the [https://docs.spongepowered.org/master/en/server/index.html SpongeForge documentation] on the Sponge Forums.
+* If you are using SpongeForge, be sure to read the [https://docs.spongepowered.org/master/en/server/index.html SpongeForge documentation] on the Sponge site.
-* If you are having issues with a sidemod, report the issue to the discord as well.
+* If you are having issues with a site-listed sidemod, report the issue to the [http://www.pixelmonmod.com/tracker.php?p=6 sidemods bug tracker].

Difference between revisions of "Server installation"

Difference between revisions of "Server installation"

Revision as of 11:42, 5 May 2018

Contents

Requirements

Notes

Versions

Step 1: Forge installation

Starting on Windows

Starting on macOS/Linux

Step 2: Accepting the EULA

Step 3: Installing Pixelmon

Optional: Sidemod installation

Optional: SpongeForge installation

Troubleshooting