Block

Create a basic block config

We know that to create custom blocks, you need to utilize block states that, even when used, won't significantly impact the game. A good example of this is the note block.

We need to specify the original block state that we intend to replace. For the note block, this state includes the instrument, note, and powered status.

state:
  instrument: harp
  note: 0
  powered: false

If you find this too complicated, you can simplify the process by using a straightforward numeric ID, which the plugin will handle for you. The upper limit of the state is determined by the number of variants available for that particular block.

state: 0

You can use any parent model, which can be sourced from Minecraft's built-in models (such as minecraft:block/cube_all), or from your custom models (such as my_blocks:block/template).

blocks:
  spirit_log:
    behavior:
      directional: 3
      lit: {}
    events:
      interact:
        action_1:
          type: cycle_state
          value: lit
    states:
      axis=y,lit=false:
        base_block: note_block
        state:
          instrument: harp
          note: 0
          powered: false
        model:
          path: "minecraft:block/custom/spirit_log"
          generation:
            parent: "minecraft:block/cube_column"
            textures:
              "end": "minecraft:block/custom/spirit_log_top"
              "side": "minecraft:block/custom/spirit_log"
      axis=y,lit=true:
        base_block: note_block
        state:
          instrument: harp
          note: 1
          powered: false
        model:
          path: "minecraft:block/custom/spirit_log_lit"
          generation:
            parent: "minecraft:block/cube_column"
            textures:
              "end": "minecraft:block/custom/spirit_log_top"
              "side": "minecraft:block/custom/spirit_log_lit"
      axis=x,lit=false:
        base_block: note_block
        state:
          instrument: harp
          note: 2
          powered: false
        model:
          path: "minecraft:block/custom/spirit_log_horizontal"
          generation:
            parent: "minecraft:block/cube_column_horizontal"
            textures:
              "end": "minecraft:block/custom/spirit_log_top"
              "side": "minecraft:block/custom/spirit_log"
      axis=x,lit=true:
        base_block: note_block
        state:
          instrument: harp
          note: 3
          powered: false
        model:
          path: "minecraft:block/custom/spirit_log_lit_horizontal"
          generation:
            parent: "minecraft:block/cube_column_horizontal"
            textures:
              "end": "minecraft:block/custom/spirit_log_top"
              "side": "minecraft:block/custom/spirit_log_lit"
      axis=z,lit=false:
        base_block: note_block
        state:
          instrument: harp
          note: 4
          powered: false
        model:
          path: "minecraft:block/custom/spirit_log_mirrored"
          generation:
            parent: "minecraft:block/cube_column_mirrored"
            textures:
              "end": "minecraft:block/custom/spirit_log_top"
              "side": "minecraft:block/custom/spirit_log"
      axis=z,lit=true:
        base_block: note_block
        state:
          instrument: harp
          note: 5
          powered: false
        model:
          path: "minecraft:block/custom/spirit_log_lit_mirrored"
          generation:
            parent: "minecraft:block/cube_column_mirrored"
            textures:
              "end": "minecraft:block/custom/spirit_log_top"
              "side": "minecraft:block/custom/spirit_log_lit"

Link items to blocks

Unlike other plugins, in the design of this plugin, items and blocks are separated. Just like in Minecraft's design, some blocks appear as 2D items in the inventory but become 3D when placed. Some blocks look the same before and after placement, while others, like the End Portal block, do not even have a corresponding item form.

2D item becomes 3D in block form

No item linked to this block

item looks the same as the block

You will notice that in this case, the item is also called spirit_log, but this does not conflict with the spirit_log in the block configs because these two IDs are essentially registered in different registries.

items:
  spirit_log:
    material: paper
    custom-model-data: 1000
    data:
      display-name: "<lang:block.spirit_log>"
    model:
      path: "minecraft:item/custom/spirit_log"
      generation:
        parent: "minecraft:block/custom/spirit_log"
    behavior:
      placeable_block:
        block: default:spirit_log

In this example, we created an item associated with the block, and its model inherits from the block's model, so it appears the same as the block. Here, we utilized the placeable_block behavior, which is one of the default behaviors provided by the plugin, offering a block placement mechanism similar to the vanilla Minecraft system. Of course, there are many other types of mechanisms available, including custom ones registered through the api, to suit various needs.