Skip to main content

Setting Up a Server

Setting up a local Minecraft server loaded with PGM is one of the best ways to test your map without disruption and allows for greater experimentation. Additionally, being able to test maps before submitting to a Minecraft network of your choice means that you will be able to catch mistakes early and speed up the map submission process.

note

This guide is divided into three most commonly used operating systems. Please keep in mind that some steps may differ or may not apply to your system. If you have any questions or need assistance, please visit our Discord server.

Windows​

This guide uses Windows 11, however, the same process will work on Windows 10 and older.

Installing Java​

We recommend using either Java 8 or Java 11. For this guide, we will be using Amazon Corretto 11. However, you may choose to use OpenJDK or Eclipse Adoptium as well. If you already have a copy of Java 8 or Java 11 installed, you may skip this step.

Downloading SportPaper​

Get the latest version of SportPaper from the Downloads page. Once the download is done, you must put SportPaper.jar inside an empty folder.

Next, you must create a Batch file to be able to start your server and have access to its console. Start by opening your preferred text editor, copy and paste the following example below, and save the file as start.bat. You must always double-click the start.bat file to launch the server, not the .jar file.

start.bat
@ECHO OFF
TITLE SportPaper 1.8
java -Xms128M -Xmx2G -Dfile.encoding=UTF8 -Dterminal.jline=false -Dterminal.ansi=true -jar SportPaper.jar nogui
PAUSE

Downloading PGM​

You have two options when it comes to downloading PGM. You can download the stable version of PGM from the Downloads page or you can download the development builds from its GitHub repository. If you are working on a map that will utilize features introduced in pre-release versions of PGM, we recommend downloading the development build.

Once the download is done, you must put PGM.jar inside the plugins folder (create if it does not exist), which can be found in the folder that contains the SportPaper.jar file.

Starting the Server​

Once you are done with the initial setup, you can double-click start.bat to let SportPaper create the necessary files for Minecraft and PGM. You can now join the server from your Minecraft client at localhost or 127.0.0.1:25565.

Also see Additional Setup if you would like to make the most use out of your newly-created server.

macOS​

This guide uses macOS 12 (Monterey). The process should be the same for newer versions of macOS, however, you may need to proceed differently if you are using an older version of macOS.

Installing Java​

We recommend using either Java 8 or Java 11. For this guide, we will be using Amazon Corretto 11. However, you may choose to use OpenJDK or Eclipse Adoptium as well. If you already have a copy of Java 8 or Java 11 installed, you may skip this step.

Downloading SportPaper​

Get the latest version of SportPaper from the Downloads page. Once the download is done, you must put SportPaper.jar inside an empty folder.

Next, you must create a Terminal shell script file to be able to start your server and have access to its console. Start by opening your preferred text editor, copy and paste the following example below, and save the file as start.command.

start.command
#!/bin/sh

cd "$( dirname "$0" )"
java -Xms128M -Xmx2G -Dterminal.jline=false -Dterminal.ansi=true -jar SportPaper.jar nogui

You also need to mark the script file as executable. Start by opening Terminal, type the following command below (but do not press Enter yet) and drag the file into the window. The file path will appear and highlight itself once this is done, then you can press Enter.

chmod a+x <path to your start.command file>

You must always double-click the start.command file to launch the server, not the .jar file.

Downloading PGM​

You have two options when it comes to downloading PGM. You can download the stable version of PGM from the Downloads page or you can download the development builds from its GitHub repository. If you are working on a map that will utilize features introduced in pre-release versions of PGM, we recommend downloading the development build.

Once the download is done, you must put PGM.jar inside the plugins folder (create if it does not exist), which can be found in the folder that contains the SportPaper.jar file.

Starting the Server​

Once you are done with the initial setup, you can double-click start.command to let SportPaper create the necessary files for Minecraft and PGM. You can now join the server from your Minecraft client at localhost or 127.0.0.1:25565.

Also see Additional Setup if you would like to make the most use out of your newly-created server.

Linux​

This guide uses commands that are available for Debian-based distributions. Please keep in mind that the following process may differ depending on your distribution. If necessary, consult your distribution's documentation or user manual. Otherwise, we trust that you know what you are doing.

Installing Java​

We recommend using either Java 8 or Java 11. For this guide, we will be using OpenJDK. However, you may choose to use Amazon Corretto 11 or Eclipse Adoptium as well. If you already have a copy of Java 8 or Java 11 installed, you may skip this step.

sudo apt update && sudo apt install openjdk-11-jdk

Downloading SportPaper​

Get the latest version of SportPaper from the Downloads page. Once the download is done, you must put SportPaper.jar inside an empty folder.

Next, you must create a shell script file to be able to start your server and have access to its console. Start by opening your preferred text editor, copy and paste the following example below, and save the file as start.sh.

start.sh
#!/bin/sh

java -Xms128M -Xmx2G -Dterminal.jline=false -Dterminal.ansi=true -jar SportPaper.jar nogui

You also need to mark the script file as executable. Start by opening your terminal in the server's directory and typing the following command below.

sudo chmod +x start.sh

You must always execute from start.sh to launch the server, not the .jar file.

Downloading PGM​

You have two options when it comes to downloading PGM. You can download the stable version of PGM from the Downloads page or you can download the development builds from its GitHub repository. If you are working on a map that will utilize features introduced in pre-release versions of PGM, we recommend downloading the development build.

Once the download is done, you must put PGM.jar inside the plugins folder (create if it does not exist), which can be found in the folder that contains the SportPaper.jar file.

Starting the Server​

Once you are done with the initial setup, you can launch from your terminal (./start.sh) to let SportPaper create the necessary files for Minecraft and PGM. You can now join the server from your Minecraft client at localhost or 127.0.0.1:25565.

Also see Additional Setup if you would like to make the most use out of your newly-created server.

Additional Setup​

Configure SportPaper​

Using your text editor of choice, you may edit server.properties and sportpaper.yml. We recommend changing the following options below:

server.properties
allow-nether=false
announce-player-achievements=false
generate-structures=false
sportpaper.yml
bukkit:
  settings:
    allow-end: false
spigot:
  # Forcibly disable vanilla Minecraft achievements.
  stats:
    disable-saving: true
    forced-stats:
      achievement:
        openInventory: 1
  world-settings:
    anti-xray:
      enabled: false # Helps with reducing lag; public servers should utilize an anti-cheat plugin.
paper:
  settings:
    empty-server-suspend: P100D # Prevent the server from immediately suspending itself due to inactivity.
  world-settings:
    fix-cannons: true # Stops ignited TNT from moving in flowing water. Recommended when making maps that involves TNT.
    game-mechanics:
      disable-chest-cat-detection: true # Helps with reducing lag.
    optimize-explosions: true # Recommended when making maps that involves TNT.

Configure PGM​

PGM will load with five default maps out of the box. You are expected to configure the plugin before you can begin using additional maps. We encourage you to understand and modify PGM's config to your liking, similarly to what we've done below:

/plugins/PGM/config.yml
map:
  folders:
    # List of folders to load maps.
    # You can add multiple folders from different sources.
    - "local-maps" # Loads maps from a folder named "local-maps" located in your server's directory.

  repositories:
    # List of git repositories to load maps.
    # When using multiple GitHub repositories hosted by PGM networks, beware of duplicate maps.
     - uri: "https://github.com/PGMDev/Maps"
      path: "sample-github-maps"

# Experimental features that are not yet stable.
experiments:
  # Set to "true" if you plan on creating and testing Payload maps.
  payload: true

Load and Configure WorldEdit​

Some servers may choose to use WorldEdit. Since SportPaper is based on Minecraft 1.8 server software, the latest compatible version of WorldEdit is 6.1.9.

Once the download is done, place worldedit-bukkit-6.1.9.jar inside the plugins folder and restart the server. Afterwards, you can navigate to /plugins/WorldEdit/config.yml and change the following option below:

/plugins/WorldEdit/config.yml
# PGM will give observers with OP the "Rabbit's Foot" item, which allows them to edit the world during a match.
wand-item: 414