5q12's YAML API
by 5q12
5q12's YAML API is a Fabric library for reading YAML files into Java objects and writing Java objects back out as YAML.
What it does
Mods built on the library can load YAML configuration and data files and convert their contents into Java objects, then write those objects back to disk in YAML format. Fabric API is required, and the library is published only for Fabric, for the game versions 1.19.4, 1.20.1, 1.20.6 and 1.21, as 1.19.4 – 1.21 in the range it covers.
The library is designed specifically for Fabric, so it targets the Fabric loader and its build conventions rather than other loaders. Only a mod that uses the API needs it, since it runs client or server side and a player or server owner can leave it out when no installed mod depends on it.
Source code and an issue tracker are public. The code is open source under the MIT License, and the latest Fabric file is v1.1.3-fabric for 1.21, dated 2024-07-20, after a first release on 2024-07-16.
Key features
Parse YAML into objects
Loads YAML files from disk and maps their structure onto Java objects for use by a mod.
Serialize objects to YAML
Turns Java objects into YAML text and saves them to a file in a readable layout.
Object mapping
Converts between YAML keys and Java fields, so a mod can work with typed objects instead of raw text.
Compatibility
Latest build for each game version and loader.
Only full game releases are shown. This mod publishes no snapshot builds.
Requirements
Dependencies declared by the latest file for each loader.
Required 1
Use cases
Mod configuration
A mod can keep its settings in YAML files and read them through the API at startup.
Data storage
A mod can save its state as YAML and reload it later, using the same object mapping in both directions.
Who it’s for: Fabric mod developers who need YAML reading and writing in their own project, rather than parsing the format by hand.
How it compares
Fabric Yaml Configuration is Fabric-only and covers 1.20.1 – 1.21.10, with All rights reserved licensing and no public source. YAML Resources is also Fabric-only, is open source under the MIT License, and covers 1.0 – 1.21.4. YAML Config is open source under the Apache License 2.0 and runs on Fabric and NeoForge for 1.21 – 26.3, so it also covers NeoForge.
| Mod | Loaders | Game versions | Environment | Updated |
|---|---|---|---|---|
| 5q12's YAML API | Fabric | 1.19.4 – 1.21 | Client or server, optional | 2024-07-20 |
| Fabric Yaml Configuration | Fabric | 1.20.1 – 1.21.10 | Client or server, optional | 2023-10-18 |
| YAML Resources | Fabric | 1.0 – 1.21.4 | Client or server, optional | 2025-03-09 |
| YAML Config | Fabric and NeoForge | 1.21 – 26.3 | Client or server, optional | 2026-10-10 |
Questions
Does 5q12's YAML API need Fabric API?
Is 5q12's YAML API only for Fabric?
Does a server need this library installed?
In the catalog
5q12's YAML API is one of 3,514 Library mods on ModsFinder, and one of 2,348 Library mods for Fabric. 15,770 mods support Minecraft 1.21.
More from 5q12
Similar mods
Official listing
- Modrinth page
- modrinth.com/mod/5q12s-yaml-api
- Owner
- 5q12
- Published
- 2024-07-16
- Updated on Modrinth
- 2024-07-20
- Facts verified
- 2026-10-15