Skip to content
PolyfrostPublic

About

Next-generation configuration library for Minecraft

Resources

Code of conduct

Contributing

Security policy

Stars

324 stars

Watchers

2 watching

Forks

Repository files navigation

OneConfig_banner_wide

OneConfig

Build status Modrinth downloads CurseForge downloads

OneConfig is a free, open source configuration library by Polyfrost. It gives developers a config API, and it gives players one screen where they change the settings of every mod that uses it.

❔ General information

Is it a client?

OneConfig may look like a client, but it is a standalone mod. You can see for yourself. It ships no mods of its own, so you decide which mods you use with it.

What do players get?

  • A settings screen with one card per mod, search, and a keybinds page. Right Shift opens it.
  • A HUD editor for moving, scaling and restyling the HUD elements of your mods.
  • Profiles, which each keep a separate copy of your mod settings.

Which versions does it support?

  • Minecraft 1.8.9 on Ornithe.
  • Minecraft 1.21.1-26.3 on Fabric.

OneConfig needs Compose Multiplatform and Fabric Language Kotlin. It also needs Fabric API on Fabric and OSL on Ornithe.

⚡️ Getting started

Almost everything you need to start using OneConfig is in our documentation. For further questions, make a developer ticket in our Discord.

To build OneConfig yourself, run the command below with JDK 25 installed. Replace 26.3-fabric with any supported version, such as 1.8.9-ornithe.

./gradlew ":bootstrap:26.3-fabric:build"

ℹ️ Example mod

Please check out our example mod.

📄 Licenses and Supporting Projects

License OneConfig is free and open-source. Except where noted otherwise (below and/or in individual files), all code is licensed under BOTH - version 3 of the GNU Lesser General Public License, **AND** - the Additional Terms Applicable to OneConfig, version 1.0 of the Additional Terms or (at your option) any later version.

Copies of version 3 of the GNU Lesser General Public License, version 1.0 of the Additional Terms Applicable to OneConfig, and version 3 of the GNU General Public License (which the GNU LGPLv3 supplements) can be found in the LICENSE file.

Polyfrost acts as the specified proxy when deciding whether future versions of the GNU Lesser General Public License shall apply. If Polyfrost publicly states the acceptance of a later version of the GNU Lesser General Public License, this is permanent authorization for you to choose that version for OneConfig. However, you must still be compliant with the Additional Terms Applicable to OneConfig.

Supporting Projects

YourKitLogo|50

YourKit supports open source projects with innovative and intelligent tools for monitoring and profiling Java and .NET applications.
YourKit is the creator of YourKit Java Profiler, YourKit .NET Profiler, and YourKit YouMonitor.

About

Next-generation configuration library for Minecraft

Resources

Code of conduct

Contributing

Security policy

Stars

324 stars

Watchers

2 watching

Forks

Releases

Used by

Contributors

Languages