feat: update to codec merging for ritual recipe

Author: klikli-dev

gradle.properties

@@ -42,8 +42,8 @@ mod_description=KubeJS Plugin for Occultism
 kubejs_version=2101.7.0-build.171
 kubejs_version_range=[2101.7.0-build.171,)
 
-occultism_version=1.160.0
-occultism_version_range=[1.160.0,)
+occultism_version=1.161.0
+occultism_version_range=[1.161.0,)
 #curios_version=5.2.0-beta.3
 #jei_version=15.2.0.23
 #geckolib_version=4.4

runs/client/kubejs/server_scripts/example.js

@@ -18,38 +18,18 @@ ServerEvents.recipes((event) => {
         WeightedRecipeResult.of('minecraft:wooden_pickaxe', 1, 100),
         '#occultism:miners/master'
     )
+
     event.recipes.occultism.ritual(
-        'occultism:spirit_lantern', //result
-        RitualRequirementSettings.of(
-            'occultism:craft_afrit', //pentacleId
-            [
-                "lapis_lazuli",
-                "#c:raw_materials",
-                "minecraft:coal"
-            ], //ingredients
-            '#c:stones', //activationItem
-            10, //optional, duration
-        ),
-        RitualStartSettings.of(
-            EntityToSacrifice.of(
-                "minecraft:cows", //the tag of entities to sacrifice
-                "Cows"
-                //the text to show in recipe viewers such as JEI/EMI/...
-                //it would be better to use a translation key instead of "Cows" to allow translating to other languages. E.g. "tags.entities.cows" -> but that also needs a corresponding translation in en_us.json and other lang files.
-            ), //optional entity to sacrifice (use null if none)
-            'minecraft:egg', //optional item to use (use null if none)
-            IsInBiomeCondition.of("minecraft:plains"), //optional condition (use null if none). Wrappers provided by OccultismKubeJS: IsInBiomeCondition, IsInBiomeWithTagCondition, IsInDimensionCondition, IsInDimensionTypeCondition. Also supports neoforge default conditions, but there is no kubejs wrapper for them yet.
-        ),
-    ).dummy("kubejs:dummy_ritual_thing") //the ritual dummy, used to allow viewing recipes in JEI/EMI/...
-        .ritualType("occultism:craft") //the ritual type. If omitted, it will default to "occultism:craft"
-        .entityToSummonSettings(
-            EntityToSummonSettings.of(
-                "minecraft:zombie", //the id of the entity to summon. Use null if you want to use a tag instead.
-                null, //"minecraft:cows", the tag of entities to summon. Use null if you want to use an id instead.
-                null, //the nbt of the entity to summon. Use null if you don't want to specify nbt.
-                "occultism:crush_tier1", //the spirit job type. Use null if you don't want to summon a spirit. Works only on occultism spirit entities.
-                -1, //the max age of the spirit. Use -1 if want the spirit to last forever. Works only on occultism spirit entities (ignored for other entities).
-                1 //the number of entities to summon. Use 1 if you want to summon only one entity.
-            )
-        );
+        'occultism:spirit_lantern',
+        [
+            "lapis_lazuli",
+            "#c:raw_materials",
+            "minecraft:coal"
+        ],
+        '#c:stones',
+        'occultism:craft_afrit'
+    ).dummy("kubejs:dummy_ritual_thing")
+        .useItem('minecraft:egg')
+        .entityToSacrifice(EntityToSacrifice.of("minecraft:cows", "Cows"))//it would be better to use a translation key instead of "Cows" to allow translating to other languages. E.g. "tags.entities.cows" -> but that also needs a corresponding translation in en_us.json and other lang files.
+        .condition(IsInBiomeCondition.of("minecraft:plains"))// Optional start condition. Unlike the neo conditions array this does not prevent loading the recipe, but rather prevents the start of the ritual (with a reasonable error message to the player). Wrappers provided by OccultismKubeJS: IsInBiomeCondition, IsInBiomeWithTagCondition, IsInDimensionCondition, IsInDimensionTypeCondition. Also supports neoforge default conditions, but there is no kubejs wrapper for them yet.
 })

src/main/java/com/klikli_dev/occultism_kubejs/KubeJSOccultismPlugin.java

@@ -56,21 +56,19 @@ public void registerRecipeComponents(RecipeComponentFactoryRegistry registry) {
         registry.register(RecipeResultComponent.RECIPE_RESULT);
         registry.register(WeightedRecipeResultComponent.WEIGHTED_RECIPE_RESULT);
         registry.register(EntityToSacrificeComponent.ENTITY_TO_SACRIFICE);
-        registry.register(RitualStartSettingsComponent.RITUAL_START_SETTINGS);
-        registry.register(RitualRequirementSettingsComponent.RITUAL_REQUIREMENT_SETTINGS);
-        registry.register(EntityToSummonSettingsComponent.ENTITY_TO_SUMMON_SETTINGS);
+        registry.register(ConditionComponent.CONDITION);
     }
 
     @Override
     public void registerBindings(BindingRegistry bindings) {
         bindings.add("RecipeResult", RecipeResultWrapper.class);
         bindings.add("WeightedRecipeResult", WeightedRecipeResultWrapper.class);
         bindings.add("EntityToSacrifice", EntityToSacrificeWrapper.class);
-        bindings.add("RitualStartSettings", RitualStartSettingsWrapper.class);
-        bindings.add("RitualRequirementSettings", RitualRequirementSettingsWrapper.class);
-        bindings.add("EntityToSummonSettings", EntityToSummonSettingsWrapper.class);
-        bindings.add("EntityToSummonSettings", EntityToSummonSettingsWrapper.class);
         bindings.add("IsInBiomeCondition", IsInBiomeConditionWrapper.class);
+        bindings.add("IsInBiomeWithTagCondition", IsInBiomeWithTagConditionWrapper.class);
+        bindings.add("IsInDimensionCondition", IsInDimensionConditionWrapper.class);
+        bindings.add("IsInDimensionTypeCondition", IsInDimensionTypeConditionWrapper.class);
+
     }
 
     @Override

src/main/java/com/klikli_dev/occultism_kubejs/RitualRecipeSchema.java

@@ -1,10 +1,8 @@
 package com.klikli_dev.occultism_kubejs;
 
 import com.klikli_dev.occultism.crafting.recipe.RitualRecipe;
+import com.klikli_dev.occultism_kubejs.component.ConditionComponent;
 import com.klikli_dev.occultism_kubejs.component.EntityToSacrificeComponent;
-import com.klikli_dev.occultism_kubejs.component.EntityToSummonSettingsComponent;
-import com.klikli_dev.occultism_kubejs.component.RitualRequirementSettingsComponent;
-import com.klikli_dev.occultism_kubejs.component.RitualStartSettingsComponent;
 import dev.latvian.mods.kubejs.recipe.RecipeKey;
 import dev.latvian.mods.kubejs.recipe.component.*;
 import dev.latvian.mods.kubejs.recipe.schema.RecipeSchema;
@@ -15,28 +13,42 @@
 import net.minecraft.world.entity.EntityType;
 import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.item.crafting.Ingredient;
+import net.neoforged.neoforge.common.conditions.ICondition;
 
 import java.util.List;
 
 public interface RitualRecipeSchema {
+    RecipeKey<ItemStack> RESULT = ItemStackComponent.ITEM_STACK.outputKey("result").allowEmpty();
+    RecipeKey<List<Ingredient>> INGREDIENTS = IngredientComponent.INGREDIENT.asList().inputKey("ingredients");
     RecipeKey<String> RITUAL_TYPE = StringComponent.ID.inputKey("ritual_type").alt("ritualType").optional("occultism:craft").alwaysWrite();
-    RecipeKey<RitualRecipe.RitualRequirementSettings> RITUAL_REQUIREMENT_SETTINGS = RitualRequirementSettingsComponent.RITUAL_REQUIREMENT_SETTINGS.inputKey("ritual_requirement_settings").alt("ritualRequirementSettings").alwaysWrite();
-    RecipeKey<RitualRecipe.RitualStartSettings> RITUAL_START_SETTINGS = RitualStartSettingsComponent.RITUAL_START_SETTINGS.inputKey("ritual_start_settings").alt("ritualStartSettings").alwaysWrite();
-    RecipeKey<RitualRecipe.EntityToSummonSettings> ENTITY_TO_SUMMON_SETTINGS = EntityToSummonSettingsComponent.ENTITY_TO_SUMMON_SETTINGS.outputKey("entity_to_summon_settings").alt("entityToSummonSettings")
-            .defaultOptional();
+    RecipeKey<String> ENTITY_TO_SUMMON = StringComponent.ID.inputKey("entity_to_summon").alt("entityToSummon").alt("summon").defaultOptional();
+    RecipeKey<TagKey<EntityType<?>>> ENTITY_TAG_TO_SUMMON = TagKeyComponent.ENTITY_TYPE.inputKey("entity_tag_to_summon").alt("entityTagToSummon").alt("summonTag").defaultOptional();
+    RecipeKey<String> ENTITY_NBT = StringComponent.ANY.inputKey("entity_nbt").alt("entityNbt").defaultOptional();
+    RecipeKey<Ingredient> ACTIVATION_ITEM = IngredientComponent.INGREDIENT.inputKey("activation_item").alt("activationItem");
+    RecipeKey<String> PENTACLE_ID = StringComponent.ID.inputKey("pentacle_id").alt("pentacleId").alt("pentacle");
+    RecipeKey<TickDuration> DURATION = TimeComponent.TICKS.inputKey("duration").optional(TickDuration.wrap(30));
+    RecipeKey<Integer> SPIRIT_MAX_AGE = NumberComponent.INT.inputKey("spirit_max_age").alt("spiritMaxAge").alt("maxAge").optional(-1);
+    RecipeKey<String> SPIRIT_JOB_TYPE = StringComponent.ID.inputKey("spirit_job_type").alt("spiritJobType").alt("jobType").defaultOptional();
     RecipeKey<ItemStack> RITUAL_DUMMY = ItemStackComponent.ITEM_STACK.outputKey("ritual_dummy").alt("ritualDummy").alt("dummyItem").alt("dummy")
             // apparently there is never any static reference to this item, so let's just hope klikli never changes this lmao
             .optional(new ItemStack(BuiltInRegistries.ITEM.get(ResourceLocation.parse("occultism:ritual_dummy/custom_ritual"))))
             .alwaysWrite();
-    RecipeKey<ItemStack> RESULT = ItemStackComponent.ITEM_STACK.outputKey("result").allowEmpty();
+
+    RecipeKey<RitualRecipe.EntityToSacrifice> ENTITY_TO_SACRIFICE = EntityToSacrificeComponent.ENTITY_TO_SACRIFICE
+            .inputKey("entity_to_sacrifice").alt("entityToSacrifice").alt("sacrifice")
+            .defaultOptional();
+    RecipeKey<Ingredient> ITEM_TO_USE = IngredientComponent.INGREDIENT.inputKey("item_to_use")
+            .alt("itemToUse").alt("useItem").optional(Ingredient.EMPTY).allowEmpty();
     RecipeKey<String> COMMAND = StringComponent.ANY.inputKey("command").defaultOptional();
+    RecipeKey<ICondition> CONDITION = ConditionComponent.CONDITION.inputKey("condition").alt("startCondition").defaultOptional();
 
     RecipeSchema SCHEMA = new RecipeSchema(
             // all the required keys first
-            RESULT,
-            RITUAL_REQUIREMENT_SETTINGS, RITUAL_START_SETTINGS,
+            RESULT, INGREDIENTS, ACTIVATION_ITEM, PENTACLE_ID,
             // and now all the optionals...
-            ENTITY_TO_SUMMON_SETTINGS, RITUAL_DUMMY, RITUAL_TYPE, COMMAND
+            DURATION, SPIRIT_MAX_AGE, SPIRIT_JOB_TYPE, RITUAL_DUMMY, RITUAL_TYPE,
+            ENTITY_TO_SUMMON, ENTITY_TAG_TO_SUMMON, ENTITY_NBT, ENTITY_TO_SACRIFICE,
+            ITEM_TO_USE, COMMAND, CONDITION
     ).uniqueId(RITUAL_DUMMY);
 
 }

src/main/java/com/klikli_dev/occultism_kubejs/component/RitualStartSettingsComponent.java src/main/java/com/klikli_dev/occultism_kubejs/component/ConditionComponent.java

@@ -8,11 +8,12 @@
 import dev.latvian.mods.kubejs.recipe.component.RecipeComponent;
 import dev.latvian.mods.rhino.Context;
 import dev.latvian.mods.rhino.type.TypeInfo;
+import net.neoforged.neoforge.common.conditions.ICondition;
 
-public record RitualStartSettingsComponent(String name, Codec<RitualRecipe.RitualStartSettings> codec) implements RecipeComponent<RitualRecipe.RitualStartSettings> {
-    public static final RecipeComponent<RitualRecipe.RitualStartSettings> RITUAL_START_SETTINGS = new RitualStartSettingsComponent("occultism:ritual_start_settings", RitualRecipe.RitualStartSettings.CODEC);
+public record ConditionComponent(String name, Codec<ICondition> codec) implements RecipeComponent<ICondition> {
+    public static final RecipeComponent<ICondition> CONDITION = new ConditionComponent("occultism:condition", ICondition.CODEC);
 
-    public static final TypeInfo TYPE_INFO = TypeInfo.of(RitualStartSettingsComponent.class);
+    public static final TypeInfo TYPE_INFO = TypeInfo.of(ConditionComponent.class);
 
     @Override
     public TypeInfo typeInfo() {
@@ -25,16 +26,15 @@ public String toString() {
     }
 
     @Override
-    public RitualRecipe.RitualStartSettings wrap(Context cx, KubeRecipe recipe, Object from) {
-        if (from instanceof RitualRecipe.RitualStartSettings k) {
+    public ICondition wrap(Context cx, KubeRecipe recipe, Object from) {
+        if (from instanceof ICondition k) {
             return k;
         }
 
         if (from instanceof JsonObject json) {
             return this.codec.decode(JsonOps.INSTANCE, json).result().orElseThrow().getFirst();
         }
 
-        return (RitualRecipe.RitualStartSettings) cx.jsToJava(from, this.typeInfo());
-
+        return (ICondition) cx.jsToJava(from, this.typeInfo());
     }
 }

src/main/java/com/klikli_dev/occultism_kubejs/component/EntityToSacrificeComponent.java

@@ -10,7 +10,7 @@
 import dev.latvian.mods.rhino.type.TypeInfo;
 
 public record EntityToSacrificeComponent(String name, Codec<RitualRecipe.EntityToSacrifice> codec) implements RecipeComponent<RitualRecipe.EntityToSacrifice> {
-    public static final RecipeComponent<RitualRecipe.EntityToSacrifice> ENTITY_TO_SACRIFICE = new EntityToSacrificeComponent("occultism:entity_to_sacrifice", RitualRecipe.EntityToSacrifice.CODEC);
+    public static final RecipeComponent<RitualRecipe.EntityToSacrifice> ENTITY_TO_SACRIFICE = new EntityToSacrificeComponent("occultism:entity_to_sacrifice", RitualRecipe.EntityToSacrifice.CODEC.codec());
 
     public static final TypeInfo TYPE_INFO = TypeInfo.of(EntityToSacrificeComponent.class);
 

src/main/java/com/klikli_dev/occultism_kubejs/component/EntityToSummonSettingsComponent.java

@@ -0,0 +1,20 @@
+package com.klikli_dev.occultism_kubejs.component;
+
+import com.klikli_dev.occultism.crafting.recipe.conditionextension.condition.IsInBiomeWithTagCondition;
+import dev.latvian.mods.kubejs.typings.Info;
+import net.minecraft.tags.TagKey;
+import net.minecraft.world.level.biome.Biome;
+
+@Info("Various IsInBiomeWithTagCondition related helper methods")
+public interface IsInBiomeWithTagConditionWrapper {
+
+    @Info("Returns an IsInBiomeWithTagCondition of the input")
+    static IsInBiomeWithTagCondition of(IsInBiomeWithTagCondition in) {
+        return in;
+    }
+
+    @Info("Returns an IsInBiomeWithTagCondition of the input")
+    static IsInBiomeWithTagCondition of(TagKey<Biome> tag) {
+        return new IsInBiomeWithTagCondition(tag);
+    }
+}

src/main/java/com/klikli_dev/occultism_kubejs/component/EntityToSummonSettingsWrapper.java

@@ -0,0 +1,20 @@
+package com.klikli_dev.occultism_kubejs.component;
+
+import com.klikli_dev.occultism.crafting.recipe.conditionextension.condition.IsInDimensionCondition;
+import dev.latvian.mods.kubejs.typings.Info;
+import net.minecraft.resources.ResourceKey;
+import net.minecraft.world.level.Level;
+
+@Info("Various IsInDimensionCondition related helper methods")
+public interface IsInDimensionConditionWrapper {
+
+    @Info("Returns an IsInDimensionCondition of the input")
+    static IsInDimensionCondition of(IsInDimensionCondition in) {
+        return in;
+    }
+
+    @Info("Returns an IsInDimensionCondition of the input")
+    static IsInDimensionCondition of(ResourceKey<Level> dimension) {
+        return new IsInDimensionCondition(dimension);
+    }
+}

src/main/java/com/klikli_dev/occultism_kubejs/component/IsInBiomeWithTagConditionWrapper.java

@@ -0,0 +1,20 @@
+package com.klikli_dev.occultism_kubejs.component;
+
+import com.klikli_dev.occultism.crafting.recipe.conditionextension.condition.IsInDimensionTypeCondition;
+import dev.latvian.mods.kubejs.typings.Info;
+import net.minecraft.core.Holder;
+import net.minecraft.world.level.dimension.DimensionType;
+
+@Info("Various IsInDimensionTypeCondition related helper methods")
+public interface IsInDimensionTypeConditionWrapper {
+
+    @Info("Returns an IsInDimensionTypeCondition of the input")
+    static IsInDimensionTypeCondition of(IsInDimensionTypeCondition in) {
+        return in;
+    }
+
+    @Info("Returns an IsInDimensionTypeCondition of the input")
+    static IsInDimensionTypeCondition of(Holder<DimensionType> dimensionType) {
+        return new IsInDimensionTypeCondition(dimensionType);
+    }
+}