About Predicate API

It's simple api for any type of mod requiring some player-specific checks. It provides codec-based api for reading them and a method to register custom ones, allowing for simple mod compatibility.

Builtin types

See BUILTIN.md for list/format of builtin predicates.

Getting Started (As a developer)

To begin, you need to add Nucleoid's maven to your build build.gradle.

repositories {
    // There might be other repos there too, just add it at the end
    maven { url "https://maven.nucleoid.xyz/" }
}

Then you just declare it as dependency!

dependencies {
    // You will have other dependencies here too
    
	modImplementation include("eu.pb4:predicate-api:[VERSION]")
}

This will also include it in yours mods, so users won't need to download it separately.

You just need to replace [VERSION] with version you want to use (which should be usually the latest available). For list of version names, you can check maven