This folder contains the many modules that OneConfig offers to developers.
Each is designed to be an independent package, though some are dependent on other packages for their usage.
They each are under the namespace org.polyfrost.oneconfig.api.*.
Here is a list of the modules, and a brief description of what they do (For more information on how to use each module, see the README in the module's folder):
- commands - The tree based command system used in OneConfig.
- config - The tree based configuration system used in OneConfig.
- config-impl - The default implementation of the configuration system used in OneConfig.
- events - The event system used in OneConfig.
- hud - The HUD system used in OneConfig.
- ui - The UI system used in OneConfig.
- utils - Various utilities used in OneConfig.
Each module has the design philosophy of being decoupled from the internal structure, so that the developer can use the modules with separate front-facing APIs depending on preference. For example, the command system has three different ways to create commands, and the config system has two different ways to collect configuration data. This also helps to reduce interdependence and reduce the complexity of the codebase.
For Minecraft dependant code, see the
versionsdirectory. Some utilities and classes are found in this directory, under the same package name as the module.