ServerPackCreator

ServerPackCreator creates a server pack from any given Forge, Fabric, Quilt, LegacyFabric and NeoForge modpack.

Whenever you are working on an update to your modpack, you simply run ServerPackCreator and BAM! You’ve got yourself a server pack for your new modpack version.

ServerPackCreator is a passion project on which I am working in my spare time. It is also the main reason for why I got into programming in the first place. Patience with issues and support is appreciated!

I started getting into Java programming in February 2021, when I was working on an update for one of my Minecraft modpacks, Survive Create Prosper 4, and got tired and bored with manually creating a server pack everytime I wanted to update and test something, or just release a new server pack for the new modpack version.

The thought “There must be a way to automate this, or at least make it less tedious…” was the spark which sent me off into the world of programming. And here we are.

READ BEFORE USE:

FOR THE LOVE OF GODS, TEST YOUR SERVER PACKS BEFORE YOU SHIP THEM!

• ServerPackCreator is not a guarantee for working server packs. It helps you create them, but you must still test them!
• You are still expected to be knowledgeable about your modpack, server packs in general, server administration and managing your Java installations. ServerPackCreator is not intended to take all the work off your shoulders!
• When using alpha, beta or in-dev version of ServerPackCreator, it is advised to make a backup of your ServerPackCreator-directory in your home-directory.
• Things will break with alpha releases, stuff may break when using beta releases.
• If you distribute server packs generated with a pre-release (alpha, beta) of ServerPackCreator, you do so at your own risk.
• I will not be held responsible for errors in your server pack caused by you using a pre-release.
• I will not be held responsible for errors in your server pack in general. Test your server packs before you ship them!
• TL;DR: Don’t use test to ship to prod! Test before shipping!

Pre-Releases:

There are two kinds of pre-releases: Alphas and Betas

• Alphas: Missing features, incomplete features, almost guaranteed to have bugs / errors
• Betas: Feature complete, probably contains bugs / errors

Screenshots

CLI	GUI	WEB

Advantages/Disadvantages of CLI, GUI and WEB:

Each way of using ServerPackCreator has its advantages and disadvantages. Depending on your environment, it may be better to use one way over the other. This section highlights some of the advantages and disadvantages of each version to help you decide which way you are going to use. Note: All three ways are supported by the .jar-file. Which one is started depends on the CLI arguments used and your environment.

CLI:

GUI:

WEB:

1. Small feature overview

1. Exclude clientside-only mods
   • Automatically by letting ServerPackCreator scan the mods of your modpack for their sideness
   • Manually by configuring a list mods which ServerPackCreator will filter out according to your input and the chosen filter.
2. Add files and directories in your server pack.
   • Files and directories in your modpack
   • Files and directories from your computer
3. Add a server icon
   • Server icons are automatically scaled down, or up, to 64x64!
   • Specify a custom one, or use a default provided by ServerPackCreator.
     • Change the default to your liking if you intend on using the same icon across multiple server packs!
4. Add a server.properties
   • Ship your server pack with default settings!
   • Specify a custom one, or use a default provided by ServerPackCreator.
     • Change the default to your liking if you intend on using the same icon across multiple server packs!
5. Many modloaders supported
   • Forge
   • Fabric
   • LegacyFabric
   • Quilt
   • NeoForge
6. Use Minecraft snapshots and pre-releases
   • Per default, only regular releases enabled
7. Let ServerPackCreator install the modloader-server for your server pack, for immediate testing and debugging after generation!
8. Let ServerPackCreator generate a ZIP-archive, for immediate upload to places like CurseForge (after you’ve tested your server pack, of course 😉)
9. Configure commandline arguments with which to start the Minecraft server
   • Does your modpack require a lot of RAM? Well, tell ServerPackCreator to create the start scripts with -Xms8G -Xmx8G or similar values!
   • Aikars flags are available, too. If you like 'em, use 'em.
10. Create your own start-script templates
    • Add additional functionality to your servers start scripts
    • Use placeholders in your templates, to be replaced with custom values
      • Example: placeholder SPC_FLYNN_LIVES_SPC in the templates can be replaced with a value configured on a per-server pack basis, i.e Now that's a big door
11. Plugins!
    • ServerPackCreator allows you to use plugins to add new features in various places.
    • Four plugins ship with every release, each marked _experimental in its filename — a grinder-backed clientside-mod picker, a server-pack test launcher, a self-extracting-archive writer, and a worked example to copy from. See 6. Experimental plugins.
    • The source for the example is in this repository, at Example Plugin

2. Issues and help

• Report a bug / ask for a feature / ask for an improvement / request a documentation improvement:
  • https://github.com/Griefed/ServerPackCreator/issues/new/choose
• There’s a Wiki available which goes into further detail for many of ServerPackCreators available aspects:
  • https://serverpackcreator.de/help/latest/help-topic.html
• The same as the Wiki, but as a file should you prefer it. 😊
  • HELP.md

3. How To

The first time you start ServerPackCreator, you will be asked whether you want to see a small step-by-step guide. Said guide will show you the most important parts in configuring your server pack.

Should you at any point want to revisit said guide, simply hit About -> Step-By-Step Guide in the menu at the top.

kreezxil has made a video showing a step-by-step video-tutorial for ServerPackCreator:

4. Java

Required:

• Using the JAR-file release requires Java 21.
• Working internet connection recommended.

The installers ship their own Java installations.

ATTENTION: I can not and will not guarantee that ServerPackCreator will work flawlessly with any other Java version other than version 21. Things may break at random, at any place, if a different Java version is used. You are welcome to try and use any other version, but do not report issues back to me if you do encounter problems when running ServerPackCreator with a more recent Java version.

5 Running

1. If you’ve used the installer to acquire ServerPackCreator, use the shortcut created by the installer to run ServerPackCreator. The installers provide their own Java runtime, so you do not need to install Java separately.
2. If you’ve downloaded the JAR-file, and depending on how your Java installation is set up, you may be able to simply run the JAR via double-click or other methods, or you may need to run it from the commandline.

There are a couple of arguments which may or may not be helpful for you, depending on how you plan on using ServerPackCreator:

The four clientside-verification arguments (-scan, -clientsidereport, -verifyclientside, -clientsideapply) are aimed at maintainers of the clientside-only mod list rather than at everyday use. -verifyclientside boots a real Minecraft server, so expect it to take a while.

5.1 Generating a server pack from a modpack, via CLI

Everything the GUI does to turn a modpack into a server pack is reachable from the commandline, and none of it needs a graphical environment. There are three routes, and which one you want depends on how much control you need:

All three are one-shot: ServerPackCreator starts, does the thing, prints the result and exits. The interactive shell (-cli, see 5.1.6) wraps the same verbs in a prompt with tab-completion, if you’d rather poke around.

Which command do I type? The examples below all use java -jar ServerPackCreator.jar, because that is the form which works everywhere. If you acquired ServerPackCreator some other way, use its launcher instead — the arguments are the same:

• java -jar ServerPackCreator-<VERSION>.jar -feelinglucky "/path/to/modpack"
• ./ServerPackCreator-<VERSION>-x86_64.AppImage -feelinglucky "/path/to/modpack"
• "C:\Program Files\ServerPackCreator\ServerPackCreator.exe" -feelinglucky "C:/modpacks/MyPack"

The installers additionally place a ServerPackCreator-CLI launcher next to the main one. That one starts with -cli already applied, so it drops you straight into the interactive shell of 5.1.6.

5.1.1 The thirty-second version

# Generate a server pack from a modpack directory. That's it. That's the command.
java -jar ServerPackCreator.jar -feelinglucky "/home/griefed/CurseForge/Instances/Survive Create Prosper"

On success the last line printed is:

Successfully generated Server Pack: /home/griefed/serverpackcreator/server-packs/Survive Create Prosper

5.1.2 Where things end up

Unless you say otherwise, every path is resolved relative to ServerPackCreator’s home-directory. The home-directory is picked on first run and remembered afterwards; --home (see 5.1.7) overrides it.

Not sure where your home-directory is? Check the log for Home directory set to:, or run with --home to put it somewhere you chose.

5.1.3 -feelinglucky — modpack in, server pack out

-feelinglucky does the whole pipeline in one shot: derive a config from the modpack, save that config into <home>/configs/, check it, and — if the check passes — generate the server pack. No warranty, no guarantees; if the check fails it prints the problems and stops without generating.

# Simplest form. Server pack lands in <home>/server-packs/
java -jar ServerPackCreator.jar -feelinglucky "/home/griefed/modpacks/Survive Create Prosper"

# Choose where the server pack lands. Parent folders are created for you.
java -jar ServerPackCreator.jar -feelinglucky "/home/griefed/modpacks/SCP" --destination "/srv/minecraft/scp-server"

# Paths with spaces MUST be quoted. This is the single most common mistake.
java -jar ServerPackCreator.jar -feelinglucky "/home/griefed/Some Modpack With Spaces"

# Relative paths work and are resolved against your current working directory.
java -jar ServerPackCreator.jar -feelinglucky "./modpacks/SCP"

# A CurseForge (Overwolf) instance — point at the instance folder, the one holding minecraftinstance.json
java -jar ServerPackCreator.jar -feelinglucky "/home/griefed/CurseForge/Instances/All the Mods 9"

# Windows, PowerShell. Forward slashes are fine and spare you the escaping.
java -jar ServerPackCreator.jar -feelinglucky "C:/Users/Griefed/curseforge/minecraft/Instances/All the Mods 9"

# Windows, cmd.exe, with backslashes
java -jar ServerPackCreator.jar -feelinglucky "C:\Users\Griefed\curseforge\minecraft\Instances\All the Mods 9"

# Windows, generating straight onto a mapped network drive
java -jar ServerPackCreator.jar -feelinglucky "C:/modpacks/SCP" --destination "Z:/servers/scp"

# Combine with an explicit home-directory, so nothing touches your normal installation
java -jar ServerPackCreator.jar --home "/tmp/spc-scratch" -feelinglucky "/home/griefed/modpacks/SCP"

5.1.4 -cgen and -config — the two-step, when you want control

-feelinglucky gives you no chance to intervene. Splitting it in two does:

Step 1 — derive the config:

java -jar ServerPackCreator.jar -cgen "/home/griefed/modpacks/Survive Create Prosper"

-cgen inspects the modpack, writes a config to <home>/configs/<modpack name> and prints the resulting configuration to the console. It does not generate a server pack. The path it wrote to is in the log line Config for <modpack> available at <config>.

Step 2 — edit it, then generate from it:

# Open <home>/configs/Survive Create Prosper in your editor, change what you like, then:
java -jar ServerPackCreator.jar -config "/home/griefed/serverpackcreator/configs/Survive Create Prosper"

More -config examples:

# Config kept next to your modpacks rather than in the configs-directory
java -jar ServerPackCreator.jar -config "/home/griefed/modpacks/scp/serverpackcreator.conf"

# Generate into a specific location instead of <home>/server-packs/
java -jar ServerPackCreator.jar -config "/home/griefed/configs/scp.conf" --destination "/srv/minecraft/scp"

# Straight into a running server's directory, ready to be started
java -jar ServerPackCreator.jar -config "./scp.conf" --destination "/opt/minecraft/servers/scp"

# Windows
java -jar ServerPackCreator.jar -config "C:/Users/Griefed/serverpackcreator/configs/AllTheMods9" --destination "C:/servers/atm9"

# Same config, several destinations — handy when you run a test server and a live one
java -jar ServerPackCreator.jar -config "./scp.conf" --destination "/srv/mc/scp-test"
java -jar ServerPackCreator.jar -config "./scp.conf" --destination "/srv/mc/scp-live"

# Explicit home-directory, so the config-, server-pack- and log-directories all come from there
java -jar ServerPackCreator.jar --home "/srv/spc" -config "/srv/spc/configs/scp" --destination "/srv/mc/scp"

If you pass no -config, the interactive shell’s run verb falls back to <home>/serverpackcreator.conf — see 5.1.6.

5.1.4.1 What a config looks like

A config derived by -cgen is a plain text file you can edit by hand. The interesting fields:

# Path to your modpack. Can be either relative or absolute.
modpackDir = "/home/griefed/modpacks/Survive Create Prosper"

# Mods to force-include even if they look clientside. Filenames, no versions.
whitelist = ["Ping-Wheel-"]

# Additional clientside-only mods to delete from the server pack. Filenames, no versions.
clientMods = ["AmbientSounds_","ClientTweaks-","PackMenu-","BetterAdvancements-"]

# What gets copied into the server pack. Source is required, the rest is optional.
[[inclusions]]
	source = "mods"
	destination = ""
	inclusionFilter = ""
	exclusionFilter = ""
[[inclusions]]
	source = "config"
[[inclusions]]
	source = "defaultconfigs"

minecraftVersion = "1.20.1"
modLoader = "Forge"          # Forge, NeoForge, Fabric, Quilt or LegacyFabric
modLoaderVersion = "47.2.20"

includeServerIcon = true
includeServerProperties = true
includeZipCreation = true

# Java arguments baked into the generated start-scripts. "empty" for none.
javaArgs = "-Xmx4G -Xms4G"

# Appended to the server pack's name, so several variants can coexist
serverPackSuffix = ""

# Replaced verbatim in the start-scripts
[scripts]
	SPC_JAVA_SPC = "java"

Editing that file and re-running -config is the whole “advanced” workflow. Common edits:

# 1. Derive
java -jar ServerPackCreator.jar -cgen "/home/griefed/modpacks/SCP"
# 2. Add a mod to clientMods, bump javaArgs to -Xmx8G, set serverPackSuffix = "-lite"
$EDITOR "/home/griefed/serverpackcreator/configs/SCP"
# 3. Generate
java -jar ServerPackCreator.jar -config "/home/griefed/serverpackcreator/configs/SCP"

5.1.4.2 Which modpacks get detected automatically

-cgen and -feelinglucky fill in minecraftVersion, modLoader, modLoaderVersion and the pack name by reading whichever launcher-manifest they find. The first match wins, in this order:

That “parent directory” row is the one that trips people up. For MultiMC, Prism and GDLauncher you point the argument at the .minecraft/minecraft folder inside the instance, not at the instance folder — the manifest then sits one level up, which is exactly where ServerPackCreator looks:

# Prism Launcher
java -jar ServerPackCreator.jar -cgen "/home/griefed/.local/share/PrismLauncher/instances/ATM9/minecraft"

# MultiMC
java -jar ServerPackCreator.jar -cgen "/home/griefed/MultiMC/instances/ATM9/.minecraft"

# GDLauncher
java -jar ServerPackCreator.jar -cgen "/home/griefed/gdlauncher_next/instances/ATM9/instance"

# ATLauncher — manifest sits in the instance directory itself
java -jar ServerPackCreator.jar -cgen "/home/griefed/ATLauncher/instances/ATM9"

If none of those manifests is present — a hand-assembled modpack, a .mrpack you unzipped yourself, a server directory you are re-packing — nothing breaks, but minecraftVersion, modLoader and modLoaderVersion come out empty. Fill them in by hand, then run -config:

java -jar ServerPackCreator.jar -cgen "/home/griefed/modpacks/hand-rolled"
$EDITOR "/home/griefed/serverpackcreator/configs/hand-rolled"   # set the three version fields
java -jar ServerPackCreator.jar -config "/home/griefed/serverpackcreator/configs/hand-rolled"

5.1.5 -withallinconfigdir — rebuild everything

Runs a check-and-generate for every file in <home>/configs/, one after another.

# Rebuild every server pack you have a config for
java -jar ServerPackCreator.jar -withallinconfigdir

# Same, against a dedicated home-directory — the pattern for a build server
java -jar ServerPackCreator.jar --home "/srv/spc" -withallinconfigdir

--destination is not honoured here; each pack lands in <home>/server-packs/. Give each config a distinct serverPackSuffix if you need to tell variants apart.

5.1.6 -cli — the interactive shell

-cli opens a prompt with tab-completion, autosuggestions and inline help. It is the same set of verbs, just interactive, and it is what you get automatically in a headless environment when no other argument was passed.

java -jar ServerPackCreator.jar -cli

ServerPackCreator> feelingLucky -m "/home/griefed/modpacks/SCP"
ServerPackCreator> feelingLucky -m "/home/griefed/modpacks/SCP" -d "/srv/mc/scp"
ServerPackCreator> cgen                                   # prompts for the modpack directory
ServerPackCreator> run                                    # generates from <home>/serverpackcreator.conf
ServerPackCreator> run withSpecificConfig -c "/home/griefed/configs/scp.conf"
ServerPackCreator> run withSpecificConfig -c "./scp.conf" -d "/srv/mc/scp"
ServerPackCreator> run withAllInConfigDir                 # same as -withallinconfigdir
ServerPackCreator> homeDir                                # change the home-directory
ServerPackCreator> lang                                   # list and pick a language
ServerPackCreator> setup                                  # re-run first-time setup
ServerPackCreator> update                                 # check for a newer release
ServerPackCreator> printHelp                              # the full help-text
ServerPackCreator> help run                               # help for one verb
ServerPackCreator> clear                                  # or 'cls'

Press Tab to complete, Alt+S to toggle the suggestion line, and Ctrl+D to leave.

5.1.7 Combining with the global arguments

--home and -lang are parsed before the mode is decided, so they combine with any of the above.

# Run against a throwaway home-directory. The directory must already exist.
java -jar ServerPackCreator.jar --home "/tmp/spc-test" -feelinglucky "/home/griefed/modpacks/SCP"

# Prepare a fresh home-directory before the first generation
mkdir -p /srv/spc
java -jar ServerPackCreator.jar --home "/srv/spc" --setup

# Seed that home-directory from a prepared properties-file, then generate
java -jar ServerPackCreator.jar --home "/srv/spc" --setup "/srv/spc-defaults.properties"
java -jar ServerPackCreator.jar --home "/srv/spc" -withallinconfigdir

# Pick a language for this run (and every run after it — the choice is stored)
java -jar ServerPackCreator.jar -lang en_GB -feelinglucky "/home/griefed/modpacks/SCP"
java -jar ServerPackCreator.jar -lang pt_BR -cgen "/home/griefed/modpacks/SCP"

# Print the help-text, which lists every argument with examples
java -jar ServerPackCreator.jar -help

# Check for a newer release. With an installer-based installation this also installs it.
java -jar ServerPackCreator.jar -update

--home is sticky. It is not a per-run override — it is written to your user preferences, and every subsequent run without --home uses it too. Pass it again to move back.

5.1.8 Automating it

Generation is one process invocation, so anything that can run a command can run this.

#!/usr/bin/env bash
# Rebuild one server pack and deploy it. Run from cron, a git hook, CI, whatever.
set -euo pipefail

SPC_JAR="/opt/serverpackcreator/ServerPackCreator.jar"
MODPACK="/srv/modpacks/SCP"
DESTINATION="/srv/minecraft/scp"

java -jar "$SPC_JAR" --home /srv/spc -feelinglucky "$MODPACK" --destination "$DESTINATION"

# Rebuild every modpack under a directory, one server pack each
for modpack in /srv/modpacks/*/; do
    java -jar /opt/serverpackcreator/ServerPackCreator.jar \
        -feelinglucky "$modpack" \
        --destination "/srv/server-packs/$(basename "$modpack")"
done

# Nightly rebuild of everything you have a config for, at 04:00
0 4 * * * java -jar /opt/serverpackcreator/ServerPackCreator.jar --home /srv/spc -withallinconfigdir >> /var/log/spc.log 2>&1

# Windows, PowerShell
& java -jar "C:\Tools\ServerPackCreator.jar" -feelinglucky "C:/modpacks/SCP" --destination "C:/servers/scp"

# Containerised, no GUI involved. Note this uses a plain JRE image and the JAR — NOT the
# griefed/serverpackcreator image, which is hard-wired to start the webservice and does not
# forward arguments to the application.
docker run --rm -v "$PWD:/work" -w /work eclipse-temurin:21-jre \
  java -jar /work/ServerPackCreator.jar \
    --home /work/spc-home \
    -feelinglucky "/work/modpacks/SCP" \
    --destination "/work/server-packs/SCP"

The exit code is meaningful. A one-shot run exits 0 only when it produced what you asked for, and 1 when it did not — a missing argument, a path that does not exist, a configuration check that failed, or a generation that errored. So && does what you would expect:

java -jar "$SPC_JAR" -config "./scp.conf" && deploy_the_server_pack

if ! java -jar "$SPC_JAR" -withallinconfigdir; then
    echo "At least one server pack failed to generate, see output above." >&2
    exit 1
fi

-withallinconfigdir exits 1 if any configuration failed, and 0 when the configs-directory is simply empty — nothing to do is not a failure. The long-running modes (-gui, -web, -cli) do not exit on their own, so there is nothing to check.

5.1.9 Argument precedence, and other things that will bite you

The arguments are not independent flags — the first one that matches decides the whole run, and everything else on the commandline is ignored. The order checked is:

-help → -update → -withallinconfigdir → -scan → -clientsidereport → -verifyclientside → -clientsideapply → -cgen → -config → -feelinglucky → -cli → -web → -gui → --setup

So -cgen "/modpack" -feelinglucky "/modpack" writes a config and does not generate a server pack, because -cgen is checked first. Pick one.

Everything else worth knowing:

• The path is a separate argument, not =. --home "/srv/spc" works; --home=/srv/spc does not.
• Always pass the path. -cgen, -config, -feelinglucky, --setup, --destination and --home all read the next argument. Leaving it off — java -jar ServerPackCreator.jar -config — is reported as a missing value, nothing is generated, and the run exits 1.
• -config wants a file that exists, -cgen/-feelinglucky want a directory that exists. A typo’d path is reported, naming the path it could not find; it is never created for you.
• --home needs the directory to exist already. If it does not, the run says so and keeps the previously configured home-directory.
• --destination only does something next to -config or -feelinglucky. On its own, or with -cgen or -withallinconfigdir, it is ignored.
• Quote paths with spaces. On every platform, in every shell.
• Windows paths take / as well as \. Forward slashes save you a round of escaping.
• A first run has setup to do. Expect the very first invocation on a fresh home-directory to take longer and to reach out to the network for version manifests.

5.2 Running ServerPackCreator as a webservice

DISCLAIMER

There is no publicly available instance of ServerPackCreators webservice due to security concerns with the ability to upload zip-archives. If you want to make use of the webservice, you will have to host your own instance. As such, you are advised to not make your instance of the webservice of ServerPackCreator publicly accessible.

ZIP-archives uploaded by anonymous people may contain illegal or otherwise dangerous data, which could corrupt your system or get you into legal trouble.

If you want to open your webservice-instance to the public, make sure to properly protect it by putting it behind required authorization.

5.2.1 JAR

1. Download the JAR-file from the latest release

2. Run it once, using the -web argument. It will fail to reach a database — you have not configured one yet — but this first run is what creates the home-directory you need in the next step. This is expected, don’t worry.

3. Browser to the now generated ServerPackCreator home-directory

   1. Unsure where said home-directory is? Check the logs for Home directory set to:!

4. Install / setup / provide a MongoDB-database for ServerPackCreator. See MongoDB Installation Tutorial

5. Set the database-properties in the serverpackcreator.properties according to your database

   1. spring.mongodb.uri=
      • Named spring.data.mongodb.uri before ServerPackCreator moved to Spring Boot 4, which retired that key. An existing file using the old name is still read and upgraded automatically.
      • Example:mongodb\://<USER>:<PASSWORD>@localhost\:27017/serverpackcreatordb
      • If the username or password includes the following characters $ : / ? # [ ] @, those characters must be converted using percent encoding (https://datatracker.ietf.org/doc/html/rfc3986#section-2.1) : $ : / ? # [ ] @

6. Run ServerPackCreator, using the -web-argument, again

7. Browse to http://localhost:8080

5.2.1.1 Tweaking the webservice

You may edit the following properties inside the serverpackcreator.properties if you wish to change some parts of the webservice-behaviour:

5.2.2 Docker (recommended)

The recommended, and easiest, way to deploy ServerPackCreator as a webservice is via docker and docker-compose.

Available images can be viewed at https://hub.docker.com/r/griefed/serverpackcreator/tags

About Tags: The example below makes use of the latest-tag. However, using said tag is not recommended, as there may be breaking changes between versions. When setting up ServerPackCreator as a webservice for production, make sure to not use latest and instead use the tag corresponding to the, at this point, latest available release version available.

You must replace <DB_ROOT_USERNAME> and <DB_ROOT_PASSWORD> accordingly. Do note the - ./init-mongo.js:/docker-entrypoint-initdb.d/init.js:ro in the serverpackcreatorb-service. An example for this file is available at docker/init-mongo.js. This init-script initializes the MongoDB with the required user, database and collection.

services:
  serverpackcreatordb:
    image: mongodb/mongodb-community-server:8.0.34-ubuntu2204
    container_name: serverpackcreatordb
    restart: unless-stopped
    environment:
      MONGO_INITDB_ROOT_USERNAME: <DB_ROOT_USERNAME>
      MONGO_INITDB_ROOT_PASSWORD: <DB_ROOT_PASSWORD>
      MONGO_INITDB_DATABASE: serverpackcreatordb
    volumes:
      - ./init-mongo.js:/docker-entrypoint-initdb.d/init.js:ro
      - spcdb-data:/data/db
      - spcdb-conf:/data/configdb

  serverpackcreator:
    container_name: serverpackcreator
    image: griefed/serverpackcreator:latest # For a list of available tags, see https://hub.docker.com/r/griefed/serverpackcreator/tags
    restart: unless-stopped
    depends_on:
      - serverpackcreatordb
    environment:
      - TZ=Europe/Berlin # Your timezone
      - PUID=1000 # Your user ID
      - PGID=1000 # Your group ID
      - SPC_DATABASE_PASSWORD=<DB_ROOT_PASSWORD> # $ : / ? # [ ] @ those characters must be converted using https://datatracker.ietf.org/doc/html/rfc3986#section-2.1
      - SPC_DATABASE_USERNAME=<DB_ROOT_USERNAME> # $ : / ? # [ ] @ those characters must be converted using https://datatracker.ietf.org/doc/html/rfc3986#section-2.1
      - SPC_DATABASE_HOST=serverpackcreatordb  # Do not change this unless you absolutely know what you are doing.
      - SPC_DATABASE_PORT=27017  # Do not change this unless you absolutely know what you are doing.
      - SPC_DATABASE_DB=serverpackcreatordb # Do not change this unless you absolutely know what you are doing.
    ports:
      - "8080:8080" # Port at which SPC will be available at on your host : Port of the webservice inside the container. Only change the left value, it at all.
    volumes:
      - ./modpacks:/app/serverpackcreator/modpacks # Path at which modpacks from the container will be stored at on your host : Path to the modpacks in the container. Only change the left value, if at all.
      - ./server-packs:/app/serverpackcreator/server-packs # Path at which server packs from the container will be stored at on your host : Path to the server packs in the container. Only change the left value, if at all.
      - ./logs:/app/serverpackcreator/logs # Path at which logs from the container will be stored at on your host : Path to the logs in the container. Only change the left value, if at all.

volumes:
  spcdb-data:
  spcdb-conf:

5.2.2.1 Tweaking the docker deployment

You may edit the following container-properties if you wish to change some parts of the webservice-behaviour:

6. Experimental plugins

Four plugins ship with every release, as serverpackcreator-plugin-<name>-<version>_experimental.jar. The _experimental is in the filename on purpose: these are newer and far less travelled than the application they plug into, and you should be able to tell that from the download alone.

What that means: they are not guaranteed to work. Settings keys may move between releases — a plugin’s config file is only written if it does not already exist, so a renamed key orphans your settings rather than migrating them — and a bug in one does not hold up a release. They are opt-in; ServerPackCreator installs none of them for you and behaves exactly as documented everywhere else in this README without them.

They can leave experimental one day, and testing is what gets them there. So far they have been exercised by their author, on their author’s machines, against their author’s modpacks. If you run one, you are testing it — tell me what broke or confused you, see 2. Issues and help.

Installing one: download the *_experimental.jar from a release, drop it into the plugins-directory of your ServerPackCreator home-directory, restart. Settings land in plugins/config/<plugin-id>.toml. To switch one off without deleting it, add its ID on its own line in plugins/disabled.txt — see HELP.md.

6.1 Grinder

The grinder boot-verifies mods at scale and publishes which ones are genuinely clientside-only. This plugin puts that feed in front of you and lets you pick: tick a row and the entry joins the clientside-mod exclusion list of every server pack you generate — GUI, CLI and webservice alike, no restart. Each row shows the verdict and the two readings behind it, what the platform declared and what the jar itself says, which is what makes a disagreement worth checking by hand. Confirmed findings and everything else are kept in separate lists, because excluding a mod that was never proven clientside-only breaks client/server compatibility. A dashboard shows what the daemon is doing right now.

Rough edges: it needs a reachable grinder, or it sits idle and does nothing. It is a read-only view — a verdict you disagree with is yours to un-tick, not to correct. Suggested entries match by prefix, so an unusually-named jar can slip past the pattern proposed for it.

6.2 Server Test

Lists every pack in your server-packs directory and launches the selected one through the pack’s own start script — not a hand-built java command, so the scripts get tested too. The server’s console appears in the window with a line into its standard input: type I agree to get past Mojang’s EULA, stop later to shut it down. Each server gets its own bind-tested port, so two can run at once, and server.properties is borrowed for the duration and restored byte-for-byte afterwards.

Rough edges: it deliberately will not accept the EULA for you. A pack missing its chosen start script is refused by name, never quietly substituted. A script this host has no interpreter for is still offered — it fails with the interpreter’s own error, which beats a disabled control explaining nothing.

6.3 Self-Extract

The only one with no interface at all. It wraps every generated server pack in two self-extracting artifacts, written beside it:

server-packs/
├── Survive_Create_Prosper_4_custom/
├── Survive_Create_Prosper_4_custom.bsx    <- self-extracting, Linux / macOS
├── Survive_Create_Prosper_4_custom.cmd    <- self-extracting, Windows 10 1803+
└── Survive_Create_Prosper_4_custom_server_pack.zip

Each carries the whole pack inside it — run it and it unpacks itself and starts the server, no unzip step and nothing else to download. It is HELP.md’s Fun Stuff → Self-extracting, self-contained script, executed automatically. There is nothing to configure on purpose: installing the plugin is the setting.

Rough edges: each artifact is as big as the pack, so a generation that produced a 6 GB server pack now writes about 18 GB. The Windows .cmd is the less travelled of the two.

6.4 Example

Documentation-by-example: one of every extension point ServerPackCreator offers, kept in step with the current plugin API on purpose. If you want to write your own plugin, copy from this one — the source is at Example Plugin, and HELP.md’s Plugins chapter covers the plugin API itself.

The screenshot shows two of its extension points at once: a tab — a playable Tetris, because a tab has to display something — and a global config panel whose values are saved and handed back on the next start. It also contributes a configuration check and pre-, post- and generic generation listeners, each small enough to read in one sitting.

7. API

ServerPackCreator’s API is available on maven for use in your own projects: https://central.sonatype.com/artifact/de.griefed.serverpackcreator/serverpackcreator-api

Note: The API does not include the REST-API of the webservice in the app. It is explicitly not part of the ServerPackCreator API.

Implementation

Replace $VERSION with the version you want to use.

Maven

<dependency>
    <groupId>de.griefed.serverpackcreator</groupId>
    <artifactId>serverpackcreator-api</artifactId>
    <version>$VERSION</version>
</dependency>

Gradle

implementation 'de.griefed.serverpackcreator:serverpackcreator-api:$VERSION'

Gradle Kotlin

implementation("de.griefed.serverpackcreator:serverpackcreator-api:$VERSION")

Example

Initialize the API with your properties file, containing some basic settings for the API to use. /path/to/file.properties represents the path to your properties-file.

Make sure to select a directory which doesn’t contain any vital data for the API, as the API will setup and create any and all required files in said directory. Best to give it its own directory all to itself.

For information about possible settings, see https://serverpackcreator.de/help/latest/settings-and-configs.html#serverpackcreator-properties

val spcAPI = ApiWrapper.api(File("/path/to/file.properties"))

After initializing the API you can now access the ConfigurationHandler as well as the ServerPackHandler, among other things. Here’s a very basic example:

val packConfig = PackConfig()
val configCheck = spcAPI.configurationHandler.checkConfiguration(File("/path/to/serverpack-config.conf"), packConfig)

if (configCheck.allChecksPassed) {
    val serverPackGeneration = spcAPI.serverPackHandler.run(packConfig)

    if (serverPackGeneration.success) {
        println("Path to your server pack: ${serverPackGeneration.serverPack.absolutePath}")

        if (serverPackGeneration.serverPackZip.isPresent) {
            println("Path to your server pack ZIP: ${serverPackGeneration.serverPackZip.get().absolutePath}")
        }
        
    } else {
        
        println("Encountered the following errors during generation:")
        for (error in serverPackGeneration.errors) {
            println(error)
        }
        
    }
    
} else {
    
    println("There are errors in your server pack config:")
    for (error in configCheck.encounteredErrors) {
        println(error)
    }
    
}

8. Awesomesauce!

None of this would have been possible without the excellent IDEs by JetBrains. They have kindly provided this open source project with an All Products Pack license. Additionally, ej-Technologies has provided an open-source license for JProfiler and install4j for ServerPackCreator, which allows me to resolve performance bottlenecks, pin down memory leaks and understand threading issues, as well as generated fancy high-end installers. Huge shoutout and thank you!

Powered by

IntelliJ IDEA	WebStorm

Powered by

JProfiler	install4j

Starting from version 6.x, ServerPackCreator will sport fancy new installers made possible by ej-technologies’ install4j.

✨ Thanks to all of my Supporters and Sponsors ✨

Sponsors

Contributors

Griefed	dependabot[bot]	whitebear60	LunarDev-git	dependabot-preview[bot]
Alistair1231	arthurbarret0	Antoniofo

README 内容过长，已截取前 64 KB。完整内容请前往 GitHub 仓库查看。