de.griefed.serverpackcreator

Class ServerPackHandler

java.lang.Object

de.griefed.serverpackcreator.ServerPackHandler

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

Create a server pack from a modpack by copying all specified or required files from the modpack to the server pack as well as installing the modloader server for the specified modloader, modloader version and Minecraft version. Create a ZIP-archive of the server pack, excluding the Minecraft server JAR, for immediate upload to CurseForge or other platforms.

Constructor Summary

Constructors

Constructor and Description
ServerPackHandler(ApplicationProperties injectedApplicationProperties, VersionMeta injectedVersionMeta, Utilities injectedUtilities, ApplicationPlugins injectedApplicationPlugins, ModScanner injectedModScanner) Constructor

Method Summary

Modifier and Type	Method and Description
java.lang.String	getServerPackDestination(ConfigurationModel configurationModel) Acquire the destination directory in which the server pack will be generated.
boolean	run(@NotNull ConfigurationModel configurationModel) Create a server pack from a given instance of ConfigurationModel.
ServerPackModel	run(@NotNull ServerPackModel serverPackModel) Create a server pack from a given instance of ServerPackModel via webUI.
void	zipBuilder(java.lang.String minecraftVersion, boolean includeServerInstallation, java.lang.String destination, java.lang.String modloader, java.lang.String modloaderVersion) Creates a ZIP-archive of the server pack previously generated.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerPackHandler

@Autowired
public ServerPackHandler(ApplicationProperties injectedApplicationProperties,
                                    VersionMeta injectedVersionMeta,
                                    Utilities injectedUtilities,
                                    ApplicationPlugins injectedApplicationPlugins,
                                    ModScanner injectedModScanner)
                             throws java.io.IOException

Constructor

Used for Dependency Injection.

Receives an instance of I18n or creates one if the received one is null. Required for use of localization.

Parameters:

injectedApplicationProperties - Instance of Properties required for various different things.

injectedVersionMeta - Instance of VersionMeta required for everything version related.

injectedUtilities - Instance of Utilities.

injectedApplicationPlugins - Instance of ApplicationPlugins.

injectedModScanner - Instance of ModScanner required to determine sideness of mods.

Throws:

java.io.IOException - if the VersionMeta could not be instantiated.

Method Detail

run

public ServerPackModel run(@NotNull
                           @NotNull ServerPackModel serverPackModel)

Create a server pack from a given instance of ServerPackModel via webUI.

Parameters:

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

Returns:

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

getServerPackDestination

public java.lang.String getServerPackDestination(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....

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:

Boolean. Returns true if the server pack was successfully generated.

zipBuilder

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

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:

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.