de.griefed.serverpackcreator

Class ApplicationProperties

java.lang.Object

de.griefed.serverpackcreator.ApplicationProperties

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

Base settings of ServerPackCreator, such as working directories, default list of clientside-only mods, default list of directories to include in a server pack, script templates, java paths and much more.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ApplicationProperties.ExclusionFilter

Constructor Summary

Constructors

Constructor and Description
ApplicationProperties(@NotNull java.io.File propertiesFile, @NotNull FileUtilities fileUtilities, @NotNull SystemUtilities systemUtilities, @NotNull ListUtilities listUtilities, @NotNull JarUtilities jarUtilities) Initialize an instance of our application properties using a custom properties-file.
ApplicationProperties(@NotNull FileUtilities fileUtilities, @NotNull SystemUtilities systemUtilities, @NotNull ListUtilities listUtilities, @NotNull JarUtilities jarUtilities) Initialize an instance of our application properties using the default serverpackcreator.properties.

Method Summary

Modifier and Type	Method and Description
@NotNull java.io.File	addonConfigsDirectory() Directory in which addon-specific configurations are stored in.
@NotNull java.io.File	addonsDirectory() Directory in which addons for ServerPackCreator are to be placed in.
boolean	checkForAvailablePreReleases() Getter for whether the search for available PreReleases is enabled or disabled. Depending on de.griefed.serverpackcreator.versioncheck.prerelease, returns true if checks for available PreReleases are enabled, false if no checks for available PreReleases should be made.
@NotNull java.io.File	defaultConfig() Default configuration-file for a server pack generation inside ServerPackCreators home-directory.
@NotNull java.io.File	defaultPowershellTemplate() The default PowerShell-template for the modded server start scripts.
@NotNull java.io.File	defaultServerIcon() Default server-icon.png-file used by Minecraft servers.
@NotNull java.io.File	defaultServerProperties() Default server.properties-file used by Minecraft servers.
@NotNull java.io.File	defaultShellTemplate() The default shell-template for the modded server start scripts.
boolean	enableMinecraftPreReleases() Whether Minecraft pre-releases and snapshots are available to the user in, for example, the GUI.
@NotNull ApplicationProperties.ExclusionFilter	exclusionFilter() The filter method with which to determine whether a user-specified clientside-only mod should be excluded from the server pack.
@NotNull java.io.File	fabricInstallerManifest() Fabric installer manifest containing information about available Fabric installers with which to install a server.
@NotNull java.io.File	fabricIntermediariesManifest() The Fabric intermediaries manifest containing all required information about Fabrics intermediaries.
@NotNull java.io.File	fabricVersionManifest() Fabric version manifest containing information about available Fabric loader versions.
@NotNull java.io.File	forgeVersionManifest() Forge version manifest containing information about available Forge loader versions.
@NotNull java.lang.String	getAikarsFlags() Get this configurations AikarsFlags
@NotNull java.util.List<java.lang.String>	getDirectoriesToExclude() Getter for the list of directories to exclude from server packs.
@NotNull java.util.List<java.lang.String>	getDirectoriesToInclude() Getter for the default list of directories to include in a server pack.
@NotNull java.util.List<java.lang.String>	getFilesToExcludeFromZipArchive() List of files to be excluded from ZIP-archives.
@NotNull java.lang.String	getHasteBinServerUrl() Acquire this instances HasteBin server documents endpoint URL.
@NotNull java.io.File	getJarFile() The .exe or JAR-file of ServerPackCreator.
@NotNull java.io.File	getJarFolder() The folder containing the ServerPackCreator.exe or JAR-file.
@NotNull java.lang.String	getJarName() The name of the .exe or JAR-file.
@NotNull java.lang.String	getJavaVersion() The Java version used to run ServerPackCreator.
@NotNull java.lang.String	getLanguage() Get the currently set language.
@NotNull java.util.List<java.lang.String>	getListFallbackMods() Acquire the default fallback list of clientside-only mods.
@NotNull java.lang.String	getOSArch() Architecture of the operating system on which ServerPackCreator is running on.
@NotNull java.lang.String	getOSName() The name of the operating system on which ServerPackCreator is running on.
@NotNull java.lang.String	getOSVersion() The version of the OS on which ServerPackCreator is running on.
int	getQueueMaxDiskUsage() Getter for the maximum disk usage at which JMS/Artemis will stop storing queues on disk.
boolean	getSaveLoadedConfiguration() Getter for whether the last loaded configuration file should be saved to as well.
@NotNull java.io.File	homeDirectory() ServerPackCreators home directory, in which all important files and folders are stored in.
boolean	isAutoExcludingModsEnabled() Is auto excluding of clientside-only mods enabled.
boolean	isDarkTheme() Is the Dark Theme currently active?
boolean	isExe() Whether a .exe or JAR-file was used for running ServerPackCreator.
boolean	isJavaScriptAutoupdateEnabled() Whether to automatically update the SPC_JAVA_SPC-placeholder in the script variables table with a Java path matching the required Java version for the Minecraft server.
boolean	isServerPackCleanupEnabled() Whether cleanup procedures after server pack generation are enabled.
boolean	isServerPacksOverwriteEnabled() Whether overwriting of already existing server packs is enabled.
boolean	isZipFileExclusionEnabled() Whether the exclusion of files from the ZIP-archive of the server pack is enabled.
java.lang.String	java() Getter for the path to the Java executable/binary.
boolean	javaAvailable() Whether a viable path to a Java executable or binary has been configured for ServerPackCreator.
@NotNull java.util.Optional<java.lang.String>	javaPath(int javaVersion) Get the path to the specified Java executable/binary, wrapped in an Optional for your convenience.
@NotNull java.io.File	langDirectory() Directory in which the language-properties for internationalization are stored in.
@NotNull java.io.File	legacyFabricGameManifest() The LegacyFabric game version manifest containing information about which Minecraft version LegacyFabric is available for.
@NotNull java.io.File	legacyFabricInstallerManifest() LegacyFabric installer manifest containing information about available LegacyFabric installers with which to install a server.
@NotNull java.io.File	legacyFabricLoaderManifest() LegacyFabric loader manifest containing information about Fabric loader maven versions.
void	loadProperties() Reload serverpackcreator.properties.
@NotNull java.io.File	logsDirectory() Storage location for logs created by ServerPackCreator.
@NotNull java.io.File	manifestsDirectory() Directory to which default/fallback manifests are copied to during the startup of ServerPackCreator.
@NotNull java.io.File	minecraftServerManifestsDirectory() Directory to which Minecraft server manifests are copied during the startup of ServerPackCreator.
@NotNull java.io.File	minecraftVersionManifest() Minecraft version manifest containing information about available Minecraft versions.
@NotNull java.io.File	modpacksDirectory() Modpacks directory in which uploaded modpack ZIP-archives and extracted modpacks are stored.
@NotNull java.io.File	quiltInstallerManifest() Quilt installer manifest containing information about available Quilt installers with which to install a server.
@NotNull java.io.File	quiltVersionManifest() Quilt version manifest containing information about available Quilt loader versions.
void	saveToDisk(@NotNull java.io.File propertiesFile) Store the ApplicationProperties to disk, overwriting the existing one.
@NotNull java.util.List<java.io.File>	scriptTemplates() Configured list of script templates.
@NotNull java.io.File	serverFilesDirectory() Directory in which default server-files are stored in.
@NotNull java.io.File	serverPackCreatorDatabase() ServerPackCreator-database when running as a webservice.
@NotNull java.io.File	serverPackCreatorPropertiesFile() The serverpackcreator.properties-file which both resulted from starting ServerPackCreator and provided the settings, properties and configurations for the currently running instance.
@NotNull java.lang.String	serverPackCreatorVersion() Getter for the version of ServerPackCreator. If a JAR-file compiled from a release-job from a CI/CD-pipeline is used, it should contain a VERSION.txt-file which contains the version of said release.
@NotNull java.io.File	serverPacksDirectory() Directory in which generated server packs, or server packs being generated, are stored in, as well as their ZIP-archives, if created.
void	setJavaPath(@NotNull java.lang.String javaPath) Setter for the path to the Java executable/binary.
void	setLanguage(@NotNull java.lang.String locale) Overwrite the language used so the next run of ServerPackCreator uses that language setting.
void	setTheme(boolean dark) Set the current theme to Dark Theme or Light Theme.
@NotNull java.lang.String[]	supportedModloaders() Modloaders supported by ServerPackCreator.
@NotNull java.io.File	tempDirectory() Temp-directory storing files and folders required temporarily during the run of a server pack generation or other operations.
boolean	updateFallback() Update the fallback clientside-only modlist of our serverpackcreator.properties from the main-repository or one of its mirrors.
@NotNull java.io.File	workDirectory() Work-directory for storing temporary, non-critical, files and directories.

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationProperties

@Autowired
public ApplicationProperties(@NotNull
                                        @NotNull FileUtilities fileUtilities,
                                        @NotNull
                                        @NotNull SystemUtilities systemUtilities,
                                        @NotNull
                                        @NotNull ListUtilities listUtilities,
                                        @NotNull
                                        @NotNull JarUtilities jarUtilities)

Initialize an instance of our application properties using the default serverpackcreator.properties.

Parameters:

fileUtilities - Instance of FileUtilities for file-operations.

systemUtilities - Instance of SystemUtilities to acquire the Java path automatically.

listUtilities - Used to print the configured fallback modlists in chunks.

jarUtilities - Instance of JarUtilities used to acquire .exe or JAR-, as well as system information.

ApplicationProperties

public ApplicationProperties(@NotNull
                             @NotNull java.io.File propertiesFile,
                             @NotNull
                             @NotNull FileUtilities fileUtilities,
                             @NotNull
                             @NotNull SystemUtilities systemUtilities,
                             @NotNull
                             @NotNull ListUtilities listUtilities,
                             @NotNull
                             @NotNull JarUtilities jarUtilities)

Initialize an instance of our application properties using a custom properties-file.

Parameters:

propertiesFile - The properties file from which to load the settings and configuration.

fileUtilities - Instance of FileUtilities for file-operations.

systemUtilities - Instance of SystemUtilities to acquire the Java path automatically.

listUtilities - Used to print the configured fallback modlists in chunks.

jarUtilities - Instance of JarUtilities used to acquire .exe or JAR-, as well as system information.

Method Detail

loadProperties

public void loadProperties()

Reload serverpackcreator.properties.

setJavaPath

public void setJavaPath(@NotNull
                        @NotNull java.lang.String javaPath)

Setter for the path to the Java executable/binary. Replaces any occurrences of \ with /. The path to the Java executable or binary MUST NOT be a symbolic link, or link of any kind. It must be a direct path!

Parameters:

javaPath - The new Java path to store.

saveToDisk

public void saveToDisk(@NotNull
                       @NotNull java.io.File propertiesFile)

Store the ApplicationProperties to disk, overwriting the existing one.

Parameters:

propertiesFile - The file to store the properties to.

serverPackCreatorPropertiesFile

@NotNull
public @NotNull java.io.File serverPackCreatorPropertiesFile()

The serverpackcreator.properties-file which both resulted from starting ServerPackCreator and provided the settings, properties and configurations for the currently running instance.

Returns:

serverpackcreator.properties in ServerPackCreators home-directory.

java

public java.lang.String java()

Getter for the path to the Java executable/binary.

Returns:

String. Returns the path to the Java executable/binary.

javaAvailable

public boolean javaAvailable()

Whether a viable path to a Java executable or binary has been configured for ServerPackCreator.

Returns:

true if a viable path has been set.

minecraftServerManifestsDirectory

@NotNull
public @NotNull java.io.File minecraftServerManifestsDirectory()

Directory to which Minecraft server manifests are copied during the startup of ServerPackCreator.

When the VersionMeta is initialized, the manifests copied to this directory will provide ServerPackCreator with the information required to check and create your server packs.

The Minecraft server manifests contain information about the Java version required, the download-URL of the server-JAR and much more.

By default, this is the mcserver-directory inside the manifests-directory inside ServerPackCreators home-directory.

Returns:

manifests/mcserver

manifestsDirectory

@NotNull
public @NotNull java.io.File manifestsDirectory()

Directory to which default/fallback manifests are copied to during the startup of ServerPackCreator.

When the VersionMeta is initialized, the manifests copied to this directory will provide ServerPackCreator with the information required to check and create your server packs.

By default, this is the manifests-directory inside ServerPackCreators home-directory.

Returns:

manifests

fabricIntermediariesManifest

@NotNull
public @NotNull java.io.File fabricIntermediariesManifest()

The Fabric intermediaries manifest containing all required information about Fabrics intermediaries. These intermediaries are used by Quilt, Fabric and LegacyFabric.

By default, the fabric-intermediaries-manifest.json-file resides in the manifests-directory inside ServerPackCreators home-directory.

Returns:

manifests/fabric-intermediaries-manifest.json

legacyFabricGameManifest

@NotNull
public @NotNull java.io.File legacyFabricGameManifest()

The LegacyFabric game version manifest containing information about which Minecraft version LegacyFabric is available for.

By default, the legacy-fabric-game-manifest.json-file resides in the manifests-directory inside ServerPackCreators home-directory.

Returns:

manifests/legacy-fabric-game-manifest.json

legacyFabricLoaderManifest

@NotNull
public @NotNull java.io.File legacyFabricLoaderManifest()

LegacyFabric loader manifest containing information about Fabric loader maven versions.

By default, the legacy-fabric-loader-manifest.json-file resides in the manifests-directory inside ServerPackCreators home-directory.

Returns:

manifests/legacy-fabric-loader-manifest.json

legacyFabricInstallerManifest

@NotNull
public @NotNull java.io.File legacyFabricInstallerManifest()

LegacyFabric installer manifest containing information about available LegacyFabric installers with which to install a server.

By default, the legacy-fabric-installer-manifest.xml-file resides in the manifests-directory inside ServerPackCreators home-directory.

Returns:

manifests/legacy-fabric-installer-manifest.xml

fabricInstallerManifest

@NotNull
public @NotNull java.io.File fabricInstallerManifest()

Fabric installer manifest containing information about available Fabric installers with which to install a server.

By default, the fabric-installer-manifest.xml-file resides in the manifests-directory inside ServerPackCreators home-directory.

Returns:

manifests/fabric-installer-manifest.xml

quiltVersionManifest

@NotNull
public @NotNull java.io.File quiltVersionManifest()

Quilt version manifest containing information about available Quilt loader versions.

By default, the quilt-manifest.xml-file resides in the manifests-directory inside ServerPackCreators home-directory.

Returns:

manifests/quilt-manifest.xml

quiltInstallerManifest

@NotNull
public @NotNull java.io.File quiltInstallerManifest()

Quilt installer manifest containing information about available Quilt installers with which to install a server.

By default, the quilt-installer-manifest.xml-file resides in the manifests-directory inside ServerPackCreators home-directory.

Returns:

manifests/quilt-installer-manifest.xml

forgeVersionManifest

@NotNull
public @NotNull java.io.File forgeVersionManifest()

Forge version manifest containing information about available Forge loader versions.

By default, the forge-manifest.json-file resides in the manifests-directory inside ServerPackCreators home-directory.

Returns:

manifests/forge-manifest.json

fabricVersionManifest

@NotNull
public @NotNull java.io.File fabricVersionManifest()

Fabric version manifest containing information about available Fabric loader versions.

By default, the fabric-manifest.xml-file resides in the manifests-directory inside ServerPackCreators home-directory.

Returns:

manifests/fabric-manifest.xml

minecraftVersionManifest

@NotNull
public @NotNull java.io.File minecraftVersionManifest()

Minecraft version manifest containing information about available Minecraft versions.

By default, the minecraft-manifest.json-file resides in the manifests-directory inside ServerPackCreators home-directory.

Returns:

manifests/minecraft-manifest.json

modpacksDirectory

@NotNull
public @NotNull java.io.File modpacksDirectory()

Modpacks directory in which uploaded modpack ZIP-archives and extracted modpacks are stored.

By default, this is the modpacks-directory inside the temp-directory inside ServerPackCreators home-directory.

Returns:

work/temp/modpacks

tempDirectory

@NotNull
public @NotNull java.io.File tempDirectory()

Temp-directory storing files and folders required temporarily during the run of a server pack generation or other operations.

One example would be when running ServerPackCreator as a webservice and uploading a zipped modpack for the automatic creation of a server pack from said modpack.

Any file and/or directory inside the work-directory is considered safe-to-delete, meaning that it can safely be emptied when ServerPackCreator is not running, without running the risk of corrupting anything. It is not recommended to empty this directory whilst ServerPackCreator is running, as in that case, it may interfere with any currently running operation.

By default, this directory is work/temp inside ServerPackCreators home-directory.

Returns:

work/temp

workDirectory

@NotNull
public @NotNull java.io.File workDirectory()

Work-directory for storing temporary, non-critical, files and directories.

Any file and/or directory inside the work-directory is considered safe-to-delete, meaning that it can safely be emptied when ServerPackCreator is not running, without running the risk of corrupting anything. It is not recommended to empty this directory whilst ServerPackCreator is running, as in that case, it may interfere with any currently running operation.

By default, this is the work-directory inside ServerPackCreators home-directory.

Returns:

work

logsDirectory

@NotNull
public @NotNull java.io.File logsDirectory()

Storage location for logs created by ServerPackCreator. This is the logs-directory inside ServerPackCreators home-directory.

Returns:

logs

defaultShellTemplate

@NotNull
public @NotNull java.io.File defaultShellTemplate()

The default shell-template for the modded server start scripts. The file returned by this method does not represent the script-template in the server_files-directory. If you wish access the configured script templates inside the server_files-directory, use scriptTemplates().

Returns:

The default shell-script template.

defaultPowershellTemplate

@NotNull
public @NotNull java.io.File defaultPowershellTemplate()

The default PowerShell-template for the modded server start scripts. The file returned by this method does not represent the script-template in the server_files-directory. If you wish access the configured script templates inside the server_files-directory, use scriptTemplates().

Returns:

The default PowerShell-script template.

scriptTemplates

@NotNull
public @NotNull java.util.List<java.io.File> scriptTemplates()

Configured list of script templates. Every script template resides inside the server_files-directory.

Returns:

server_files/script templates

defaultConfig

@NotNull
public @NotNull java.io.File defaultConfig()

Default configuration-file for a server pack generation inside ServerPackCreators home-directory.

Returns:

home-directory/serverpackcreator.conf

defaultServerProperties

@NotNull
public @NotNull java.io.File defaultServerProperties()

Default server.properties-file used by Minecraft servers. This file resides in the server_files-directory inside ServerPackCreators home-directory.

Returns:

server_files/server.properties

serverFilesDirectory

@NotNull
public @NotNull java.io.File serverFilesDirectory()

Directory in which default server-files are stored in.

Default server-files are, for example, the server.properties, server-icon.png, default_template.sh and default_template.ps1.

The properties and icon are placeholders and/or templates for the user to change to their liking, should they so desire. The script-templates serve as a one-size-fits-all template for supporting Forge, Fabric, LegacyFabric and Quilt.

By default, this directory is server_files inside ServerPackCreators home-directory.

Returns:

server_files

defaultServerIcon

@NotNull
public @NotNull java.io.File defaultServerIcon()

Default server-icon.png-file used by Minecraft servers. This file resides in the server_files-directory inside ServerPackCreators home-directory.

Returns:

server_files/server-icon.png

serverPackCreatorDatabase

@NotNull
public @NotNull java.io.File serverPackCreatorDatabase()

ServerPackCreator-database when running as a webservice. Resides inside ServerPackCreators home-directory.

Returns:

home-directory/serverpackcreator.db

homeDirectory

@NotNull
public @NotNull java.io.File homeDirectory()

ServerPackCreators home directory, in which all important files and folders are stored in.

Stored in serverpackcreator.properties under the de.griefed.serverpackcreator.home- property.

Every operation is based on this home-directory, with the exception being the serverPacksDirectory(), which can be configured independently of ServerPackCreators home-directory.

Returns:

home-directory of SPC.

langDirectory

@NotNull
public @NotNull java.io.File langDirectory()

Directory in which the language-properties for internationalization are stored in.

These are copied from the JAR-file to this directory during the startup of ServerPackCreator. Users may edit them to their liking or use them as examples for adding additional languages to ServerPackCreator.

By default, this is the lang-directory inside ServerPackCreators home-directory.

Returns:

lang

serverPackCreatorVersion

@NotNull
public @NotNull java.lang.String serverPackCreatorVersion()

Getter for the version of ServerPackCreator.
If a JAR-file compiled from a release-job from a CI/CD-pipeline is used, it should contain a VERSION.txt-file which contains the version of said release. If a non-release-version is used, from a regular pipeline or local dev-build, then this will be set to dev.

Returns:

String. Returns the version of ServerPackCreator.

supportedModloaders

@NotNull
public @NotNull java.lang.String[] supportedModloaders()

Modloaders supported by ServerPackCreator.

Returns:

Array of modloaders supported by ServerPackCreator.

addonConfigsDirectory

@NotNull
public @NotNull java.io.File addonConfigsDirectory()

Directory in which addon-specific configurations are stored in.

When ServerPackCreator starts and loads all available addons, it will also extract an addons config-file, if available. This file will be stored inside the config-directory using the ID of the addon as its name, with .toml appended to it. Think of this like the config-directory in a modded Minecraft server. Do the names of the config-files there look familiar to the mods they belong to? Well, they should!

By default, this is the config-directory inside the plugins-directory inside ServerPackCreators home-directory.

Returns:

plugins/config

addonsDirectory

@NotNull
public @NotNull java.io.File addonsDirectory()

Directory in which addons for ServerPackCreator are to be placed in.

This directory not only holds any potential addons for ServerPackCreator, but also contains the directory in which addon-specific config-files are stored in, as well as the disabled.txt-file, which allows a user to disable any installed addon.

By default, this is the plugins-directory inside the ServerPackCreator home-directory.

Returns:

plugins

serverPacksDirectory

@NotNull
public @NotNull java.io.File serverPacksDirectory()

Directory in which generated server packs, or server packs being generated, are stored in, as well as their ZIP-archives, if created.

By default, this directory will be the server-packs-directory in the home-directory of ServerPackCreator, but it can be configured using the property de.griefed.serverpackcreator.configuration.directories.serverpacks and can even be configured to be completely independent of ServerPackCreators home-directory.

Returns:

Directory in which the server packs are stored/generated in.

getListFallbackMods

@NotNull
public @NotNull java.util.List<java.lang.String> getListFallbackMods()

Acquire the default fallback list of clientside-only mods. If de.griefed.serverpackcreator.serverpack.autodiscovery.filter is set to ApplicationProperties.ExclusionFilter.REGEX, a regex fallback list is returned.

Returns:

The fallback list of clientside-only mods.

getDirectoriesToInclude

@NotNull
public @NotNull java.util.List<java.lang.String> getDirectoriesToInclude()

Getter for the default list of directories to include in a server pack.

Returns:

List containing default directories to include in a server pack.

getDirectoriesToExclude

@NotNull
public @NotNull java.util.List<java.lang.String> getDirectoriesToExclude()

Getter for the list of directories to exclude from server packs.

Returns:

Returns the list of directories to exclude from server packs.

getSaveLoadedConfiguration

public boolean getSaveLoadedConfiguration()

Getter for whether the last loaded configuration file should be saved to as well.

Returns:

Boolean. Whether the last loaded configuration file should be saved to as well.

getQueueMaxDiskUsage

public int getQueueMaxDiskUsage()

Getter for the maximum disk usage at which JMS/Artemis will stop storing queues on disk.

Returns:

Integer. The maximum disk usage at which JMS/Artemis will stop storing queues on disk.

checkForAvailablePreReleases

public boolean checkForAvailablePreReleases()

Getter for whether the search for available PreReleases is enabled or disabled.
Depending on de.griefed.serverpackcreator.versioncheck.prerelease, returns true if checks for available PreReleases are enabled, false if no checks for available PreReleases should be made.

Returns:

Boolean. Whether checks for available PreReleases are enabled.

getAikarsFlags

@NotNull
public @NotNull java.lang.String getAikarsFlags()

Get this configurations AikarsFlags

Returns:

Aikars flags.

getFilesToExcludeFromZipArchive

@NotNull
public @NotNull java.util.List<java.lang.String> getFilesToExcludeFromZipArchive()

List of files to be excluded from ZIP-archives. Current filters are:

• MINECRAFT_VERSION - Will be replaced with the Minecraft version of the server pack
• MODLOADER - Will be replaced with the modloader of the server pack
• MODLOADER_VERSION - Will be replaced with the modloader version of the server pack

Should you want these filters to be expanded, open an issue on GitHub

Returns:

Files and folders to exclude from the ZIP archive of a server pack.

isZipFileExclusionEnabled

public boolean isZipFileExclusionEnabled()

Whether the exclusion of files from the ZIP-archive of the server pack is enabled.

Returns:

true if the exclusion is enabled.

isAutoExcludingModsEnabled

public boolean isAutoExcludingModsEnabled()

Is auto excluding of clientside-only mods enabled.

Returns:

true if autodiscovery is enabled.

updateFallback

public boolean updateFallback()

Update the fallback clientside-only modlist of our serverpackcreator.properties from the main-repository or one of its mirrors.

Returns:

true if the fallback-property was updated.

isDarkTheme

public boolean isDarkTheme()

Is the Dark Theme currently active?

Returns:

true if the Dark Theme is active, otherwise false.

setTheme

public void setTheme(boolean dark)

Set the current theme to Dark Theme or Light Theme.

Parameters:

dark - true to activate Dark Theme, false otherwise.

isServerPacksOverwriteEnabled

public boolean isServerPacksOverwriteEnabled()

Whether overwriting of already existing server packs is enabled.

Returns:

true if it is enabled.

isServerPackCleanupEnabled

public boolean isServerPackCleanupEnabled()

Whether cleanup procedures after server pack generation are enabled.

Returns:

true if it is enabled.

getLanguage

@NotNull
public @NotNull java.lang.String getLanguage()

Get the currently set language.

Returns:

The language currently set and used.

setLanguage

public void setLanguage(@NotNull
                        @NotNull java.lang.String locale)

Overwrite the language used so the next run of ServerPackCreator uses that language setting.

Parameters:

locale - The language to set for the next run.

getHasteBinServerUrl

@NotNull
public @NotNull java.lang.String getHasteBinServerUrl()

Acquire this instances HasteBin server documents endpoint URL.

Returns:

URL to the HasteBin server documents endpoint.

enableMinecraftPreReleases

public boolean enableMinecraftPreReleases()

Whether Minecraft pre-releases and snapshots are available to the user in, for example, the GUI.

Returns:

true if they are available.

exclusionFilter

@NotNull
public @NotNull ApplicationProperties.ExclusionFilter exclusionFilter()

The filter method with which to determine whether a user-specified clientside-only mod should be excluded from the server pack. Available settings are:

• ApplicationProperties.ExclusionFilter.START
• ApplicationProperties.ExclusionFilter.END
• ApplicationProperties.ExclusionFilter.CONTAIN
• ApplicationProperties.ExclusionFilter.REGEX
• ApplicationProperties.ExclusionFilter.EITHER

Returns:

The filter method by which to exclude user-specified clientside-only mods.

javaPath

@NotNull
public @NotNull java.util.Optional<java.lang.String> javaPath(int javaVersion)

Get the path to the specified Java executable/binary, wrapped in an Optional for your convenience.

Parameters:

javaVersion - The Java version to acquire the path for.

Returns:

The path to the Java executable/binary, if available.

isJavaScriptAutoupdateEnabled

public boolean isJavaScriptAutoupdateEnabled()

Whether to automatically update the SPC_JAVA_SPC-placeholder in the script variables table with a Java path matching the required Java version for the Minecraft server.

Returns:

true if enabled.

getJarFolder

@NotNull
public @NotNull java.io.File getJarFolder()

The folder containing the ServerPackCreator.exe or JAR-file.

Returns:

Folder containing the ServerPackCreator.exe or JAR-file.

getJarFile

@NotNull
public @NotNull java.io.File getJarFile()

The .exe or JAR-file of ServerPackCreator.

Returns:

The .exe or JAR-file of ServerPackCreator.

getJarName

@NotNull
public @NotNull java.lang.String getJarName()

The name of the .exe or JAR-file.

Returns:

The name of the .exe or JAR-file.

getJavaVersion

@NotNull
public @NotNull java.lang.String getJavaVersion()

The Java version used to run ServerPackCreator.

Returns:

Java version.

getOSArch

@NotNull
public @NotNull java.lang.String getOSArch()

Architecture of the operating system on which ServerPackCreator is running on.

Returns:

Arch.

getOSName

@NotNull
public @NotNull java.lang.String getOSName()

The name of the operating system on which ServerPackCreator is running on.

Returns:

OS name.

getOSVersion

@NotNull
public @NotNull java.lang.String getOSVersion()

The version of the OS on which ServerPackCreator is running on.

Returns:

Version of the OS.

isExe

public boolean isExe()

Whether a .exe or JAR-file was used for running ServerPackCreator.

Returns:

true if a .exe was/is used.