OneConfig is a free, open sourced configuration library by Polyfrost, designed to give developers a simple config API, which users can interact with in an elegant user interface.
For beginners, we recommend using SkyClient, a free and open-sourced mod installer. For more technical users, all of our mods, including Hytils, CrashPatch, EvergreenHUD, and Chatting have full support, and come with OneConfig. Most of your existing mods (i.e. ones that use Vigilance) are also supported through our compatability layer.
While it may look like OneConfig is a client, in reality it's actually a standalone mod. You can actually see for yourself, it doesn't come with any mods of it's own. It's left up to the user to decide which mods they want to actually use.
Almost everything you could need to start using OneConfig can be found in our documentation. For further questions, feel free to make a developer ticket in our discord.
- Start a new project with our mod template, add OneConfig to an existing project, or migrate from
JSON
,Vigilance
, or.cfg
(Forge) files. - Register a config
- Add config options
- HUD system
- Check out other utilities like events, commands, and custom rendering.
Please check out our example mod.
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
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.