Using filament

Requires fabric api and polymer by patbox

filament mainly loads additional content using datapacks;

It also loads any assets from the assets folder in datapacks, if present.

The datapack structure should look something like this:

data/
|-- <namespace>/
|   |-- filament/
|   |   |-- item/
|   |   |   |-- <item_config>.json
|   |   |   |-- <item_config>.yaml
|   |   |
|   |   |-- block/
|   |   |   |-- <block_config>.json
|   |   |   |-- <block_config>.yaml
|   |   |
|   |   |-- decoration/
|   |   |   |-- <decoration_configs>.json
|   |   |
|   |   |-- entity/
|   |   |   |-- <entity_configs>.json
|   |   |
|   |   |-- model/
|   |       |-- <blockbench_model>.bbmodel
|   |       |-- <animated-java_model>.ajmodel
|
assets/
|   | ...
pack.mcmeta

So a configuration file path for a new block could look like this: MyDatapack/data/<namespace>/filament/block/myblock.json

The files can also be located in subfolders for better organization: MyDatapack/data/<namespace>/filament/block/stone_like/myblock.json

Filament supports yaml files as of 0.12.0. You can also decide whether you want to use snake_case or camelCase for all fields. For example, you can use either vanillaItem or vanilla_item or itemResource or item_resource

Blockbench and Animated-Java models for decorations are supported using the blockbench import library

In minecraft versions 1.21.4 and higher, filament will automatically generate the item asset json under namespace/items/itemname.json, using the values in the itemResource. Some item-behaviour can also generate item-specific item asset models, for example the bow pulling states or a cast fishing.

You can also provide your own item asset models using the itemModel field of an item (in the root structure of an item config) or by providing an item_model components using the components field. This will prevent the automatic generation of an item asset model.

Common fields

Item-, block- and decoration configuration files share some common fields.

Those are:

• id: Identifier of the item/block/decoration.
• vanillaItem: The client-side item to use. This will be used for custom model data values in <= 1.21.1
• blockResource: Here you can specify models for different blocks-states or just a single model for simple blocks.
• itemResource: Specifies the model of the item. Some item-behaviours may require you to provide models for their "states" (i.e. the trap behaviour)
• properties: Properties differ for each config type, but all share the item properties.
• itemTags: Item tags of the item/block-item/decoration-item.
• blockTags: Block tag of the block/decoration-block (not supported for items)

Items, Blocks and Decorations also allow to set item/block tags in the config file.

{
  "id": "mynamespace:example_item",
  "vanillaItem": "minecraft:paper",
  "itemTags": ["enchantable/durability"],
  "itemResource": {
    "models": {
      "default": "example:item/example_item"
    }
  },
  "properties": {
    "durability": 100,
    "stackSize": 1
  },
  "behaviour": {
    "enchantable": {
      "value": 1
    }
  }
}

Components

Filament comes with 2 components that any item to be skinned (visually) by any other item.

You can for example create a diamond pickaxe skin that can be applied to a wooden pickaxe or a diamond. The wooden pickaxe would look like a diamond pickaxe but function like a wooden pickaxe. You could also allow the diamond pickaxe skin to be applied to shovels too!

Filament cosmetics are also supported, which allows you to create cosmetic skins!

Player can simply drag a skin onto the item they want the skin applied to.

Skin Component Format

The filament:skin component works similar to the minecraft:repairable component. You can either specify a list of items or an item-tag, for which item you want the skin to be applicable for.

{
  "components": {
    "filament:skin": ["minecraft:wooden_pickaxe", "iron_pickaxe"]
  }
}

You can also use item-tags:

{
  "components": {
    "filament:skin": "#minecraft:pickaxes"
  }
}

For everything else, use behaviours as described below.

Behaviours

Custom content is driven by something called behaviours in filament.

Item behaviours give items, block-items, blocks and **decorations as well as decoration-items special capabilities, not normally possible using just vanilla item components.

This means that items, blocks and decorations are all capable of all item behaviours.

Block behaviours are not compatible with decorations and vice versa.

Genuinely modded content!

On the server-side of things, all your custom items and blocks are genuinely modded, meaning they have their own id, instead of 'just' being vanilla items with components, only obtainable via recipes for example.

You can for example just use /give @s mynamespace:myitem instead of having to provide a dozen components or a datapack function.

For clients that don't have any mods or polymer installed, the item show up as the vanillaItem in the config for your content, but with all components correctly applied with your custom models.

In 1.21.1, custom model data override predicates will be automatically generated. You can also set the vanilla custom model data components in the components field of a config to use your own values. This is not necessary in version 1.21.2 and above.

For 1.21.4, the new item model will be automatically generated. You can set the itemModel field in the root of an item config to prevent that.