Skip to content

CaffeineMC Maven & Config API

Jump to bottom
douira edited this page Jan 5, 2026 · 2 revisions

CaffeineMC Maven

For various reasons you may want to depend on Sodium in its entirety or just our api package. Since we're forced to wrap our mod within a service loader on NeoForge in order for our workarounds to work, we publish the "unwrapped" mod on our Maven repository: https://maven.caffeinemc.net

Make sure you have our Maven repository declared:

maven {
    name "CaffeineMC"
    url "https://maven.caffeinemc.net/releases" // or /snapshots
}

Kotlin:

maven {
    name = "CaffeineMC"
    url = uri("https://maven.caffeinemc.net/releases") // or /snapshots
}

The Maven Repository has a web frontend that you can use to view the list of available versions: https://maven.caffeinemc.net

Config API

The Sodium Config API lets mods add their own pages to the Video Settings screen, which Sodium replaces with its own screen.

If you encounter difficulties using the API, find bugs in it, or it's missing features you need, don't hesitate to contact us or make a contribution directly.

The documentation of the API and how to use it can be found in USAGE.md. Also take note of the extensive JavaDoc on the API's interfaces, which is published alongside it.

Clone this wiki locally