# BetterConfig
\nA very powerful and easy to use command based configuration library for servers and clients.<\/p>\n
## Creating a simple configuration ## That’s not all! Furthermore, you can completely change the behaviour of updating your config values by creating your own methods. Simply The parameters of the update method can also be customised. And many more things! For some illustrative examples, see the `Configs` class for both ## Installation You may choose between my own maven repository and GitHub’s package repository. A very powerful and easy to use command based configuration library for servers and clients.<\/p>\n","protected":false},"featured_media":29958,"template":"","meta":{"_minecraft_slug":"betterconfig","_minecraft_project_id":"nqgcleOE","_minecraft_author":"xpple","_minecraft_license":"LGPL-3.0-or-later","_minecraft_downloads":7997,"_minecraft_follows":10,"_minecraft_client_side":"unsupported","_minecraft_server_side":"required","_minecraft_storage_type":"zip","_minecraft_archive_name":"betterconfig.zip","_minecraft_size_bytes":1542653,"_minecraft_version_count":37,"_minecraft_updated_at":"2026-05-16T02:24:44.214935Z","_minecraft_date_created":"2023-02-06T22:57:09.361730Z","_minecraft_date_modified":"2025-01-19T20:18:41.185708Z","_minecraft_project_url":"https:\/\/modrinth.com\/mod\/betterconfig","_minecraft_icon_attachment_id":29958,"_minecraft_imported_at":"2026-06-01T12:32:20+00:00","_minecraft_import_hash":"6407632f7c6886a2e878cc114b47d7da","_minecraft_versions":"","_minecraft_links":"","_minecraft_gallery":"","_minecraft_api_metadata":""},"mod_category":[97,873,126,127,91],"mod_loader":[99],"minecraft_version":[57,58,59,36,62],"class_list":["post-29957","mod","type-mod","status-publish","has-post-thumbnail","hentry","mod_category-fabric","mod_category-library","mod_category-management","mod_category-paper","mod_category-storage","mod_loader-fabric","minecraft_version-1-19-3","minecraft_version-1-19-4","minecraft_version-1-20","minecraft_version-1-20-1","minecraft_version-1-21"],"yoast_head":"\n
\nTo start, create a new class. This will be the class where all your configurations are stored. For this example, we’ll
\ncall this class `Configs`. Make sure that this class is `public`! Next, create a field for your configuration entry. The
\nfield should not be final. Mark this field with the annotation `@Config`. The initial value of the field will be used as
\ndefault (fallback) value. You can add a comment by setting the `comment` attribute.
\n“`java
\npublic class Configs {
\n @Config(comment = “This is an example!”)
\n public static String exampleString = “default”;
\n}
\n“`
\nFinally, register your `Configs` class.
\n– For Fabric users, register the `Configs` class in your mod’s `onInitialize(Client)` method. Replace `
\nmod’s id. Sometimes you may omit the generics and just do `<>` instead.
\n – On clients:
\n “`java
\n new ModConfigBuilder
\n “`
\n – On servers:
\n “`java
\n new ModConfigBuilder
\n “`
\n– For Paper users, register the `Configs` class in your plugin’s `onEnable` method. Replace `
\nplugin’s name.
\n “`java
\n new ModConfigBuilder<>(
\n “`
\nThat’s it! Now you can access `exampleString` through `Configs.exampleString`. You can edit `exampleString` by using the
\nconfig command.
\n– On Fabric there are different commands for the client and server. For both, replace `
\n – On clients, execute `\/cconfig
\n – On servers, execute `\/config
\n– On Paper servers, execute `\/config
\nplugin’s name.<\/p>\n
\nThis mod also natively supports the use of `Collection`s and `Map`s as variable types. These configurations will have
\nthe options `add`, `put` and `remove` available. Moreover, you can define your own (de)serialisers to create
\nconfigurations with arbitrary types. To do this, all you have to do is register the (de)serialiser when you build your
\nconfig. For instance, to create configurations with type `Block` you can do
\n“`java
\nnew ModConfigBuilder<>(
\n .registerTypeHierarchy(Block.class, new BlockAdapter(), BlockArgumentType::block)
\n .build();
\n“`
\nwhere `BlockAdapter` extends `TypeAdapter
\n[these tests](fabric\/src\/testmod\/java\/dev\/xpple\/betterconfig) for a complete picture. An identical setup for Paper can
\nbe found [here](paper\/src\/testplugin\/java\/dev\/xpple\/betterconfig).<\/p>\n
\nadd one or more of `setter`, `adder`, `putter` or `remover` as attribute to your `@Config` annotation. A great use for
\nthis would be adding key-value entries to a `Map` based on a single value. Consider the following configuration.
\n“`java
\n@Config(putter = @Config.Putter(“none”), adder = @Config.Adder(“customMapAdder”))
\npublic static Map
\npublic static void customMapAdder(String string) {
\n exampleMapAdder.put(string.toLowerCase(Locale.ROOT), string.toUpperCase(Locale.ROOT));
\n}
\n“`
\nThe value of `”none”` for the putter indicates that no putter will be available. This way, you can use this `Map` in your
\ncode like usual, and add values to it using `\/(c)config
\n[the JavaDocs for `@Config`](common\/src\/main\/java\/dev\/xpple\/betterconfig\/api\/Config.java).<\/p>\n
\n“`java
\n@Config(adder = @Config.Adder(value = “customTypeAdder”, type = int.class))
\npublic static Collection
\npublic static void customTypeAdder(int codepoint) {
\n exampleCustomType.add(Character.toString(codepoint));
\n}
\n“`
\nFor putters, there are separate key and value type attributes.<\/p>\n
\n[Fabric](fabric\/src\/testmod\/java\/dev\/xpple\/betterconfig\/Configs.java) and
\n[Paper](paper\/src\/testplugin\/java\/dev\/xpple\/betterconfig\/Configs.java).<\/p>\n
\nReplace `${betterconfig_version}` with the artifact version.<\/p>\n
\n### My own
\n“`gradle
\nrepositories {
\n maven {
\n url ‘https:\/\/maven.xpple.dev\/maven2’
\n }
\n}
\n“`
\n### GitHub packages
\n“`gradle
\nrepositories {
\n maven {
\n url ‘https:\/\/maven.pkg.github.com\/xpple\/BetterConfig’
\n credentials {
\n username = project.findProperty(“gpr.user”) ?: System.getenv(“USERNAME”)
\n password = project.findProperty(“gpr.key”) ?: System.getenv(“TOKEN”)
\n }
\n }
\n}
\n“`
\nImport it:
\n“`gradle
\ndependencies {
\n \/\/ Fabric
\n include modImplementation(‘dev.xpple:betterconfig-fabric:${betterconfig_version}’)
\n \/\/ Paper (also include the JAR in the plugins folder)
\n compileOnly ‘dev.xpple:betterconfig-paper:${betterconfig_version}’
\n}
\n“`<\/p>\n","protected":false},"excerpt":{"rendered":"