ComfiConf API

Powerful plugins. Comfortable configuration.

ComfiConf lets Minecraft server owners change the settings of their Paper plugins in a web editor at https://app.comficonf.com instead of hand-editing YAML. Plugins describe their settings with the ComfiConf API; the editor is generated from that description, the plugin validates and saves every change, and the server owner sees the real result: applied, saved but waiting for a restart, rejected, or a conflict.

Documentation

Site	For
developers.comficonf.com	Plugin developers: the API, schemas, providers, persistence, testing and the demo plugin
docs.comficonf.com	Server owners: installing and pairing the bridge, the editor, apply results, what leaves the server
javadoc.io	The Javadoc of com.comficonf:comficonf-api, the normative API reference

This repository is for plugin developers. It contains:

Path	Contents
java/api	The developer API, com.comficonf:comficonf-api
examples/demo-plugin	ComfiConfDemo, a voucher plugin showing a complete integration
docs/DEVELOPER_GUIDE.md	The developer guide, the source text of developers.comficonf.com

The ComfiConf bridge plugin that server owners install, and the ComfiConf service itself, are not part of this repository.

Getting started

The API is on Maven Central. Add it as compileOnly (Gradle) or provided (Maven), never shaded:

repositories {
    mavenCentral()
    maven("https://repo.papermc.io/repository/maven-public/")
}

dependencies {
    compileOnly("io.papermc.paper:paper-api:26.1.2.build.74-stable")
    compileOnly("com.comficonf:comficonf-api:0.1.0")
}

Then follow the Quickstart. It covers the Maven setup, the softdepend on ComfiConf, the optional hook that keeps your plugin working without the bridge, and registering a configuration resource. The rest of developers.comficonf.com documents every schema builder, the provider callbacks, threading, SafeFileWriter and SectionMapper, with ComfiConfDemo as the worked example. Your plugin keeps full control: it validates, saves its own files and activates changes, and it keeps working on servers without ComfiConf.

To try an integration, install the ComfiConf bridge from Hangar or Modrinth on a test server and pair it at https://app.comficonf.com, as described in Getting started on docs.comficonf.com, then open your plugin's settings there.

Building

Requires JDK 25.

cd java && ./gradlew build

On Windows, run gradlew.bat build in java. The build runs all tests and produces:

File	What it is
java/api/build/libs/comficonf-api-<version>.jar	The developer API, with sources and Javadoc JARs
examples/demo-plugin/build/libs/ComfiConfDemo-<version>.jar	The demo plugin

To try a change to the API in your own plugin before it is released, ./gradlew :api:publishToMavenLocal installs it into your local Maven repository; add mavenLocal() to your plugin's repositories to use it.

Security

Report vulnerabilities privately through Security, Report a vulnerability on this repository, not in a public issue.

License

The API and the demo plugin are licensed under the Apache License, Version 2.0; see LICENSE. The ComfiConf bridge and the ComfiConf service are proprietary.