serverpackcreator-api/de.griefed.serverpackcreator.api/ApiProperties

ApiProperties

@Plugin(name = "ServerPackCreatorConfigFactory", category = "Core")

class ApiProperties(propertiesFile: File = File("serverpackcreator.properties")) : ConfigurationFactory

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.

Author

Griefed

Parameters

propertiesFile

serverpackcreator.properties-file containing settings and configurations to load the API with.

Constructors

ApiProperties

constructor(propertiesFile: File = File("serverpackcreator.properties"))

Types

Companion

object Companion

CustomXMLConfiguration

inner class CustomXMLConfiguration(loggerContext: LoggerContext?, configSource: ConfigurationSource?) : XmlConfiguration

Custom XmlConfiguration to pass our custom log4j2.xml config to log4j.

Properties

aikarsFlags

var aikarsFlags: String

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

alphaBetaRegex

val alphaBetaRegex: <Error class: unknown class>

apiVersion

val apiVersion: String

The version of the ServerPackCreator API.

clientsideMods

var clientsideMods: <Error class: unknown class>

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

clientsideModsRegex

var clientsideModsRegex: TreeSet<String>

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

configsDirectory

var configsDirectory: File

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

configVersion

val configVersion: String

defaultBatchScriptTemplate

val defaultBatchScriptTemplate: File

The default Batch-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 startScriptTemplates.

defaultConfig

var defaultConfig: File

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

defaultJavaBatchScriptTemplate

val defaultJavaBatchScriptTemplate: File

The default Batch-template for the java-install 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 javaScriptTemplates.

defaultJavaPowerShellScriptTemplate

val defaultJavaPowerShellScriptTemplate: File

The default PowerShell-template for the java-install 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 javaScriptTemplates.

defaultJavaShellScriptTemplate

val defaultJavaShellScriptTemplate: File

The default shell-template for the java-install 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 javaScriptTemplates.

defaultPowerShellScriptTemplate

val defaultPowerShellScriptTemplate: File

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 startScriptTemplates.

defaultServerIcon

var defaultServerIcon: File

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

defaultServerProperties

var defaultServerProperties: File

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

defaultShellScriptTemplate

val defaultShellScriptTemplate: File

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 startScriptTemplates.

devBuild

val devBuild: Boolean

directoriesToExclude

var directoriesToExclude: <Error class: unknown class>

Directories to exclude from a server pack.

directoriesToInclude

var directoriesToInclude: <Error class: unknown class>

Directories to include in a server pack.

exclusionFilter

var 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:

fabricInstallerManifest

var fabricInstallerManifest: File

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

fabricIntermediariesManifest

var fabricIntermediariesManifest: File

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

fabricVersionManifest

var fabricVersionManifest: File

Fabric version manifest containing information about available Fabric loader versions.

fallbackAikarsFlags

val fallbackAikarsFlags: String

fallbackArtemisQueueMaxDiskUsage

val fallbackArtemisQueueMaxDiskUsage: Int = 90

fallbackAutoExcludingModsEnabled

val fallbackAutoExcludingModsEnabled: Boolean = true

fallbackCheckingForPreReleasesEnabled

val fallbackCheckingForPreReleasesEnabled: Boolean = false

fallbackCleanupSchedule

val fallbackCleanupSchedule: String

fallbackDatabaseCleanupSchedule

val fallbackDatabaseCleanupSchedule: String

fallbackDirectoriesExclusion

val fallbackDirectoriesExclusion: <Error class: unknown class>

fallbackDirectoriesInclusion

val fallbackDirectoriesInclusion: <Error class: unknown class>

fallbackExclusionFilter

val fallbackExclusionFilter: ExclusionFilter

fallbackJavaScriptAutoupdateEnabled

val fallbackJavaScriptAutoupdateEnabled: Boolean = true

fallbackMinecraftPreReleasesAvailabilityEnabled

val fallbackMinecraftPreReleasesAvailabilityEnabled: Boolean = false

fallbackOverwriteEnabled

val fallbackOverwriteEnabled: Boolean = true

fallbackPostInstallCleanupFiles

val fallbackPostInstallCleanupFiles: <Error class: unknown class>

fallbackPreInstallCleanupFiles

val fallbackPreInstallCleanupFiles: <Error class: unknown class>

fallbackServerPackCleanupEnabled

val fallbackServerPackCleanupEnabled: Boolean = true

fallbackUpdated

var fallbackUpdated: Boolean

Whether the fallback lists for clientside-mods and whitelisted mods have been updated.

fallbackUpdateServerPack

val fallbackUpdateServerPack: Boolean = false

fallbackUpdateURL

val fallbackUpdateURL: String

fallbackVersionSchedule

val fallbackVersionSchedule: String

fallbackZipExclusions

val fallbackZipExclusions: <Error class: unknown class>

fallbackZipFileExclusionEnabled

val fallbackZipFileExclusionEnabled: Boolean = true

firstRun

val firstRun: Boolean

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!

forgeVersionManifest

var forgeVersionManifest: File

Forge version manifest containing information about available Forge loader versions.

hasteBinServerUrl

var hasteBinServerUrl: String

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

home

val home: File

Default home-directory for ServerPackCreator. The directory containing the ServerPackCreator JAR.

homeDirectory

var homeDirectory: File

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

i18n4kConfig

val i18n4kConfig: I18n4kConfigDefault

iconsDirectory

var iconsDirectory: File

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

installerCacheDirectory

var installerCacheDirectory: File

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.

installLocationXml

val installLocationXml: File

isAutoExcludingModsEnabled

var isAutoExcludingModsEnabled: Boolean

Is auto excluding of clientside-only mods enabled.

isCheckingForPreReleasesEnabled

var isCheckingForPreReleasesEnabled: Boolean

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.

isJavaScriptAutoupdateEnabled

var isJavaScriptAutoupdateEnabled: Boolean

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.

isMinecraftPreReleasesAvailabilityEnabled

var isMinecraftPreReleasesAvailabilityEnabled: Boolean

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

isServerPackCleanupEnabled

var isServerPackCleanupEnabled: Boolean

Whether cleanup procedures after server pack generation are enabled.

isServerPacksOverwriteEnabled

var isServerPacksOverwriteEnabled: Boolean

Whether overwriting of already existing server packs is enabled.

isUpdatingServerPacksEnabled

var isUpdatingServerPacksEnabled: Boolean

Whether a server pack should be updated instead of cleanly generated.

isZipFileExclusionEnabled

var isZipFileExclusionEnabled: Boolean

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

javaPath

var javaPath: String

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

javaPaths

var javaPaths: HashMap<String, String>

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

javaScriptTemplates

var javaScriptTemplates: HashMap<String, String>

Start-script templates to use during server pack generation. Each key represents a different template and script-type.

jdbcDatabasePassword

var jdbcDatabasePassword: String

jdbcDatabaseUrl

var jdbcDatabaseUrl: String

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

jdbcDatabaseUsername

var jdbcDatabaseUsername: String

language

var language: Locale

Language used by ServerPackCreator.

legacyFabricGameManifest

var legacyFabricGameManifest: File

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

legacyFabricInstallerManifest

var legacyFabricInstallerManifest: File

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

legacyFabricLoaderManifest

var legacyFabricLoaderManifest: File

LegacyFabric loader manifest containing information about Fabric loader maven versions.

log4jXml

val log4jXml: File

logLevel

var logLevel: String

logsDirectory

var logsDirectory: File

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

manifestsDirectory

var manifestsDirectory: File

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

minecraftServerManifestsDirectory

var minecraftServerManifestsDirectory: File

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

minecraftVersionManifest

var minecraftVersionManifest: File

Minecraft version manifest containing information about available Minecraft versions.

modpacksDirectory

var modpacksDirectory: File

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

modsWhitelist

var modsWhitelist: <Error class: unknown class>

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

modsWhitelistRegex

var modsWhitelistRegex: TreeSet<String>

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

newNeoForgeVersionManifest

var newNeoForgeVersionManifest: File

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

oldNeoForgeVersionManifest

var oldNeoForgeVersionManifest: File

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

overridesPropertiesFile

var overridesPropertiesFile: File

Overrides which, well, override, any property which may be set in the regular serverPackCreatorPropertiesFile.

pluginsConfigsDirectory

var pluginsConfigsDirectory: File

Directory in which plugin-specific configurations are stored in.

pluginsDirectory

var pluginsDirectory: File

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

postInstallCleanupFiles

var postInstallCleanupFiles: <Error class: unknown class>

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

preInstallCleanupFiles

var preInstallCleanupFiles: <Error class: unknown class>

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

preRelease

val preRelease: Boolean

propertiesDirectory

var propertiesDirectory: File

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

quiltInstallerManifest

var quiltInstallerManifest: File

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

quiltVersionManifest

var quiltVersionManifest: File

Quilt version manifest containing information about available Quilt loader versions.

scriptTemplates

var ~~scriptTemplates~~: TreeSet<File>

serverFilesDirectory

var serverFilesDirectory: File

Directory in which default server-files are stored in.

serverPackCreatorPropertiesFile

var serverPackCreatorPropertiesFile: File

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

serverPacksDirectory

var serverPacksDirectory: File

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

serverPacksRegex

val serverPacksRegex: <Error class: unknown class>

startScriptTemplates

var startScriptTemplates: HashMap<String, String>

Start-script templates to use during server pack generation. Each key represents a different template and script-type.

substitutor

protected val substitutor: StrSubstitutor

supportedModloaders

val supportedModloaders: Array<String>

Modloaders supported by ServerPackCreator.

tempDirectory

var tempDirectory: File

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

tomcatBaseDirectory

var tomcatBaseDirectory: File

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

tomcatLogsDirectory

var tomcatLogsDirectory: File

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

trueFalseRegex

val trueFalseRegex: <Error class: unknown class>

updateUrl

var updateUrl: URL

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

webserviceCleanupSchedule

var webserviceCleanupSchedule: String

webserviceDatabaseCleanupSchedule

var webserviceDatabaseCleanupSchedule: String

webserviceVersionSchedule

var webserviceVersionSchedule: String

workDirectory

var workDirectory: File

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

zipArchiveExclusions

var zipArchiveExclusions: <Error class: unknown class>

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

Functions

acquireJavaPath

fun acquireJavaPath(pathToJava: String? = null): String

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.

changeLocale

fun changeLocale(locale: Locale)

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.

clearPropertyFileList

fun clearPropertyFileList()

clientSideMods

fun clientSideMods(): <Error class: unknown class>

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.

defaultJavaScriptTemplates

fun defaultJavaScriptTemplates(): HashMap<String, String>

Default map of start-script templates: sh, ps1, bat.

defaultScriptTemplates

fun ~~defaultScriptTemplates~~(): List<File>

Default list of script templates used by ServerPackCreator.

defaultServerPacksDirectory

fun defaultServerPacksDirectory(): File

defaultStartScriptTemplates

fun defaultStartScriptTemplates(): HashMap<String, String>

Default map of start-script templates: sh, ps1, bat.

defaultTomcatBaseDirectory

fun defaultTomcatBaseDirectory(): File

defaultTomcatLogsDirectory

fun defaultTomcatLogsDirectory(): File

defaultWebserviceDatabase

fun defaultWebserviceDatabase(): String

getConfiguration

open override fun getConfiguration(loggerContext: LoggerContext, source: ConfigurationSource): Configuration

Depending on whether this is the first run of ServerPackCreator on a users machine, the default log4j2 configuration may be present at different locations. The default one is the config inside the home-directory of SPC, of which we will try to set up our logging with. If said file fails for whatever reason, we will try to use a config inside the directory from which SPC was executed. Should that fail, too, the config from the classpath is used, to ensure we always have default configs available. Should that fail, too, though, log4j is set up with its own default settings.

open fun getConfiguration(loggerContext: LoggerContext, name: String, configLocation: URI): Configuration

open fun getConfiguration(loggerContext: LoggerContext, name: String, configLocation: URI, loader: ClassLoader): Configuration

getDefaultPrefix

protected open fun getDefaultPrefix(): String

getInputFromString

protected open fun ~~getInputFromString~~(config: String, loader: ClassLoader): ConfigurationSource

getJarFile

fun getJarFile(): File

The .exe or JAR-file of ServerPackCreator.

getJarFolder

fun getJarFolder(): File

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

getJarName

fun getJarName(): String

The name of the .exe or JAR-file.

getJavaVersion

fun getJavaVersion(): String

The Java version used to run ServerPackCreator.

getOSArch

fun getOSArch(): String

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

getOSName

fun getOSName(): String

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

getOSVersion

fun getOSVersion(): String

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

getPreference

fun getPreference(pref: String): Optional<String>

getSupportedTypes

protected open override fun getSupportedTypes(): Array<String>

getTestPrefix

protected open fun getTestPrefix(): String

getVersion

protected open fun getVersion(): String

isActive

protected open fun isActive(): Boolean

isExe

fun isExe(): Boolean

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

javaAvailable

fun javaAvailable(): Boolean

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

javaPath

fun javaPath(javaVersion: Int): Optional<String>

fun javaPath(javaVersion: String): <Error class: unknown class>

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

loadOverrides

fun loadOverrides(properties: File = overridesPropertiesFile)

loadProperties

fun loadProperties(saveProps: Boolean = true)

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

fun loadProperties(propertiesFile: File = File(serverPackCreatorProperties).absoluteFile, saveProps: Boolean = true)

Reload from a specific properties-file.

oldVersion

fun oldVersion(): String

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

printSettings

fun printSettings()

retrieveCustomProperty

fun retrieveCustomProperty(property: String): String?

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.

saveProperties

fun saveProperties(propertiesFile: File)

Store the ApplicationProperties to disk, overwriting the existing one.

setOldVersion

fun setOldVersion(version: String)

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

storeCustomProperty

fun storeCustomProperty(property: String, value: String): String

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.

storePreference

fun storePreference(pref: String, value: String)

updateFallback

fun updateFallback(): Boolean

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

whitelistedMods

fun whitelistedMods(): <Error class: unknown class>

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.