Difference between revisions of "Server installation"

Latest revision as of 17:24, 18 August 2024

Other languages:

English • ‎español • ‎français • ‎português • ‎português do Brasil

This guide will cover manually creating a Pixelmon server.

If you are looking for instructions on installing Pixelmon client-side (for singleplayer or joining an existing server), check out the Installation page. If you plan on installing other mods alongside Pixelmon, be sure to check the incompatibilities list first to avoid issues.

Pixelmon also offers easier ways to create and install a server. One of these methods includes using the ATLauncher client, which can be used to easily install a server and launch from it. See this page. Another method is using a server pack, which is a ZIP file containing the neccessary files to launch a server already prepared. The server pack for your Pixelmon version can be obtained from Curseforge, click here.

Requirements

At least 3 GB of allocated memory, preferably more. Exact requirements will depend on player count and your exact mods/plugins.
A 64-bit Java 8 before Pixelmon 9.2.0 and Java 17 since Pixelmon 9.2.0. 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. Steps may differ, there.
If you are using Turkish as your system language, you may see a Fatally missing registry entries error when trying to connect, and some things may not work correctly on the server's end. This is a Forge issue. Changing the system language to English should work around this issue.
The startup parameters mentioned in this guide were taken directly from Aikar's excellent startup flags guide, and are optimized for performance. Check out the linked post for an explanation on why these are worth using.

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.

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.20.2	9.2.8
1.20.1	9.2.0-9.2.3
1.16.5	9.1.12

Step 1: Forge installation

Find the current recommended Forge build, for 1.20.2 and for 1.16.5.
Download the "Installer" file and run it.

Starting on Windows

If you haven't already, enable showing file extensions by following this guide.
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 -Xms3G -Xmx3G -XX:+UseG1GC -XX:+UnlockExperimentalVMOptions -XX:MaxGCPauseMillis=100 -XX:+DisableExplicitGC -XX:TargetSurvivorRatio=90 -XX:G1NewSizePercent=50 -XX:G1MaxNewSizePercent=80 -XX:G1MixedGCLiveThresholdPercent=50 -XX:+AlwaysPreTouch -jar forge-[VERSION].jar nogui
PAUSE

Replace [VERSION] with the version of Forge you installed. Make sure the file name is an exact match!
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.
Navigate to the home folder by using cd ~. Use ls to show the folders accessible from your current location.
Find the folder you installed Forge to. Use cd FOLDERNAME to enter a folder, and cd .. to go back up one level.

In the Terminal, enter (copy and paste) the following command, but do not run it yet:

java -Xms3G -Xmx3G -XX:+UseG1GC -XX:+UnlockExperimentalVMOptions -XX:MaxGCPauseMillis=100 -XX:+DisableExplicitGC -XX:TargetSurvivorRatio=90 -XX:G1NewSizePercent=50 -XX:G1MaxNewSizePercent=80 -XX:G1MixedGCLiveThresholdPercent=50 -XX:+AlwaysPreTouch -jar forge-[VERSION].jar nogui

Replace [VERSION] with the version of Forge you installed. Make sure the file name is an exact match!
Copy the command somewhere safe for later use.
Run the command to start the server.

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

The -server jar is located on the main Pixelmon site underneath the downloads button. The red line indicates the link that is to be pasted into your browser for the download to commence.

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 Pixelmon from this link and drop it in. Do not extract or otherwise change this file!
- Note: Pixelmon comes in both -universal and -server variants. The -server file (from the link below the buttons) is smaller and may include additional fixes, but will only work on servers.
It is recommended to delete the world that was generated in Step 2, before the server is started again with the addition of Pixelmon and other mods (especially biome generation mods). If deleted and a new world is generated, players will initially spawn in a Village as intended and Pixelmon features (along with any other mods) will generate near spawn. This also ensures the chunks near spawn generate properly if a biome mod is used and decreases the chance for chunk errors.
Start the server again. Your server should now be running Pixelmon!

Step 4: Configuring Pixelmon

With Pixelmon running, you should now have a config folder in the server root. Open this.
Open up the pixelmon folder, here you'll find multiple files, each one containing various settings. See Configs section for descriptions and values.
Tweak to taste. Some settings will only apply to fresh chunks, so make sure you set those now.
- Note: To avoid loot drain over time, be sure to change spawnMode under PokeLoot now!

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 an interesting sidemod, check its wiki page for a list of requirements and fulfill them.
- Note: Sidemod configuration files are generally created alongside Pixelmon's own config.
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 many sidemods require a plugin platform like SpongeForge (covered below) as well as a permissions plugin like LuckPerms. Be sure to check the requirements!

Optional: ArcLight server installation

This section is optional. If you do not want to use plugins with mods that rely on Spigot Plugins, skip this part of the guide.``

Download the recommended build for 1.16.x or 1.20.1 from this page (Arclight is not compatible with Pixelmon 9.2.4+)
Place it in your main folder of your server
Launch the server from the arclight-forge-1.x.x-1.x.x.jar file
A new Plugin folder will be created after a successful launch. Place your plugins in there and restart the server.

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 using ArcLight, be sure to to read ArcLight Wiki and check out their Discord
If you are having issues with a site-listed sidemod, report the issue to the sidemods bug tracker.

@@ Line 1: / Line 1: @@
-'''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. '''
+{{#seo:
-== Requirements ==
+ |title=Server installation
-* A paid version of Minecraft.
+ |title_mode=replace
-* 4 GB of available RAM.
+ |keywords=Pixelmon, Reforged, server, installation, install, Minecraft, Forge, SpongeForge, local, arclight
-* A 64-bit Java 8 version.
+ |description=A guide to installing Pixelmon on a (local) server.
-== 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.
+<languages/>
-* 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.
+<translate>
-* The more players use your server, the more memory it will need. For low player count purposes, this guide will use 4 GB.
+<!--T:1-->
-* 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 [https://http://minecraft.gamepedia.com/Tutorials/Setting_up_a_server#Port_forwarding this page] on port-forwarding.
+This guide will cover manually creating a Pixelmon server.
-* 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.
+<!--T:2-->
-* 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 instructions on installing Pixelmon client-side (for singleplayer or joining an existing server), check out the [[Installation]] page. If you plan on installing other mods alongside Pixelmon, be sure to check the [[incompatibilities list]] first to avoid issues.
-* If you are looking for additional support, please contact our Support team in Pixelmon's [https://www.pixelmonmod.com/tracker.php?p=4/ support tracker] or by join the [[Pixelmon Discord]].
-== Forge Installation ==
+Pixelmon also offers easier ways to create and install a server. One of these methods includes using the ATLauncher client, which can be used to easily install a server and launch from it. See [[Server installation/ATLauncher|this page]]. Another method is using a server pack, which is a ZIP file containing the neccessary files to launch a server already prepared. The server pack for your Pixelmon version can be obtained from Curseforge, [https://www.curseforge.com/minecraft/modpacks/the-pixelmon-modpack/files click here].
-# Select the appropriate Forge that will work for the Pixelmon [[version]] that you are looking for. Recommended version can be found in our  [http://pixelmonmod.com/downloads.php downloads page].  After choosing, click the Forge link provided to download the installer according to your operating system.
-# 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.
+== Requirements == <!--T:3-->
-# Run the downloaded file and when asked, select 'server' installation and change the resulting directory to the folder you have just created.
+* At least 3 GB of allocated memory, preferably more. Exact requirements will depend on player count and your exact mods/plugins.
-# 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.
+* A 64-bit Java 8 before Pixelmon 9.2.0 and Java 17 since Pixelmon 9.2.0. '''Earlier or later versions of Java will not work!'''
-# In the command screen, run the following command:
-      java -Xmx4G -Xms4G -jar forge-[version]-universal.jar nogui
+== Notes == <!--T:4-->
-# 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.
+* This guide is meant to explain local hosting, '''which generally means only people on your own local network can connect!''' See below.
-# 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.
+** If you wish to open your local server to remote connections, check out [https://minecraft.wiki/Tutorials/Setting_up_a_server#Port_forwarding this page].
-== Pixelmon Installation==
+** For bigger servers, using a paid hosting service is strongly recommended for performance, stability and safety. Steps may differ, there.
-#In the main directory of the server, open the /mods folder.
+* If you are using Turkish as your system language, you may see a <code>Fatally missing registry entries</code> error when trying to connect, and some things may not work correctly on the server's end. This is a Forge issue. Changing the system language to English should work around this issue.
-# 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 [http://pixelmonmod.com/downloads.php downloads page] and select the appropriate Pixelmon release.
+* The startup parameters mentioned in this guide were taken directly from [https://forums.spongepowered.org/t/optimized-startup-flags-for-consistent-garbage-collection/13239 Aikar's excellent startup flags guide], and are optimized for performance. Check out the linked post for an explanation on why these are worth using.
-# In the command GUI - your server's console - type "/stop" to shut down the server.
-# With the Pixelmon jar downloaded, drop the fresh file into the /mods directory and restart the server.
+==Versions== <!--T: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.
+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.
-# To customize your server, you can use Pixelmon's [[config]] file, located in the /config directory.
-== Sidemod Installation ==
+<!--T:6-->
-''Please note that this is an optional section of the tutorial. If you do not want any [[sidemods]], skip this part of the guide.''
+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.
-# Pixelmon sidemods require the appropriate Pixelmon to be installed. Please look to the previous section on how to install Pixelmon.
-# Much like Pixelmon, sidemods must be paired with the corresponding versions. See the [[sidemod]] page for more details.
+<!--T:7-->
-# Once you have selected the sidemod version that matches your Pixelmon, visit our [http://pixelmonmod.com/downloads.php downloads page] to fetch the files.
+{|class="wikitable"
-# 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.
+!''Minecraft'' version
-# 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.
+!Pixelmon version
-== 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.''
+|style="text-align:center"|1.20.2
-# SpongeForge requires the appropriate Forge to be installed. Much like Pixelmon, it also requires the corresponding Minecraft.
+|style="text-align:center"|9.2.8
-# In the main directory of the server, open the /mods folder.
+|-
-# Download the appropriate SpongeForge through [https://www.spongepowered.org/downloads/spongeforge/stable/1.10.2 this page]. Please note that Minecraft version 1.8.9 and below are not recommended if you are using SpongeForge.
+|style="text-align:center"|1.20.1
-# After selecting the SpongeForge version (latest stable build is the recommended), download the file.
+|style="text-align:center"|9.2.0-9.2.3
-# 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''.
+|-
-# Copy the fresh SpongeForge jar to the /mods folder of your server's directory.
+|style="text-align:center"|1.16.5
-# 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.
+|style="text-align:center"|9.1.12
-# Restart the server using the command prompt. Upon booting up, your server now has SpongeForge. 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 report to Pixelmon's [https://www.pixelmonmod.com/tracker.php?p=4/ support tracker] or seek help from our Support team in the [[Pixelmon Discord]].
+== Step 1: Forge installation == <!--T:8-->
-* If you are using the optional SpongeForge plugin, read the [https://docs.spongepowered.org/master/en/server/index.html provided documentation] on the Sponge Forums.
+# Find the current recommended Forge build, [https://files.minecraftforge.net/net/minecraftforge/forge/index_1.20.2.html for 1.20.2] and [https://files.minecraftforge.net/net/minecraftforge/forge/index_1.16.5.html for 1.16.5].
-* If you are having issues with a sidemod, report to the Sidemod tracker [http://www.pixelmonmod.com/tracker.php?p=6 here].
+# Download the "Installer" file and run it.
+==== Starting on Windows ==== <!--T:9-->
+# If you haven't already, enable showing file extensions by following [https://www.bleepingcomputer.com/tutorials/how-to-show-file-extensions-in-windows/ this guide].
+# 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 -Xms3G -Xmx3G -XX:+UseG1GC -XX:+UnlockExperimentalVMOptions -XX:MaxGCPauseMillis=100 -XX:+DisableExplicitGC -XX:TargetSurvivorRatio=90 -XX:G1NewSizePercent=50 -XX:G1MaxNewSizePercent=80 -XX:G1MixedGCLiveThresholdPercent=50 -XX:+AlwaysPreTouch -jar forge-[VERSION].jar nogui&#10;PAUSE</pre>
+# Replace <code>[VERSION]</code> with the version of Forge you installed. Make sure the file name is an exact match!
+# 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 ==== <!--T:10-->
+# Open the Terminal or its equivalent.
+# Navigate to the home folder by using <code>cd ~</code>. Use <code>ls</code> to show the folders accessible from your current location.
+# Find the folder you installed Forge to. Use <code>cd FOLDERNAME</code> to enter a folder, and <code>cd ..</code> to go back up one level.
+# In the Terminal, enter (copy and paste) the following command, but do not run it yet:
+#: <pre>java -Xms3G -Xmx3G -XX:+UseG1GC -XX:+UnlockExperimentalVMOptions -XX:MaxGCPauseMillis=100 -XX:+DisableExplicitGC -XX:TargetSurvivorRatio=90 -XX:G1NewSizePercent=50 -XX:G1MaxNewSizePercent=80 -XX:G1MixedGCLiveThresholdPercent=50 -XX:+AlwaysPreTouch -jar forge-[VERSION].jar nogui</pre>
+# Replace <code>[VERSION]</code> with the version of Forge you installed. Make sure the file name is an exact match!
+# Copy the command somewhere safe for later use.
+# Run the command to start the server.
+== Step 2: Accepting the EULA == <!--T:11-->
+# 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.
+# 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 == <!--T:12-->
+[[File:Serverjarlink.PNG|thumb|300px|The -server jar is located on the main [https://reforged.gg Pixelmon] site underneath the downloads button. The red line indicates the link that is to be pasted into your browser for the download to commence.]]
+# 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 Pixelmon from [https://reforged.gg this link] and drop it in. '''Do not extract or otherwise change this file!'''
+#* ''Note: Pixelmon comes in both -universal and -server variants. The -server file (from the link below the buttons) is smaller and may include additional fixes, but will only work on servers.
+# It is recommended to delete the world that was generated in Step 2, before the server is started again with the addition of Pixelmon and other mods (especially biome generation mods). If deleted and a new world is generated, players will initially spawn in a Village as intended and Pixelmon features (along with any other mods) will generate near spawn. This also ensures the chunks near spawn generate properly if a biome mod is used and decreases the chance for chunk errors.
+# Start the server again. Your server should now be running Pixelmon!
+== Step 4: Configuring Pixelmon == <!--T:13-->
+# With Pixelmon running, you should now have a <code>config</code> folder in the server root. Open this.
+# Open up the <code>pixelmon</code> folder, here you'll find multiple files, each one containing various settings. See [[Configs]] section for descriptions and values.
+# Tweak to taste. Some settings will only apply to fresh chunks, so make sure you set those now.
+#* ''Note: To avoid loot drain over time, be sure to change <code>spawnMode</code> under <code>PokeLoot</code> now!''
+== Optional: Sidemod installation == <!--T:14-->
+''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 an interesting sidemod, check its wiki page for a list of requirements and fulfill them.
+#* ''Note: Sidemod configuration files are generally created alongside Pixelmon's own [[config]].''
+# 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.''
+<!--T:15-->
+Note that many sidemods require a plugin platform like SpongeForge (covered below) as well as a permissions plugin like [https://github.com/lucko/LuckPerms LuckPerms]. Be sure to check the requirements!
+<!--T:16-->
+== Optional: ArcLight server installation ==
+''This section is optional. If you do not want to use plugins with mods that rely on Spigot Plugins, skip this part of the guide.``
+# Download the recommended build for 1.16.x or 1.20.1 from [https://github.com/IzzelAliz/Arclight/releases this page] (Arclight is not compatible with Pixelmon 9.2.4+)
+# Place it in your main folder of your server
+# Launch the server from the ''arclight-forge-1.x.x-1.x.x.jar'' file
+# A new Plugin folder will be created after a successful launch. Place your plugins in there and restart the server.
+== Troubleshooting == <!--T:19-->
+* 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 [https://docs.spongepowered.org/master/en/server/index.html SpongeForge documentation] on the Sponge site.
+* If you are using ArcLight, be sure to to read [https://github.com/IzzelAliz/Arclight/wiki ArcLight Wiki] and check out [https://discord.gg/KzWmvu7YUv their Discord]
+* 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].
+</translate>

Difference between revisions of "Server installation"

Difference between revisions of "Server installation"

Latest revision as of 17:24, 18 August 2024

Contents

Requirements

Notes

Versions

Step 1: Forge installation

Starting on Windows

Starting on macOS/Linux

Step 2: Accepting the EULA

Step 3: Installing Pixelmon

Step 4: Configuring Pixelmon

Optional: Sidemod installation

Optional: ArcLight server installation

Troubleshooting