ApiProperties

Aikars Flags commonly used for Minecraft servers to improve performance in various places.

The version of the ServerPackCreator API.

String-list of clientside-only mods to exclude from server packs.

Regex-list of clientside-only mods to exclude from server packs.

Directory in which ServerPackCreator configurations from the GUI get saved in by default.

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

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.

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

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

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.

Directories to exclude from a server pack.

Directories to include in a server pack.

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

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

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

Fabric version manifest containing information about available Fabric loader versions.

Only the first call to this property will return true if this is the first time ServerPackCreator is being run on a given host. Any subsequent call will return false. Handle with care!

Forge version manifest containing information about available Forge loader versions.

URL to the HasteBin server where logs and configs are uploaded to.

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

Directory in which the icons for quick selection are to be stored in and retrieved from.

Caching directory for various types of installers. Mainly used by the version-meta for caching modloaders server installers, but also used as the ServerPackCreator installer cache-directory in certain scenarios.

Is auto excluding of clientside-only mods enabled.

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.

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.

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

Whether cleanup procedures after server pack generation are enabled.

Whether overwriting of already existing server packs is enabled.

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

Java installation used for installing the modloader server during server pack creation.

Paths to Java installations available to SPC for automatically updating the script variables of a given server pack configuration.

Path to the PostgreSQL database used by the webservice-side of ServerPackCreator.

Language used by ServerPackCreator.

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

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

LegacyFabric loader manifest containing information about Fabric loader maven versions.

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

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

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

Minecraft version manifest containing information about available Minecraft versions.

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

String-list of mods to include if present, regardless whether a match was found through clientsideMods.

Regex-list of mods to include if present, regardless whether a match was found throug clientsideModsRegex.

New NeoForge version manifest containing information about available NeoForge loader versions. This manifest contains versions for Minecraft 1.20.2 and up.

Old NeoForge version manifest containing information about available NeoForge loader versions. This manifest only contains versions for Minecraft 1.20.1.

Directory in which plugin-specific configurations are stored in.

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

List of files to delete after a server pack server installation.

List of files to delete before a server pack server installation.

Directory in which the properties for quick selection are to be stored in and retrieved from.

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

Quilt version manifest containing information about available Quilt loader versions.

Start-script templates to use during server pack generation.

Directory in which default server-files are stored in.

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

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

Modloaders supported by ServerPackCreator.

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

Base-directory for Tomcat, used by the webservice-side of ServerPackCreator.

Logs-directory for Tomcat, used by the webservice-side of ServerPackCreator.

The URL from which a .properties-file is read during updating of the fallback clientside-mods list. The default can be found in fallbackUpdateURL.

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

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

Check the given path to a Java installation for validity and return it, if it is valid. If the passed path is a UNIX symlink or Windows lnk, it is resolved, then returned. If the passed path is considered invalid, the system default is acquired and returned.

Writes the specified locale from -lang your_locale to a lang.properties file to ensure every subsequent start of serverpackcreator is executed using said locale.

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

Default home-directory for ServerPackCreator. If there's no user-home, then the directory containing the ServerPackCreator JAR will be used as the home-directory for ServerPackCreator.

Default list of script templates used by ServerPackCreator.

The .exe or JAR-file of ServerPackCreator.

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

The name of the .exe or JAR-file.

The Java version used to run ServerPackCreator.

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

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

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

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

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

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

Load properties using the default file path. Only call this method on an already initialized ApiProperties-object.

Reload from a specific properties-file.

Get the old version of ServerPackCreator used to perform necessary migrations between the old and the current version.

Retrieve a custom property in the serverpackcreator.properties-file. Beware that every property you retrieve this way contains a prefix, to prevent clashes with any other properties.

Write the overrides-properties which, as the name implies, will override any other property loaded previously during loadProperties. CAUTION: Depending on the type of installation, the overrides.properties will reside inside a directory which requires root/admin-privileges to write in. The directory in which this file will be created in is getJarFolder.

Store the ApplicationProperties to disk, overwriting the existing one.

Set the old version of ServerPackCreator used to perform necessary migrations between the old and the current version.

Store a custom property in the serverpackcreator.properties-file. Beware that every property you add receives a prefix, to prevent clashes with any other properties.

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

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