https://github.com/patbox/predicateapi
Simple api for any type of mod requiring some player-specific, configurable checks
https://github.com/patbox/predicateapi
Last synced: about 2 months ago
JSON representation
Simple api for any type of mod requiring some player-specific, configurable checks
- Host: GitHub
- URL: https://github.com/patbox/predicateapi
- Owner: Patbox
- License: lgpl-3.0
- Created: 2022-10-16T20:31:31.000Z (over 2 years ago)
- Default Branch: 1.21.2
- Last Pushed: 2024-10-19T18:20:02.000Z (8 months ago)
- Last Synced: 2025-04-23T13:16:42.491Z (about 2 months ago)
- Language: Java
- Size: 120 KB
- Stars: 2
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# 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](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`.
```groovy
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!
```groovy
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](https://maven.nucleoid.xyz/eu/pb4/predicate-api/)