Pommel - Held Item Models

Blade - Resource Pack

—Held Item Model Resource Pack—

What is Pommel?

Pommel is a Fabric mod that lets resourcepacks replace the models for the held version of items—just like the spyglass and the trident—letting you customize what your item looks in your hand. Want to make a 3d model of the mace in your hand, a fiery greatsword, or an ancient magical staff while still retaining the original item? With Pommel, all that can be achieved!

Works for modded items as well!

If you create a resource pack with Pommel, feel free to share your work to me! I'd love to see what you can make!

For Resource Pack Creators

Adds the following Item Predicates:

pommel:is_held — when item is held in hand in third or first person
pommel:first_third_person — item in first person vs third person

Value of 0.5 changes the model specified when in first person, value of 1.0 changes the model when in third person.

pommel:is_offhand — item is in the user's offhand slot
pommel:is_fixed — when item is in an item frame
pommel:is_head — when item is worn on head in helmet slot
pommel:is_ground — when item is dropped onto the ground
pommel:is_thrown — throwable items when thrown (egg, snowball, enderpearl, etc.)
pommel:is_used — when item is being used (i.e. holding the use/RMB key); syncs with multiplayer if mod is on server and players have the mod
pommel:item_use — duration use of an item being used/consumed, like eating food
pommel:is_submerged — item is submerged in minecraft:water (doesn't work with other liquids)

When an item entity is thrown into water but then is no longer in water (e.g. you remove the water) the item still stays in it's "submerged" state

pommel:is_enchanted — if item is enchanted
pommel:is_misc_entity_holding — items held by Villagers, Witches, Pandas, and Foxes.

Note that these three entities will still also take the display settings of the Ground display settings for said model. If need be, you can change the Ground display rotation, translation, scale to make items look better when held in these entity's hands.

is_using and is_submerged also change the item model in the gui

For example, by modifying the model, iron_pickaxe.json, you can tell the mod what model should be displayed when held with pommel:is_held.

The held model provided as well as the textures for it can be wherever as long as it's specified by the item model json file.

JSON Example:

```json { "parent": "item/handheld", "textures": { "layer0": "minecraft:item/2d_model_texture" }, "overrides": [ { "predicate": { "pommel:is_held": 1.0 }, "model": "minecraft:item/my_held_item" }, { "predicate": { "pommel:is_fixed": 1.0 }, "model": "minecraft:item/my_framed_item" }, { "predicate": { "pommel:is_head": 1.0 }, "model": "minecraft:item/my_worn_item" }, { "predicate": { "pommel:is_ground": 1.0 }, "model": "minecraft:item/my_ground_item" }, ] } ```

Apple Eating Example:

```json { "parent": "minecraft:item/generated", "textures": { "layer0": "minecraft:item/apple" }, "overrides": [ { "predicate": { "pommel:is_held": 1 }, "model": "minecraft:item/held_items/apple_3d" }, { "predicate": { "pommel:item_use": 0.25 }, "model": "minecraft:item/apple_eat_0" }, { "predicate": { "pommel:is_held": 1, "pommel:item_use": 0.25 }, "model": "minecraft:item/held_items/apple_eat_0_3d" }, { "predicate": { "pommel:item_use": 0.50 }, "model": "minecraft:item/apple_eat_1" }, { "predicate": { "pommel:is_held": 1, "pommel:item_use": 0.50 }, "model": "minecraft:item/apple_eat_1_3d" }, { "predicate": { "pommel:item_use": 0.75 }, "model": "minecraft:item/apple_eat_2" }, { "predicate": { "pommel:is_held": 1, "pommel:item_use": 0.75 }, "model": "minecraft:item/apple_eat_2_3d" } ] } ```

In this example, the apple item will change from apple_eat_0 to apple_eat_2 as you eat it. The apple item will also change to a 3d version of this when it's being held in your hand, as well as having unique models for the hand when being eaten.

You may also specify file directories for held models for organizing, as well as changing the parent model to something else.

Other Examples

Bonus Tip: If you use the mod, Arsenal (1.20.1 only), the mod's back/holstered slot uses the item frame render type. Feel free to use pommel:is_fixed to replace the back item (as seen below) so a model appears instead of the item. Note that items in item frames will also use this same model.

Replaces the carved pumpkin on head with an emerald. Just like a Sim. Sword on back with the use of Arsenal (1.20.1) and pommel:is_fixed predicate.

Questions

Q: Does this work with CIT [Custom Item Textures]?

A: CIT Resewn and Optifine will work as long as you have CIT replace the item with an item model (and not with a texture). CIT lets you replace an item's model, so Pommel will still allow you to have custom held models.

Q: Does this work with Vanilla Minecraft's item predicates such as Custom Model Data or bow Pulling?

A: Yes, but be sure you specify pommel:is_held for the custom_model_data models as well.

Here is an example of using vanilla item predicates and held item models:

```json { "parent": "item/handheld", "textures": { "layer0": "item/base_item" }, "overrides": [ { "predicate": { "pommel:is_held": 1.0 }, "model": "minecraft:item/base_item_held" }, { "predicate": { "custom_model_data": 1 }, "model": "minecraft:item/custom_item" }, { "predicate": { "custom_model_data": 1, "pommel:is_held": 1.0 }, "model": "minecraft:item/custom_item_held" } ] } ```

Q: Is this compatible with Eating Animation mod?

A: Yes, Eating Animation can let you replace the model of your choosing with Pommel when you eat an item. The mod has two predicates, eating and eat (no mod id in front) so you can combine that with the Pommel predicates. The code will be just like the custom_model_data example above with Eating Animation's predicates. There is also a video guide on Eating Animation (also linked on the mod's page) that will show you how to set it up, too! Please check out the mod!

A: Second answer, you can also use pommel:item_use exactly the same with the identical effect without the use of Eating Animation mod. I do not want to "replace" Eating Animation. Rather, the item_use predicate was made as Eating Animation mod has some compatability issues with CIT, so this can be used as an alternative. Item models may not change/render the correct CIT model with Eating Animation, whereas Pommel does not have such issue.

Q: How would I replace a modded item's held model?

A: Same json hierarchy as in the JSON example, but instead of the id, minecraft in front, it would be <mod_id>.

Q: I'm having issues getting my held model to work. Where can I go for troubleshooting?

A: First check if your JSON code doesn't have errors, as it's pretty easy to accidentally screw up JSON code. Most IDEs will check for any errors, but there are some other websites that can check. If you're still having issues, honestly the best way to get support is to reach out to me on Discord (username is timmychips), or make an Issue request on the Github!

Charmsy x Punchy!

Compatibility

Minecraft: Java Edition

Tags

Creators

Details