de.griefed.serverpackcreator

Class ServerPackHandler

java.lang.Object

de.griefed.serverpackcreator.ServerPackHandler

@Component
public final class ServerPackHandler
extends java.lang.Object

Everything revolving around creating a server pack. The intended workflow is to create a ConfigurationModel and run it through any of the available ConfigurationHandler.checkConfiguration(ConfigurationModel, boolean)-variants, and then call run(ConfigurationModel) with the previously checked configuration model. You may run with an unchecked configuration model, but no guarantees or promises, yes not even support, is given for running a model without checking it first.
This class also gives you access to the methods which are responsible for creating the server pack, in case you want to do things manually.
The methods in question are:

• cleanupEnvironment(boolean, ConfigurationModel) and cleanupEnvironment(boolean, String)
• ApplicationAddons.runPreZipExtensions(ConfigurationModel, String)
• copyFiles(ConfigurationModel) and copyFiles(String, List, List, String, String, String)
• provideImprovedFabricServerLauncher(ConfigurationModel) and provideImprovedFabricServerLauncher(String, String, String) if Fabric is the chosen Modloader
• copyIcon(ConfigurationModel) and copyIcon(String, String)
• copyProperties(ConfigurationModel) and copyProperties(String, String)
• ApplicationAddons.runPreZipExtensions(ConfigurationModel, String)
• zipBuilder(ConfigurationModel) and zipBuilder(String, boolean, String, String, String)
• createStartScripts(ConfigurationModel, boolean) and createStartScripts(HashMap, String, boolean)
• installServer(ConfigurationModel) and installServer(String, String, String, String)
• ApplicationAddons.runPostGenExtensions(ConfigurationModel, String)

If you want to execute extensions, see ApplicationAddons.runPreGenExtensions(ConfigurationModel, String)}, ApplicationAddons.runPreZipExtensions(ConfigurationModel, String)} and ApplicationAddons.runPostGenExtensions(ConfigurationModel, String).

Constructor Summary

Constructors

Constructor and Description
ServerPackHandler(@NotNull ApplicationProperties injectedApplicationProperties, @NotNull VersionMeta injectedVersionMeta, @NotNull Utilities injectedUtilities, @NotNull ApplicationAddons injectedApplicationAddons, @NotNull ModScanner injectedModScanner) Create a new instance to create server packs.

Method Summary

Modifier and Type	Method and Description
void	cleanupEnvironment(boolean deleteZip, @NotNull ConfigurationModel configurationModel) Deletes all files, directories and ZIP-archives of previously generated server packs to ensure newly generated server pack is as clean as possible.
void	cleanupEnvironment(boolean deleteZip, @NotNull java.lang.String destination) Deletes all files, directories and ZIP-archives of previously generated server packs to ensure newly generated server pack is as clean as possible.
void	copyFiles(@NotNull ConfigurationModel configurationModel) Copies all specified directories and mods, excluding clientside-only mods, from the modpack directory into the server pack directory.
void	copyFiles(@NotNull java.lang.String modpackDir, @NotNull java.util.List<java.lang.String> directoriesToCopy, @NotNull java.util.List<java.lang.String> clientMods, @NotNull java.lang.String minecraftVersion, @NotNull java.lang.String destination, @NotNull java.lang.String modloader) Copies all specified directories and mods, excluding clientside-only mods, from the modpack directory into the server pack directory.
void	copyIcon(@NotNull ConfigurationModel configurationModel) Copies the server-icon.png into server pack.
void	copyIcon(@NotNull java.lang.String destination, @NotNull java.lang.String pathToServerIcon) Copies the server-icon.png into server pack.
void	copyProperties(@NotNull ConfigurationModel configurationModel) Copies the server.properties into server pack.
void	copyProperties(@NotNull java.lang.String destination, @NotNull java.lang.String pathToServerProperties) Copies the server.properties into server pack.
void	createStartScripts(@NotNull ConfigurationModel configurationModel, boolean isLocal) Create start-scripts for the generated server pack using the templates the user has defined for their instance of ServerPackCreator in ApplicationProperties.scriptTemplates().
void	createStartScripts(@NotNull java.util.HashMap<java.lang.String,java.lang.String> scriptSettings, @NotNull java.lang.String destination, boolean isLocal) Create start-scripts for the generated server pack using the templates the user has defined for their instance of ServerPackCreator in ApplicationProperties.scriptTemplates().
@NotNull java.util.List<java.io.File>	getModsToInclude(@NotNull ConfigurationModel configurationModel) Generates a list of all mods to include in the server pack.
@NotNull java.util.List<java.io.File>	getModsToInclude(@NotNull java.lang.String modsDir, @NotNull java.util.List<java.lang.String> userSpecifiedClientMods, @NotNull java.lang.String minecraftVersion, @NotNull java.lang.String modloader) Generates a list of all mods to include in the server pack.
@NotNull java.lang.String	getServerPackDestination(@NotNull ConfigurationModel configurationModel) Acquire the destination directory in which the server pack will be generated.
void	installServer(@NotNull ConfigurationModel configurationModel) Installs the modloader server for the specified modloader, modloader version and Minecraft version.
void	installServer(@NotNull java.lang.String modLoader, @NotNull java.lang.String minecraftVersion, @NotNull java.lang.String modLoaderVersion, @NotNull java.lang.String destination) Installs the modloader server for the specified modloader, modloader version and Minecraft version.
void	provideImprovedFabricServerLauncher(@NotNull ConfigurationModel configurationModel) Download and provide the improved Fabric Server Launcher, if it is available for the given Minecraft and Fabric version.
void	provideImprovedFabricServerLauncher(@NotNull java.lang.String minecraftVersion, @NotNull java.lang.String fabricVersion, @NotNull java.lang.String destination) Download and provide the improved Fabric Server Launcher, if it is available for the given Minecraft and Fabric version.
boolean	run(@NotNull ConfigurationModel configurationModel) Create a server pack from a given instance of ConfigurationModel.
@NotNull ServerPackModel	run(@NotNull ServerPackModel serverPackModel) Create a server pack from a given instance of ServerPackModel when running as a webservice.
boolean	serverDownloadable(@NotNull java.lang.String mcVersion, @NotNull java.lang.String modloader, @NotNull java.lang.String modloaderVersion) Check whether the installer for the given combination of Minecraft version, modloader and modloader version is available/reachable.
void	zipBuilder(@NotNull ConfigurationModel configurationModel) Creates a ZIP-archive of the server pack previously generated.
void	zipBuilder(@NotNull java.lang.String minecraftVersion, boolean includeServerInstallation, @NotNull java.lang.String destination, @NotNull java.lang.String modloader, @NotNull java.lang.String modloaderVersion) Creates a ZIP-archive of specified directory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServerPackHandler

@Autowired
public ServerPackHandler(@NotNull
                                    @NotNull ApplicationProperties injectedApplicationProperties,
                                    @NotNull
                                    @NotNull VersionMeta injectedVersionMeta,
                                    @NotNull
                                    @NotNull Utilities injectedUtilities,
                                    @NotNull
                                    @NotNull ApplicationAddons injectedApplicationAddons,
                                    @NotNull
                                    @NotNull ModScanner injectedModScanner)

Create a new instance to create server packs.

Parameters:

injectedApplicationProperties - Base settings of ServerPackCreator needed for server pack generation, such as access to the directories, script templates and so on.

injectedVersionMeta - Meta for modloader and version specific checks and information gathering, such as modloader installer downloads.

injectedUtilities - Common utilities used across ServerPackCreator.

injectedApplicationAddons - Any addons which a user may want to execute during the generation of a server pack.

injectedModScanner - In case a user enabled automatic sideness detection, this will exclude clientside-only mods from a server pack.

Method Detail

run

@NotNull
public @NotNull ServerPackModel run(@NotNull
                                             @NotNull ServerPackModel serverPackModel)

Create a server pack from a given instance of ServerPackModel when running as a webservice.

Parameters:

serverPackModel - An instance of ServerPackModel which contains the configuration of the modpack.

Returns:

The passed ServerPackModel which got altered during the creation of said server pack.

getServerPackDestination

@NotNull
public @NotNull java.lang.String getServerPackDestination(@NotNull
                                                                   @NotNull ConfigurationModel configurationModel)

Acquire the destination directory in which the server pack will be generated. The directory in which the server pack will be created has all its spaces replaces with underscores, so Survive Create Prosper 4 - 5.0.1 would become Survive_Create_Prosper_4_-_5.0.1 Even though it is the year 2022, spaces in paths can and do still cause trouble. Such as for Powershell scripts. Powershell throws a complete fit if the path contains spaces....soooooo, we remove them. Better safe than sorry.

Parameters:

configurationModel - Model containing the modpack directory of the modpack from which the server pack will be generated.

Returns:

The complete path to the directory in which the server pack will be generated.

run

public boolean run(@NotNull
                   @NotNull ConfigurationModel configurationModel)

Create a server pack from a given instance of ConfigurationModel.

Parameters:

configurationModel - An instance of ConfigurationModel which contains the configuration of the modpack from which the server pack is to be created.

Returns:

true if the server pack was successfully generated.

cleanupEnvironment

public void cleanupEnvironment(boolean deleteZip,
                               @NotNull
                               @NotNull java.lang.String destination)

Deletes all files, directories and ZIP-archives of previously generated server packs to ensure newly generated server pack is as clean as possible. This will completely empty the server pack directory, so use with caution!

Parameters:

deleteZip - Whether to delete the server pack ZIP-archive.

destination - The destination at which to clean up in.

copyFiles

public void copyFiles(@NotNull
                      @NotNull ConfigurationModel configurationModel)

Copies all specified directories and mods, excluding clientside-only mods, from the modpack directory into the server pack directory. If a source/file;destination/file -combination is provided, the specified source-file is copied to the specified destination-file. One of the reasons as to why it is recommended to run a given ConfigurationModel through the ConfigurationHandler first, is because the ConfigurationHandler will resolve links to their actual files first before then correcting the given ConfigurationModel.

Parameters:

configurationModel - ConfigurationModel containing the modpack directory, list of directories and files to copy, list of clientside-only mods to exclude, the Minecraft version used by the modpack and server pack, and the modloader used by the modpack and server pack.

provideImprovedFabricServerLauncher

public void provideImprovedFabricServerLauncher(@NotNull
                                                @NotNull ConfigurationModel configurationModel)

Download and provide the improved Fabric Server Launcher, if it is available for the given Minecraft and Fabric version.

Parameters:

configurationModel - ConfigurationModel containing the Minecraft and Fabric version for which to acquire the improved Fabric Server Launcher.

copyIcon

public void copyIcon(@NotNull
                     @NotNull ConfigurationModel configurationModel)

Copies the server-icon.png into server pack. The sever-icon is automatically scaled to a resolution of 64x64 pixels.

Parameters:

configurationModel - Containing the modpack directory to acquire the destination of the server pack and the path to the server icon to copy.

copyProperties

public void copyProperties(@NotNull
                           @NotNull ConfigurationModel configurationModel)

Copies the server.properties into server pack.

Parameters:

configurationModel - Containing the modpack directory to acquire the destination of the server pack and the path to the server properties to copy.

createStartScripts

public void createStartScripts(@NotNull
                               @NotNull ConfigurationModel configurationModel,
                               boolean isLocal)

Create start-scripts for the generated server pack using the templates the user has defined for their instance of ServerPackCreator in ApplicationProperties.scriptTemplates().

Parameters:

configurationModel - Configuration model containing modpack specific values. keys to be replaced with their respective values in the start scripts, as well as the modpack directory from which the destination of the server pack is acquired.

isLocal - Whether the start scripts should be created for a locally usable server pack. Use false if the start scripts should be created for a server pack about to be zipped.

zipBuilder

public void zipBuilder(@NotNull
                       @NotNull ConfigurationModel configurationModel)

Creates a ZIP-archive of the server pack previously generated. Depending on ApplicationProperties.isZipFileExclusionEnabled(), files will be excluded. To customize the files which will be excluded, see ApplicationProperties.getFilesToExcludeFromZipArchive()

Parameters:

configurationModel - Contains the Minecraft version used by the modpack and server pack, whether the modloader server was installed, the modpack directory to acquire the destination of the server pack, the modloader used by the modpack and server pack and the modloader version.

installServer

public void installServer(@NotNull
                          @NotNull ConfigurationModel configurationModel)

Installs the modloader server for the specified modloader, modloader version and Minecraft version.

Parameters:

configurationModel - Contains the used modloader, Minecraft version, modloader version, path to the java executable/binary and modpack directory in order to acquire the destination at which to install the server.

copyFiles

public void copyFiles(@NotNull
                      @NotNull java.lang.String modpackDir,
                      @NotNull
                      @NotNull java.util.List<java.lang.String> directoriesToCopy,
                      @NotNull
                      @NotNull java.util.List<java.lang.String> clientMods,
                      @NotNull
                      @NotNull java.lang.String minecraftVersion,
                      @NotNull
                      @NotNull java.lang.String destination,
                      @NotNull
                      @NotNull java.lang.String modloader)

Copies all specified directories and mods, excluding clientside-only mods, from the modpack directory into the server pack directory. If a source/file;destination/file -combination is provided, the specified source-file is copied to the specified destination-file. One of the reasons as to why it is recommended to run a given ConfigurationModel through the ConfigurationHandler first, is because the ConfigurationHandler will resolve links to their actual files first before then correcting the given ConfigurationModel.

Parameters:

modpackDir - Files and directories are copied into the server_pack directory inside the modpack directory.

directoriesToCopy - All directories and files therein to copy to the server pack.

clientMods - List of clientside-only mods to exclude from the server pack.

minecraftVersion - The Minecraft version the modpack uses.

destination - The destination where the files should be copied to.

modloader - The modloader used for mod sideness detection.

provideImprovedFabricServerLauncher

public void provideImprovedFabricServerLauncher(@NotNull
                                                @NotNull java.lang.String minecraftVersion,
                                                @NotNull
                                                @NotNull java.lang.String fabricVersion,
                                                @NotNull
                                                @NotNull java.lang.String destination)

Download and provide the improved Fabric Server Launcher, if it is available for the given Minecraft and Fabric version.

Parameters:

minecraftVersion - The Minecraft version the modpack uses and the Fabric Server Launcher should be downloaded for.

fabricVersion - The modloader version the modpack uses and the Fabric Server Launcher should be downloaded for.

destination - The destination of the server pack.

copyIcon

public void copyIcon(@NotNull
                     @NotNull java.lang.String destination,
                     @NotNull
                     @NotNull java.lang.String pathToServerIcon)

Copies the server-icon.png into server pack. The sever-icon is automatically scaled to a resolution of 64x64 pixels.

Parameters:

destination - The destination where the icon should be copied to.

pathToServerIcon - The path to the custom server-icon.

copyProperties

public void copyProperties(@NotNull
                           @NotNull java.lang.String destination,
                           @NotNull
                           @NotNull java.lang.String pathToServerProperties)

Copies the server.properties into server pack.

Parameters:

destination - The destination where the properties should be copied to.

pathToServerProperties - The path to the custom server.properties.

createStartScripts

public void createStartScripts(@NotNull
                               @NotNull java.util.HashMap<java.lang.String,java.lang.String> scriptSettings,
                               @NotNull
                               @NotNull java.lang.String destination,
                               boolean isLocal)

Create start-scripts for the generated server pack using the templates the user has defined for their instance of ServerPackCreator in ApplicationProperties.scriptTemplates().

Parameters:

scriptSettings - Key-value pairs to replace in the script. A given key in the script is replaced with its value.

destination - The destination where the scripts should be created in.

isLocal - Whether the start scripts should be created for a locally usable server pack. Use false if the start scripts should be created for a server pack about to be zipped.

zipBuilder

public void zipBuilder(@NotNull
                       @NotNull java.lang.String minecraftVersion,
                       boolean includeServerInstallation,
                       @NotNull
                       @NotNull java.lang.String destination,
                       @NotNull
                       @NotNull java.lang.String modloader,
                       @NotNull
                       @NotNull java.lang.String modloaderVersion)

Creates a ZIP-archive of specified directory. Depending on ApplicationProperties.isZipFileExclusionEnabled(), files will be excluded. To customize the files which will be excluded, see ApplicationProperties.getFilesToExcludeFromZipArchive(). The created ZIP-archive will be stored alongside the specified destination, with _server_pack.zip appended to its name.

Parameters:

minecraftVersion - Determines the name of the Minecraft server JAR to exclude from the ZIP-archive if the modloader is Forge.

includeServerInstallation - Determines whether the Minecraft server JAR info should be printed.

destination - The destination where the ZIP-archive should be created in.

modloader - The modloader the modpack and server pack use.

modloaderVersion - The modloader version the modpack and server pack use.

installServer

public void installServer(@NotNull
                          @NotNull java.lang.String modLoader,
                          @NotNull
                          @NotNull java.lang.String minecraftVersion,
                          @NotNull
                          @NotNull java.lang.String modLoaderVersion,
                          @NotNull
                          @NotNull java.lang.String destination)

Installs the modloader server for the specified modloader, modloader version and Minecraft version.

Parameters:

modLoader - The modloader for which to install the server software. Either Forge or Fabric.

minecraftVersion - The Minecraft version for which to install the modloader and Minecraft server.

modLoaderVersion - The modloader version for which to install the modloader and Minecraft server.

destination - The destination where the modloader server should be installed into.

getModsToInclude

@NotNull
public @NotNull java.util.List<java.io.File> getModsToInclude(@NotNull
                                                                       @NotNull java.lang.String modsDir,
                                                                       @NotNull
                                                                       @NotNull java.util.List<java.lang.String> userSpecifiedClientMods,
                                                                       @NotNull
                                                                       @NotNull java.lang.String minecraftVersion,
                                                                       @NotNull
                                                                       @NotNull java.lang.String modloader)

Generates a list of all mods to include in the server pack. If the user specified clientside-mods to exclude, and/or if the automatic exclusion of clientside-only mods is active, they will be excluded, too.

Parameters:

modsDir - String. The mods-directory of the modpack of which to generate a list of all its contents.

userSpecifiedClientMods - List String. A list of all clientside-only mods.

minecraftVersion - String. The Minecraft version the modpack uses. When the modloader is Forge, this determines whether Annotations or Tomls are scanned.

modloader - String The modloader the modpack uses.

Returns:

A list of all mods to include in the server pack.

serverDownloadable

public boolean serverDownloadable(@NotNull
                                  @NotNull java.lang.String mcVersion,
                                  @NotNull
                                  @NotNull java.lang.String modloader,
                                  @NotNull
                                  @NotNull java.lang.String modloaderVersion)

Check whether the installer for the given combination of Minecraft version, modloader and modloader version is available/reachable.

Parameters:

mcVersion - The Minecraft version.

modloader - The modloader.

modloaderVersion - The modloader version.

Returns:

true if the installer can be downloaded.

cleanupEnvironment

public void cleanupEnvironment(boolean deleteZip,
                               @NotNull
                               @NotNull ConfigurationModel configurationModel)

Deletes all files, directories and ZIP-archives of previously generated server packs to ensure newly generated server pack is as clean as possible. This will completely empty the server pack directory, so use with caution!

Parameters:

deleteZip - Whether to delete the server pack ZIP-archive.

configurationModel - ConfigurationModel containing the modpack directory from which the destination of the server pack is acquired.

getModsToInclude

@NotNull
public @NotNull java.util.List<java.io.File> getModsToInclude(@NotNull
                                                                       @NotNull ConfigurationModel configurationModel)

Generates a list of all mods to include in the server pack. If the user specified clientside-mods to exclude, and/or if the automatic exclusion of clientside-only mods is active, they will be excluded, too.

Parameters:

configurationModel - The configurationModel containing the modpack directory, list of clientside-only mods to exclude, Minecraft version used by the modpack and server pack and the modloader used by the modpack and server pack.

Returns:

A list of all mods to include in the server pack.