https://github.com/prospector/libcd

Improved data processing for Fabric and Minecraft 1.14
https://github.com/prospector/libcd

Last synced: 25 days ago
JSON representation

Improved data processing for Fabric and Minecraft 1.14

• Host: GitHub
• URL: https://github.com/prospector/libcd
• Owner: Prospector
• License: mit
• Created: 2019-07-30T19:31:02.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-07-30T19:31:46.000Z (over 5 years ago)
• Last Synced: 2024-10-14T06:12:58.957Z (2 months ago)
• Language: Java
• Size: 343 KB
• Stars: 0
• Watchers: 1
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# LibConditionalData

[>> Downloads <<](https://github.com/CottonMC/LibConditionalData/releases)

*Improved data processing*

**This mod is open source and under a permissive license.** As such, it can be included in any modpack on any platform without prior permission. We appreciate hearing about people using our mods, but you do not need to ask to use them. See the [LICENSE file](LICENSE) for more details.

LibConditionalData, or LibCD, adds hooks to conditionally load data pack elements based on a metadata file. It's focused on being simple and extensible, along with being compatible with *any* resource type added by other mods.

## Client Use

For conditional resources, add a file `.mcmeta`. This will be parsed as JSON to check whether the resource should be loaded. All conditions go in an array with the key `when:`, and are each given as an object with a single key-value pair. Each pair will specify a condition that *must* be met for the recipe to be loaded. There are four conditions pre-included, and other mods may add their own:

- `libcd:mod_loaded` (passed a String or an array): Will return true if all mods with the given IDs are loaded.

- `libcd:item_exists` (passed a String or an array): Will return true if all items with the given item IDs are loaded.

- `libcd:not` (passed a single-element object) Will return true if the condition listed in the given object is *not* true.

- `libcd:or` (passed an array, aliased to "or"): Will return true if *any* condition listed in the given array is true.

**WARNING**: Currently, conditions silently return false if they are passed an improper parameter. This will hopefully be changed in the future, but if you think something should be loaded and it isn't, check your conditions.

## Developer Use

LibCD allows any mod to register their own conditions, to prevent recipe loadin based on config or more advanced logic. LibCD is available on the CurseForge maven.

To add a new condition, call `LibConditionalData.registerCondition()`, passing an Identifier for the condition's name and a `Predicate for the use of the condition.

The Object passed to the predicate will be a boxed primitive (Integer, Float, Boolean, etc.), a String, a List, a JsonObject, or null. Use an `instanceof` check to be sure what you're being passed.