commonMain.de.griefed.serverpackcreator.api.ConfigurationHandler.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of serverpackcreator-api-jvm Show documentation
ServerPackCreators API, to create server packs from Forge, Fabric, Quilt, LegacyFabric and NeoForge modpacks.
The newest version!
/* Copyright (C) 2024  Griefed
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
 * USA
 *
 * The full license can be found at https:github.com/Griefed/ServerPackCreator/blob/main/LICENSE
 */
package de.griefed.serverpackcreator.api

import de.griefed.serverpackcreator.api.utilities.File

/**
 * Check any given [PackConfig] for errors and, if so desired, add them to a passed
 * list of errors, so you may display them in a GUI, CLI or website. The most important method is
 * [checkConfiguration] and all of its variants which will check
 * your passed configuration model for errors, indicating whether it is safe to use for further
 * operations. Running your model through the checks also ensures that the default script settings
 * are present and set according to your pack's environment.
 *
 * @author Griefed
 */
expect class ConfigurationHandler {
    fun checkConfiguration(configFile: File, packConfig: PackConfig = PackConfig(), configCheck: ConfigCheck = ConfigCheck(), quietCheck: Boolean = false): ConfigCheck
    fun checkConfiguration(packConfig: PackConfig = PackConfig(), configCheck: ConfigCheck = ConfigCheck(), quietCheck: Boolean = false): ConfigCheck
    fun isDir(packConfig: PackConfig, configCheck: ConfigCheck = ConfigCheck()): ConfigCheck
    fun isZip(packConfig: PackConfig, configCheck: ConfigCheck = ConfigCheck()): ConfigCheck
    fun checkModloaderVersion(modloader: String, modloaderVersion: String, minecraftVersion: String, configCheck: ConfigCheck = ConfigCheck()): ConfigCheck
    fun checkInclusions(inclusions: MutableList, modpackDir: String, configCheck: ConfigCheck = ConfigCheck(), printLog: Boolean = true): ConfigCheck
    fun checkZipArchive(pathToZip: String, configCheck: ConfigCheck = ConfigCheck()): ConfigCheck
    fun checkManifests(destination: String, packConfig: PackConfig, configCheck: ConfigCheck = ConfigCheck()): String?
    fun checkModpackDir(modpackDir: String, configCheck: ConfigCheck = ConfigCheck(), printLog: Boolean = true): ConfigCheck
    fun checkModloader(modloader: String,configCheck: ConfigCheck = ConfigCheck()): ConfigCheck

    fun checkIconAndProperties(iconOrPropertiesPath: String = ""): Boolean

    fun ensureScriptSettingsDefaults(packConfig: PackConfig)
    fun sanitizeLinks(packConfig: PackConfig)
    fun unzipDestination(destination: String): String
    fun suggestInclusions(modpackDir: String): ArrayList
    fun checkServerPacksForIncrement(source: String, destination: String): String
    fun printConfigurationModel(
        modpackDirectory: String,
        clientsideMods: List,
        inclusions: List,
        minecraftVer: String,
        modloader: String,
        modloaderVersion: String,
        includeIcon: Boolean,
        includeProperties: Boolean,
        includeZip: Boolean,
        javaArgs: String,
        serverPackSuffix: String,
        serverIconPath: String,
        serverPropertiesPath: String,
        scriptSettings: HashMap
    )

    fun getDirectoriesInModpackZipBaseDirectory(zipFile: File): List
    fun updateConfigModelFromCurseManifest(packConfig: PackConfig, manifest: File)
    fun updatePackName(packConfig: PackConfig, vararg childNodes: String): String?
    fun updateConfigModelFromMinecraftInstance(packConfig: PackConfig, minecraftInstance: File)
    fun updateConfigModelFromModrinthManifest(packConfig: PackConfig, manifest: File)
    fun updateConfigModelFromInstance(packConfig: PackConfig, manifest: File)
    fun updateConfigModelFromConfigJson(packConfig: PackConfig, config: File)
    fun updateConfigModelFromMMCPack(packConfig: PackConfig, mmcPack: File)
    fun updateDestinationFromInstanceCfg(instanceCfg: File): String
    fun getAllFilesAndDirectoriesInModpackZip(zipFile: File): List
    fun getDirectoriesInModpackZip(zipFile: File): List
    fun getFilesInModpackZip(zipFile: File): List
}