Skip to content

Latest commit

 

History

History
30 lines (27 loc) · 3.24 KB

README.md

File metadata and controls

30 lines (27 loc) · 3.24 KB
Raw

Some Assembly Required CurseForge

Some Assembly Required is a Farmer's Delight addon loosely based on the fabric mod Sandwichable. More information can be found here: https://www.curseforge.com/minecraft/mc-mods/some-assembly-required

Customizing Items on Sandwiches

In version 2.0.0 and above, it is possible to customize the behavior and appearance of items on sandwiches through data packs. Ingredient JSONs are placed in the data/<namespace>/some_assembly_required/ingredients folder. Each JSON file corresponds to a single item. Items with a corresponding ingredient JSON can be added onto a sandwich even if the item is normally not edible. The following fields can be customized (All fields are optional except item):

  • item: (required) The corresponding item id for this ingredient. (The file name does not need to correspond to the item name. However, if there are multiple ingredient JSONs for a single item, only one will be loaded)
  • food: A json object, replaces the item's food stats when it is on a sandwich.
    • nutrition: (required) The amount of hunger the item heals.
    • saturationModifier: (required) The amount of saturation the item restores per point of hunger healed.
    • canAlwaysEat: (default = false) When true, sandwiches containing this item can be always eaten.
  • displayName: The name of the item as it should appear in the name of the sandwich. This is a text component, information on how to format these can be found here. (You can also use a string)
  • fullName: The name of the item as it should appear in the tooltip of the sandwich. (If the display name is omitted, and the full name is set, the full name is also used as the display name)
  • displayItem: A json object describing an item stack, overrides which item is rendered when this item is on a sandwich
    • item: (required) The item ID of the item to render instead.
    • count: The size of the item stack.
    • nbt: The NBT of the item stack, either as a JSON object or stringified NBT.
  • renderAsItem: (default = true) Set this to false when the display item has a custom model. Flat item models are rotated and translated by default.
  • height: (default = 1) The height of the model of this item, in pixels. (Determines the size of the gap between the previous item on the sandwich and the next)
  • container: A json object describing an item stack (see displayItem). If an item has a container, the container item will be returned to the player when the item is put on a sandwich. When an item with a container is removed from a sandwich, the item is voided instead of returned.
  • soundEvent: A sound event id. Changes the sound this item makes when added or removed from a sandwich.

For some example ingredients, see the default data pack.