Developers
One stable package — com.rfizzle.instinct.api — per the Concord API standard: read-only accessors, provider/callback registration as the only mutation, isModLoaded-guarded consumption. Everything here is specced and lands with implementation.
Accessors
| Method | Returns |
|---|---|
InstinctAPI.isPet(EntityType) | pets-set membership after full resolution (config → tags → heuristic) |
InstinctAPI.isLivestock(EntityType) | livestock-set membership after full resolution |
InstinctAPI.isMount(EntityType) | mounts-set membership after full resolution — the horse family by default; a mount gets self-preservation and downed/revival only |
InstinctAPI.getGrade(Animal) | Grade — ORDINARY, STURDY, or PRIME |
InstinctAPI.getPerk(Animal) | Perk — NONE, HARDY, FLEET, FERTILE, or PLACID |
InstinctAPI.getVeterancyDays(TamableAnimal) | accrued days (double), 0.0 if untracked |
InstinctAPI.getVeterancyRank(TamableAnimal) | rank 0–3 |
InstinctAPI.isDowned(LivingEntity) | downed state |
InstinctAPI.isTroughFed(Animal) | trough-fed within the last 24000 ticks |
InstinctAPI.setVeterancyRateProvider(…) | provider hook — multiplies live veterancy accrual; error-isolated, clamped to sane values |
Events
| Event | Fires |
|---|---|
InstinctAnimalBredCallback | after grade resolution at breeding — parents, child, final grade |
InstinctAnimalDownedCallback | when a pet or mount enters the downed state — animal and damage source |
InstinctAnimalRevivedCallback | on every path back up — animal, reviving player, item used. Kennel-post recovery passes a null reviver and an empty stack |
Convention tags and data — integrate with zero code
| Surface | What one data file gets you |
|---|---|
#instinct:pets / #instinct:livestock / #instinct:mounts (+ _exclude) | Entity-type tags — opt your mod's species in or out of the three coverage sets explicitly |
#instinct:carryable | Entity-type tag — small pets a rescuer can pick up and carry while downed |
#instinct:predators (+ _exclude) | Entity-type tag — species a stationed pet turns off the pasture (foxes and wild wolves by default) |
#instinct:trough_food | Item tag — your feed items become trough-accepted; animals eat them by their own breeding-food rules |
#instinct:revive_items | Item tag — your item revives downed pets (ships with golden apples and the Vet Kit) |
#instinct:mirror_products | Item tag — non-edible items the generic drop-bonus fallback may duplicate |
data/<ns>/instinct/products/*.json | One file per species: primary/secondary products (and cooked variants) for grade drop bonuses; unknown ids skip harmlessly, so rows for absent mods are safe to ship |
Item ids for sibling integrations: instinct:command_whistle, instinct:vet_kit, instinct:pedigree_treat, instinct:keepsake_collar; the blocks are instinct:feeding_trough and instinct:kennel_post. Full contracts in design/SPEC.md; suite conventions in the Concord API standard.