Filament Documentation (1.4.x)

Creating a simple item

A minimal custom item definition in Filament looks like this:

JSON

{
  "id": "mynamespace:ruby",
  "vanillaItem": "minecraft:paper",
  "itemResource": {
    "parent": "minecraft:item/generated",
    "textures": {
      "layer0": "mynamespace:item/ruby"
    }
  },
  "properties": {
    "stackSize": 64
  }
}

YAML

id: mynamespace:ruby
vanillaItem: minecraft:paper

itemResource:
  parent: minecraft:item/generated
  textures:
    layer0: mynamespace:item/ruby

properties:
  stackSize: 64

Place the file at:

JSON

data/mynamespace/filament/item/ruby.json

YAML

data/mynamespace/filament/item/ruby.yml

Your datapack structure should look like this:

MyDatapack/
├── pack.mcmeta
├── data/
│   └── mynamespace/
│       └── filament/
│           └── item/
│               └── ruby.json
└── assets/
    └── mynamespace/
        └── textures/
            └── item/
                └── ruby.png

Automatically generated model

Instead of creating a separate model JSON manually, Filament can generate the item model automatically through the itemResource section.

The following fields:

JSON

{
  "itemResource": {
    "parent": "minecraft:item/generated",
    "textures": {
      "layer0": "mynamespace:item/ruby"
    }
  }
}

YAML

itemResource:
  parent: minecraft:item/generated
  textures:
    layer0: mynamespace:item/ruby

generate a model equivalent to:

{
  "parent": "minecraft:item/generated",
  "textures": {
    "layer0": "mynamespace:item/ruby"
  }
}

This means you only need to provide the texture file:

assets/mynamespace/textures/item/ruby.png

Giving the item

Reload the datapack and give yourself the item with:

/give @p mynamespace:ruby

References

• Filament item examples

• Example datapack: https://github.com/tomalbrc/filament/tree/main/example_datapack