EN_GettingStarted - MMonkeyKiller/CustomBlocks GitHub Wiki

Getting Started

Now you have the plugin installed and running, we're going to start using it

Commands

CustomBlocks has an small command list to start working with it

Command Aliases Description Perms
/customblocks <reload | add <id> <itemModelData> <instrument> <note> <powered>> /cb Plugin main command customblocks.command.customblocks
/cblocks /cbks Custom Block GUI Selector customblocks.command.cblocks

Command: customblocks (cb)

  • /customblocks reload 👉 Reload config
  • /customblocks add <id> <itemModelData> <instrument> <note> <powered> 👉 Creates a temp. block (if you want to create a persistent block configure it on /CustomBlocks/config.yml)

Command: cblocks (cbks)

  • /cblocks 👉 Open a menu with all the available custom blocks

Configuration

Prefixes & GUI Title

prefixes:
  prefix: "&eCustomBlocks&8> &7"  # Main prefix
  warn: "&eWarning &8> &7"  # Warning prefix
gui_title: "&6Custom Blocks GUI"  # Custom Block Selection GUI Title

The configuration file can be found at /CustomBlocks/config.yml, we're going to explain all the cofigurable options

Blocks

blocks: # Custom Block list
  - id: "customblocks:example" # custom block id
    itemModelData: 1001 # itemModelData of block item
    cbItem: GUNPOWDER   # (optional) Sets the item material used for the custom block
    instrument: BANJO #
    note: 1 #           instrument, note y powered are the options to set the texture to the block
    powered: false #

Item Material

cb_item_material: PAPER # The item material used to make all the Custom Block items, this can be overwritted by the cbItem block propierty

Clickable Materials

clickable_materials:
  [
    DARK_OAK_WALL_SIGN,
    DARK_OAK_DOOR,
    SPRUCE_SIGN,
    OAK_WALL_SIGN,
    CRIMSON_TRAPDOOR,
    TRAPPED_CHEST,
    DARK_OAK_TRAPDOOR,
    WARPED_SIGN,
    BIRCH_TRAPDOOR,
    JUNGLE_DOOR,
    JUNGLE_TRAPDOOR,
    OAK_TRAPDOOR,
    SMITHING_TABLE,
    COMMAND_BLOCK,
    JUNGLE_SIGN,
    ACACIA_WALL_SIGN,
    JUNGLE_WALL_SIGN,
    CRIMSON_BUTTON,
    ENDER_CHEST,
    STONE_BUTTON,
    OAK_SIGN,
    BIRCH_SIGN,
    CRIMSON_SIGN,
    BIRCH_DOOR,
    BREWING_STAND,
    SPRUCE_WALL_SIGN,
    CRAFTING_TABLE,
    LECTERN,
    BIRCH_WALL_SIGN,
    ACACIA_DOOR,
    ACACIA_SIGN,
    WARPED_BUTTON,
    SPRUCE_BUTTON,
    ACACIA_TRAPDOOR,
    WARPED_DOOR,
    ENCHANTING_TABLE,
    ACACIA_BUTTON,
    OAK_BUTTON,
    BIRCH_BUTTON,
    SPRUCE_DOOR,
    REPEATING_COMMAND_BLOCK,
    CRIMSON_WALL_SIGN,
    SPRUCE_TRAPDOOR,
    POLISHED_BLACKSTONE_BUTTON,
    DARK_OAK_BUTTON,
    WARPED_WALL_SIGN,
    DARK_OAK_SIGN,
    CHEST,
    CRIMSON_DOOR,
    JUNGLE_BUTTON,
    CARTOGRAPHY_TABLE,
    WARPED_TRAPDOOR,
    OAK_DOOR,
    LEVER,
    CHAIN_COMMAND_BLOCK,
  ]
# Material block list that you can still interact with it without shifting (with a custom block in your hand)

Debug Mode

debug_mode: false # It has the latest experimental features, use as your own risk
# Actually it has integration with WorldEdit and a debug method for an issue with block break

Before making any issue post, please check if your config.yml is in a valid syntax, and please dont use TAB inside it.

⚠️ **GitHub.com Fallback** ⚠️