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 2: / Line 2: @@
   |title=Server installation
   |title_mode=replace
-  |keywords=Pixelmon, Reforged, server, installation, install, Minecraft, Forge, SpongeForge, local
+  |keywords=Pixelmon, Reforged, server, installation, install, Minecraft, Forge, SpongeForge, local, arclight
   |description=A guide to installing Pixelmon on a (local) server.
 }}
@@ Line 8: / Line 8: @@
 <translate>
 <!--T:1-->
-This guide will cover installing [[Pixelmon]] to a server.
+This guide will cover manually creating a Pixelmon server.
 <!--T:2-->
-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 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 [[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].
 == Requirements == <!--T:3-->
-* At least 3 GB of available (and allocated) RAM, preferably more.
+* At least 3 GB of allocated memory, preferably more. Exact requirements will depend on player count and your exact mods/plugins.
-** Exact requirements will depend on your player count, and which plugins/mods you install.
+* 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!'''
-* A 64-bit Java 8 version. '''Earlier or later versions of Java will not work!'''
 == Notes == <!--T:4-->
 * 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 [https://minecraft.gamepedia.com/Tutorials/Setting_up_a_server#Port_forwarding this page].
+** 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].
 ** For bigger servers, using a paid hosting service is strongly recommended for performance, stability and safety. Steps may differ, there.
-* 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 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.
-** 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!
 * 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.
@@ Line 31: / Line 30: @@
 <!--T:6-->
-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.
 <!--T:7-->
-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.
-<!--T:8-->
 {|class="wikitable"
 !''Minecraft'' version
 !Pixelmon version
 |-
-|style="text-align:center"|1.12.2
+|style="text-align:center"|1.20.2
-|style="text-align:center"|7.3.1
+|style="text-align:center"|9.2.8
 |-
-|style="text-align:center"|1.10.2
+|style="text-align:center"|1.20.1
-|style="text-align:center"|5.1.2
+|style="text-align:center"|9.2.0-9.2.3
 |-
-|style="text-align:center"|1.8.9
+|style="text-align:center"|1.16.5
-|style="text-align:center"|4.3.1
+|style="text-align:center"|9.1.12
-|-
-|style="text-align:center"|1.8
-|style="text-align:center"|4.1.4
-|-
-|style="text-align:center"|1.7.10
-|style="text-align:center"|3.5.1
 |}
-== Step 1: Forge installation == <!--T:9-->
+== Step 1: Forge installation == <!--T:8-->
-# Find Forge build 2838 or newer on [https://files.minecraftforge.net this page].
+# 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].
-# Download the "Installer" file.
+# Download the "Installer" file and run it.
-#* ''Note: Some specific Windows setups may need the newest "Installer-win" file from "Show all Versions", instead.
-# 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 ==== <!--T:10-->
+==== 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.
@@ Line 71: / Line 57: @@
 # 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]-universal.jar nogui&#10;PAUSE</pre>
+#: <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:11-->
+==== Starting on macOS/Linux ==== <!--T:10-->
 # Open the Terminal or its equivalent.
-# Navigate to the folder you installed Forge to.
+# 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]-universal.jar nogui</pre>
+#: <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:12-->
+== 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.
@@ Line 92: / Line 79: @@
 # Start the server again, and wait for it to create a fresh world.
-== Step 3: Installing Pixelmon == <!--T:13-->
+== 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 and drop it into this folder. '''Do not extract or otherwise change the Pixelmon file!'''
+# Download Pixelmon from [https://reforged.gg this link] and drop it in. '''Do not extract or otherwise change this file!'''
-#* ''Note: Using the -server file is generally recommended, as it might include additional fixes.''
+#* ''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!
-Before proceeding further, customize Pixelmon's [[config]] file (located in the <code>config</code> folder) to taste. Some settings (such as being able to re-use Pokéloot) will only apply to newly-generated chunks! Restart the server after saving your changes to apply them.
+== 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 a sidemod that looks interesting, check its page for a list of requirements and fulfill them.
+# 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.
@@ Line 111: / Line 104: @@
 <!--T:15-->
-Most sidemods need, at a minimum, SpongeForge (covered below) as well as a permissions plugin like [https://github.com/lucko/LuckPerms LuckPerms].
+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!
-== Optional: SpongeForge installation == <!--T:16-->
-''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 [https://www.spongepowered.org/downloads/spongeforge/stable/1.12.2 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 <code>mods</code> folder.
-# Restart the server again.
-<!--T:17-->
+<!--T:16-->
-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].
+== 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:18-->
+== 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