Greenhouse Config

The most overengineered config library out there!

Greenhouse Config is a config library pretty much made for myself (ChrysanthCow), and anyone within Greenhouse.

Featuring a rich config builder system, it utilizes Codecs/DFU to write and read config files, as well as being able to data-fix when out of date.

Configuration Language Support

• JSONC
• JSON*

* - Should not typically be used in configs. Use JSONC instead if possible.

Config languages are supported through the in house Polyamory library.

Depending on the Library

When depending on Greenhouse Config, please make sure to include the mod inside your JAR. This is simply to avoid making users have to download a separate dependency just to play with your mod.

The below is for Kotlin DSL, you will need to adjust this for Groovy DSL.

repositories {
	maven("https://maven.greenhouse.lgbt/releases") {
		name = "Greenhouse Maven"
	}
}

// Define attributes. These are potentially necessary for resolving the correct dependency.
// Feel free to delete either attribute if you do not use them.
val greenhouseModdingApiAttribute = Attribute.of("lgbt.greenhouse.modding.api", String::class.java)
val greenhouseModdingPlatformAttribute = Attribute.of("lgbt.greenhouse.modding.platform", String::class.java)

dependencies {
	// Depend on the Cross-Platform/Loader Independent API.
	compileOnly("lgbt.greenhouse.config:greenhouse-config:${greenhouse_config_version}") {
		attributes {
			attribute(greenhouseModdingApiAttribute, "") // The value of the attribute must remain an empty string.
		}
	}

	// Include the universal JAR in the runtime environment.
	runtimeOnly("lgbt.greenhouse.config:greenhouse-config:${greenhouse_config_version}")

	// Include the Fabric project in the runtime environment and your JAR, for Loom and derivatives.
	include("lgbt.greenhouse.config:greenhouse-config:${greenhouse_config_version}")

	// Include the NeoForge project in the runtime environment and your JAR, for ModDevGradle and derivatives.
	jarJar("lgbt.greenhouse.config:greenhouse-config:${greenhouse_config_version}")

	// IT IS RECOMMENDED THAT YOU USE THE API JAR DUE TO IMPL BEING ABLE TO BREAK AT ANY TIME.
	// In the case that you need impl classes for a specific loader, use this.
	compileOnly("lgbt.greenhouse.config:greenhouse-config:${greenhouse_config_version}") {
		attributes {
			// The https://github.com/mcgradleconventions attribute also works if you prefer it.
			attribute(
				greenhouseModdingPlatformAttribute,
				"xplat"
			) // The Greenhouse Platform attribute supports 'xplat', 'fabric' and 'neoforge'.
		}
	}
}

greenhouse_config_version=3.0.0+26.1.x

Have you seen that one XKCD comic about standards?

Quoted from kdl.dev.

Yes. I have. Please stop linking me to it.

Greenhouse Config is not meant to be a standard, it's simply my own methodology for doing configuration which I separated from my own mods to avoid having duplicate code across them.

At the end of the day, you should mod with tools you enjoy using, whether it be Greenhouse Config or something else.