Tulip
by TimeSquared
Tulip is a configuration library for Fabric and Quilt that handles saving and loading config data for other mods, so developers do not write that code themselves.
What it does
Tulip reads and writes config files in JSON format. A developer declares the settings as an ordinary Java class, and the library serializes that class to a file and deserializes it back when the game starts, without the developer writing the parsing code.
Its API lets a mod manage its own settings in a small number of calls, and the library reports problems with saved data so that a damaged file does not crash the mod silently. Tulip is open source under the MIT License and runs on the client only, so it is installed on the player's side and not needed on servers.
Installation needs no other mod. Tulip is published for Fabric and Quilt across 90 release versions, 1.0 – 1.21.3, and it is used as a dependency by Totem Overlays and Hit Timer, which both list it as required.
Key features
Automatic class serialization
A settings class is converted to and from JSON automatically, so fields are saved and restored without manual mapping.
JSON config files
Settings are stored as human-readable JSON files that can be opened and edited in a text editor.
Quick config setup
A developer can define a config file with a few lines of code, and the library handles creating the file when it is missing.
Error handling on load
When a config file cannot be read, the library reports the problem and keeps the mod running instead of leaving the data broken.
Custom config screens
A mod can build its own config screen class on top of the library to display and change its data, since Tulip itself does not draw settings menus.
Compatibility
Latest build for each game version and loader.
1.21.x4 of 4 versions with builds
1.20.x7 of 7 versions with builds
1.19.x5 of 5 versions with builds
1.18.x3 of 3 versions with builds
1.17.x2 of 2 versions with builds
1.16.x6 of 6 versions with builds
1.15.x3 of 3 versions with builds
1.14.x5 of 5 versions with builds
1.13.x3 of 3 versions with builds
1.12.x3 of 3 versions with builds
1.11.x3 of 3 versions with builds
1.10.x3 of 3 versions with builds
1.9.x1 of 1 version with builds
Only full game releases are shown. This mod publishes no snapshot builds.
42 older game versions (1.0 – 1.9.3) not shown. All files on Modrinth
Required by 2 mods
Use cases
Adding settings to a mod
A mod author can give players editable options without building a file parser for each new setting.
Editing settings by hand
Players who prefer files can change values directly in the JSON output and restart the game to apply them.
Who it’s for: Mod developers who need a configuration layer for Fabric or Quilt mods. Players gain nothing directly, but they meet Tulip when they install a mod that depends on it, such as Totem Overlays or Hit Timer.
Questions
Does Tulip need to be installed on servers?
Which loaders does Tulip support?
Which mods require Tulip?
In the catalog
Tulip is one of 3,514 Library mods on ModsFinder, and one of 2,348 Library mods for Fabric. 13,252 mods support Minecraft 1.21.3.
More from TimeSquared
Similar mods
What the author says
Tulip is a lightweight and easy-to-use config library for Minecraft that simplifies the process of saving and loading data to and from config files. With its simple API, Tulip allows you to easily manage your mod's config settings. Whether you're a beginner or an experienced modder, Tulip's intuitive design means…
Official listing
- Modrinth page
- modrinth.com/mod/tulip
- Owner
- TimeSquared
- Published
- 2023-07-21
- Updated on Modrinth
- 2024-10-26
- Facts verified
- 2026-10-15
