serverpackcreator-api/de.griefed.serverpackcreator.api.config/ConfigurationHandler/printConfigurationModel

printConfigurationModel

fun printConfigurationModel(packConfig: PackConfig)

Convenience method which passes the important fields from an instance of PackConfig to .printConfigurationModel

Author

Griefed

Parameters

packConfig

Instance of PackConfig to print to console and logs.

fun printConfigurationModel(modpackDirectory: String, clientsideMods: List<String>, inclusions: List<InclusionSpecification>, minecraftVer: String, modloader: String, modloaderVersion: String, includeIcon: Boolean, includeProperties: Boolean, includeZip: Boolean, javaArgs: String, serverPackSuffix: String, serverIconPath: String, serverPropertiesPath: String, scriptSettings: HashMap<String, String>)

Prints all passed fields to the console and serverpackcreator.log. Used to show the user the configuration before ServerPackCreator starts the generation of the server pack or, if checks failed, to show the user their last configuration, so they can more easily identify problems with said configuration.

Should a user report an issue on GitHub and include their logs (which I hope they do....), this would also help me help them. Logging is good. People should use more logging.

Author

Griefed

Parameters

modpackDirectory

The used modpackDir field either from a configuration file or from configuration setup.

clientsideMods

List of clientside-only mods to exclude from the server pack...

inclusions

List of directories in the modpack which are to be included in the server pack.

minecraftVer

The Minecraft version the modpack uses.

modloader

The modloader the modpack uses.

modloaderVersion

The version of the modloader the modpack uses.

includeIcon

Whether to include the server-icon.png in the server pack.

includeProperties

Whether to include the server.properties in the server pack.

includeZip

Whether to create a zip-archive of the server pack, excluding the Minecraft server JAR according to Mojang's TOS and EULA.

javaArgs

Java arguments to write the start-scripts with.

serverPackSuffix

Suffix to append to name of the server pack to be generated.

serverIconPath

The path to the custom server-icon.png to be used in the server pack.

serverPropertiesPath

The path to the custom server.properties to be used in the server pack.

scriptSettings

Custom settings for start script creation. KEYs are the placeholder, VALUEs are the values with which the placeholders are to be replaced.