Pakku/teksturepako.pakku.api.data/ConfigFile

ConfigFile

data class ConfigFile(name: String = "", version: String = "", description: String = "", author: String = "", overrides: MutableList<String> = mutableListOf(), serverOverrides: MutableList<String> = mutableListOf(), clientOverrides: MutableList<String> = mutableListOf(), val paths: MutableMap<String, String> = mutableMapOf(), val projects: MutableMap<String, ConfigFile.ProjectConfig> = mutableMapOf())

A config file (pakku.json) is a file used by the user to configure properties needed for modpack export.

Constructors

ConfigFile

constructor(name: String = "", version: String = "", description: String = "", author: String = "", overrides: MutableList<String> = mutableListOf(), serverOverrides: MutableList<String> = mutableListOf(), clientOverrides: MutableList<String> = mutableListOf(), paths: MutableMap<String, String> = mutableMapOf(), projects: MutableMap<String, ConfigFile.ProjectConfig> = mutableMapOf())

Types

Companion

object Companion

ProjectConfig

data class ProjectConfig(var type: ProjectType? = null, var side: ProjectSide? = null, var updateStrategy: UpdateStrategy? = null, var redistributable: Boolean? = null, var subpath: String? = null, var aliases: MutableSet<String>? = null, var export: Boolean? = null)

Properties

paths

val paths: MutableMap<String, String>

A map of project types to their respective paths.

projects

val projects: MutableMap<String, ConfigFile.ProjectConfig>

A mutable map of project slugs, names, IDs or filenames to project configs.

Functions

addOverride

fun addOverride(override: String)

addOverrides

fun addOverrides(vararg overrides: String)

fun addOverrides(overrides: Collection<String>)

findProjectConfig

fun <T> findProjectConfig(projectIn: Project, lockFile: LockFile, builder: (ConfigFile.ProjectConfig) -> T): <Error class: unknown class><T, ActionError>

getAllClientOverrides

suspend fun getAllClientOverrides(): List<<Error class: unknown class><String, ActionError>>

getAllClientOverridesFrom

suspend fun getAllClientOverridesFrom(path: <Error class: unknown class>): List<<Error class: unknown class><String, ActionError>>

getAllOverrides

suspend fun getAllOverrides(): List<<Error class: unknown class><String, ActionError>>

getAllOverridesFrom

suspend fun getAllOverridesFrom(path: <Error class: unknown class>): List<<Error class: unknown class><String, ActionError>>

getAllServerOverrides

suspend fun getAllServerOverrides(): List<<Error class: unknown class><String, ActionError>>

getAllServerOverridesFrom

suspend fun getAllServerOverridesFrom(path: <Error class: unknown class>): List<<Error class: unknown class><String, ActionError>>

getAuthor

fun getAuthor(): String

getDescription

fun getDescription(): String

getName

fun getName(): String

getVersion

fun getVersion(): String

removeAllOverrides

fun removeAllOverrides()

removeOverride

fun removeOverride(override: String)

setAuthor

fun setAuthor(author: String)

setDescription

fun setDescription(description: String)

setName

fun setName(name: String)

setProjectConfig

fun setProjectConfig(projectInput: String, lockFile: LockFile, builder: ConfigFile.ProjectConfig.(slug: String) -> Unit): ActionError?

fun setProjectConfig(projectIn: Project, lockFile: LockFile, builder: ConfigFile.ProjectConfig.(slug: String) -> Unit): ActionError?

setVersion

fun setVersion(version: String)

write

suspend fun write(): ActionError?