serverpackcreator-api/de.griefed.serverpackcreator.api/ApiWrapper

ApiWrapper

expect class ApiWrapper

API wrapper, allowing you to conveniently initialize, setup and use the different aspects of ServerPackCreator.

Author

Griefed

actual class ApiWrapper : Api<File>

API wrapper, allowing you to conveniently initialize, setup and use the different aspects of ServerPackCreator.

Author

Griefed

Parameters

properties

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

language

Language to use with ServerPackCreator. Ensure to use a language for which you have the localization available.

runSetup

Whether to run the file-setup during API inizialization.

Types

Companion

object Companion

Properties

apiPlugins

expect val apiPlugins: ApiPlugins

@get:Synchronized

actual val apiPlugins: ApiPlugins

This instances plugin manager for ServerPackCreator-plugins, if any are installed. This gives you access to the available extensions, should any be available in your instance of ServerPackCreator.

apiProperties

expect val apiProperties: ApiProperties

@get:Synchronized

actual val apiProperties: ApiProperties

This instances settings used across ServerPackCreator, such as the working-directories, files and other settings.

booleanUtilities

val booleanUtilities: BooleanUtilities

This instances common boolean utilities used across ServerPackCreator.

configurationHandler

expect val configurationHandler: ConfigurationHandler

@get:Synchronized

actual val configurationHandler: ConfigurationHandler

This instances ConfigurationHandler for checking a given PackConfig for validity, so a server pack can safely be created from it.

documentBuilderFactory

@get:Synchronized

val documentBuilderFactory: DocumentBuilderFactory

This instances DocumentBuilder for working with XML-data.

fabricScanner

expect val fabricScanner: FabricScanner

@get:Synchronized

actual val fabricScanner: FabricScanner

This instances scanner to determine the sideness of Fabric mods.

fileUtilities

expect val fileUtilities: FileUtilities

@get:Synchronized

actual val fileUtilities: FileUtilities

This instances common file utilities used across ServerPackCreator.

forgeAnnotationScanner

expect val forgeAnnotationScanner: ForgeAnnotationScanner

@get:Synchronized

actual val forgeAnnotationScanner: ForgeAnnotationScanner

This instances annotation scanner used to determine the sideness of Forge mods for Minecraft 1.12.2 and older.

forgeTomlScanner

expect val forgeTomlScanner: ForgeTomlScanner

@get:Synchronized

actual val forgeTomlScanner: ForgeTomlScanner

This instances toml scanner to determine the sideness of Forge mods for Minecraft 1.13.x and newer.

jarUtilities

expect val jarUtilities: JarUtilities

@get:Synchronized

actual val jarUtilities: JarUtilities

This instances common JAR-utilities used across ServerPackCreator.

jsonUtilities

expect val jsonUtilities: JsonUtilities

@get:Synchronized

actual val jsonUtilities: JsonUtilities

This instances common JSON utilities used across ServerPackCreator.

listUtilities

val listUtilities: ListUtilities

This instances common list utilities used across ServerPackCreator.

log

protected val log: KLogger

modScanner

expect val modScanner: ModScanner

@get:Synchronized

actual val modScanner: ModScanner

This instances modscanner to determine the sideness of a given Forge, Fabric, LegacyFabric or Quilt mod.

neoForgeTomlScanner

expect val neoForgeTomlScanner: NeoForgeTomlScanner

@get:Synchronized

actual val neoForgeTomlScanner: NeoForgeTomlScanner

This instances toml scanner to determine the sideness of NeoForge mods for Minecraft 1.20.5 and newer.

objectMapper

@get:Synchronized

val objectMapper: ObjectMapper

This instances JSON-ObjectMapper used across ServerPackCreator with which this instance was initialized. By default, the ObjectMapper used across ServerPackCreator has the following features set:

properties

val properties: File

quiltScanner

expect val quiltScanner: QuiltScanner

@get:Synchronized

actual val quiltScanner: QuiltScanner

This instances scanner to determine the sideness of Quilt mods.

serverPackHandler

expect val serverPackHandler: ServerPackHandler

@get:Synchronized

actual val serverPackHandler: ServerPackHandler

This instances ServerPackHandler used to turn a PackConfig into a server pack.

setupWasRun

protected var setupWasRun: Boolean

stringUtilities

val stringUtilities: StringUtilities

This instances common String utilities used across ServerPackCreator.

systemUtilities

expect val systemUtilities: SystemUtilities

@get:Synchronized

actual val systemUtilities: SystemUtilities

This instances common system utilities used across ServerPackCreator.

tomlParser

expect val tomlParser: TomlParser

@get:Synchronized

actual val tomlParser: TomlParser

This instances toml parser to read and parse various .toml-files during mod-scanning, plugin- and extension config loading and provisioning, serverpackcreator.conf reading and more.

utilities

expect val utilities: Utilities

@get:Synchronized

actual val utilities: Utilities

This instances collection of common utilities used across ServerPackCreator.

versionMeta

expect val versionMeta: VersionMeta

@get:Synchronized

actual val versionMeta: VersionMeta

This instances version meta used for checking version-correctness of Minecraft and supported modloaders, as well as gathering information about Minecraft servers and modloader installers.

versionsRegex

protected val versionsRegex: Regex

webUtilities

expect val webUtilities: WebUtilities

@get:Synchronized

actual val webUtilities: WebUtilities

This instances common web utilities used across ServerPackCreator.

xmlJsonRegex

protected val xmlJsonRegex: Regex

xmlUtilities

expect val xmlUtilities: XmlUtilities

@get:Synchronized