https://github.com/isxander/yetanotherconfiglib

YetAnotherConfigLib (yacl) is just that. A builder-based configuration library for Minecraft.
https://github.com/isxander/yetanotherconfiglib

Last synced: about 1 year ago
JSON representation

YetAnotherConfigLib (yacl) is just that. A builder-based configuration library for Minecraft.

• Host: GitHub
• URL: https://github.com/isxander/yetanotherconfiglib
• Owner: isXander
• License: lgpl-3.0
• Created: 2022-08-30T15:53:15.000Z (almost 4 years ago)
• Default Branch: 1.20.x/dev
• Last Pushed: 2024-04-12T13:41:58.000Z (about 2 years ago)
• Last Synced: 2024-04-13T04:51:19.200Z (about 2 years ago)
• Language: Java
• Homepage:
• Size: 1.08 MB
• Stars: 79
• Watchers: 2
• Forks: 32
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • Changelog: changelogs/0.1.1.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          


![](https://raw.githubusercontent.com/isXander/YetAnotherConfigLib/1.19/src/main/resources/yacl-128x.png)

# YetAnotherConfigLib

![Enviroment](https://img.shields.io/badge/Enviroment-Client-purple)

[![Java 17](https://img.shields.io/badge/Language-Java%2017-9B599A.svg?color=orange)](https://www.oracle.com/news/announcement/oracle-releases-java-17-2021-09-14)

[![Discord](https://img.shields.io/discord/780023008668287017?color=blue&logo=discord&label=Discord)](https://short.isxander.dev/discord)

[![Modrinth](https://img.shields.io/modrinth/dt/1eAoo2KR?color=00AF5C&label=downloads&logo=modrinth)](https://modrinth.com/mod/yacl)

[![CurseForge](https://cf.way2muchnoise.eu/full_667299_downloads.svg)](https://curseforge.com/minecraft/mc-mods/yacl)

[![Ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/isxander)

Yet Another Config Lib, like, what were you expecting?

  

[![](https://www.bisecthosting.com/partners/custom-banners/08bbd3ff-5c0d-4480-8738-de0f070a04dd.png)](https://bisecthosting.com/xander)



## Why does this mod even exist?

This mod was made to fill a hole in this area of Fabric modding. The existing main config libraries don't achieve what I want from them:

- **[Cloth Config API](https://modrinth.com/mod/cloth-config)**:
**It's stale.** The developer of cloth has clarified that they are likely not going to add any more features. They don't want to touch it. ([citation](https://user-images.githubusercontent.com/43245524/206530322-3ae46008-5356-468e-9a73-63b859364d4e.png))

- **[SpruceUI](https://github.com/LambdAurora/SpruceUI)**:
**It isn't designed for configuration.** In this essence the design feels cluttered. Further details available in [this issue](https://github.com/isXander/Zoomify/issues/85).

- **[MidnightLib](https://modrinth.com/mod/midnightlib)**:
**It has cosmetics among other utilities.** It may not be large but some players (including me) wouldn't want cosmetics out of nowhere.

- **[OwoLib](https://modrinth.com/mod/owo-lib)**:
**It's content focused.** It does a lot of other things as well as config, adding to the size.

As you can see, there's sadly a drawback with all of them and this is where YetAnotherConfigLib comes in.

## How is YACL better?

YACL has the favour of hindsight. Whilst developing this fresh library, I can make sure that it does everything right:

- **Client sided library.** YACL is built for client mods only, making it a smaller size.

- **Easy API.** YACL takes inspiration from [Sodium's](https://modrinth.com/mod/sodium) internal configuration library.

- **It's styled to fit in Minecraft.** YACL's GUI is designed to fit right in.

## Usage

[The wiki](https://github.com/isXander/YetAnotherConfigLib/wiki/Usage) contains a full documentation on how to use YACL.

## Screenshots



![java_A3zdbksGkC](https://user-images.githubusercontent.com/43245524/206924832-293b0780-2a8c-4b09-8765-155318d09ed9.png)



## License

This mod is under the [GNU Lesser General Public License, v3.0](LICENSE).