Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

🪑Furniture Mechanic

The furniture mechanic is the main way to implement custom furniture using Nexo. Below are an assortment of config file examples to help you in setting up your server.

Furniture Mechanic

myitem:
  itemname: "<gray>Table"
  material: PAPER
  Pack:
    model: default/table
  Mechanics:
    furniture:
      block_sounds:
        place_sound: block.stone.place
        break_sound: block.stone.break
        hit_sound: my.custom.hitsound     # Custom sound as defined in Nexo/sound.yml
        step_sound: my.custom.stepsound   # Requires a sound-file in the Nexo/pack-folder aswell
        fall_sound: my.custom.fallsound
      hitbox:
        barriers:
          - 0,0,0
      drop:
        silktouch: false
        # If no loots section is defined, will drop itself
        #loots:
        #  - { nexo_item: table, probability: 1.0 }

If you are unsure how to reference a ResourcePack-File in a NexoItem config; How do I reference a ResourcePack file in a config?

Furniture-Properties

Display Transform

The display_transform dictates how the model will be displayed. By default it is set to NONE, which will show it as it looks when you open the model in BlockBench. As some other plugins might use ArmorStands and add the furniture to its head, you can set this option to HEAD for the same effect. There is also: FIRSTPERSON_LEFTHAND, FIRSTPERSON_RIGHTHAND, FIXED, GROUND, GUI, THIRDPERSON_LEFTHAND, THIRDPERSON_RIGHTHAND. All of these will be displayed ingame as shown in BlockBench's Display Tab under the specified type. Look at Furniture Position for an example on FIXED (ItemFrame Position)

There is also a default_properties in mechanics.yml for changing the global default values of properties. These properties are applied first onto every furniture NexoItem, and any changes in the config itself would take priority

Tracking Rotation / Billboard

The tracking_rotation-property defines whether you want the furniture to "track" the player. This is mainly for stuff like billboard and leaderboards you want the player to see, not normal furniture. Options are: FIXED - No rotation VERTICAL - Pivots around vertical axis HORIZONTAL - Pivots around horizontal axis CENTER - Pivots around center point

Translation

The `translation`-property lets you offset the model of your furniture. Can be useful to adjust visually without editing the model-json itself Config should look like this:

Brightness

The brightness-property lets you override the vanilla lighting-values of the furniture. It has a block_light and sky_light property for the different types of lighting Minecraft has. Config should look like this:

Scale

The scale-property is a way to scale the furniture. It has a x, y and z property for scaling on each axis. Config should look like this:

view_range, shadow_radius, shadow_strength should be self-explanatory.

Furniture Culling

Display-Entities have a few properties one can use to tweak how the client culls the entities. This is by default in Nexo only set to cull based on distance from entity, not based on if it is "on-screen" or not. If you want to use a lot of furniture in a space, this might be good to optimize.

These settings can, as with all other Furniture-Propertiesbe set per-furniture, either in mechanics.yml under default_properties for global default, or in the furnitures properties.

display_width - Defines the width of the entity, which it would cull when outside of. Default is 0 display_height - Defines the height of the entity, which it would cull when outside of. Default is 0 view_range - Maximum view range of the entity. When the distance is more than view_range× entityDistanceScaling×64, the entity is not rendered. Defaults to 1.0.

Custom Sounds

Furniture, like custom blocks, can have custom sounds

All the volume and pitch values are set to be what Minecraft uses for blocks normally. If you want to change the volume or pitch, you can do so by using the format below. Keep in mind these two formats are compatible with eachother. We recommend just use the default one, but the option is there if you want to change it.

Custom Drops

By default a NexoFurniture will drop itself when broken. This can be changed if you want and customized with several properties.

minimal_type - Refers to a tier of material the drop will require. This can be WOODEN, STONE, IRON, GOLDEN, DIAMOND or NETHERITE. This also supports ItemType-Mechanic if it is specified in mechanics.yml tool_types list. If unspecified it is null, or no specific type required.

best_tool - Refers to the type of tool this drop requires, if any. This can be AXE, PICKAXE, SWORD, SHOVEL & HOE. If unspecified it is null, or no specific tool required.

Rotatable

To make a furniture rotatable, simply add the following to your item's config.

ModelEngine Furniture

To make use of a ModelEngine model as your furniture, simply add the following to your item's config:

Jukebox

Lets this furniture accept music discs and custom music discs which will be played. You can tweak the volume and pitch of the music from the jukebox. There is also a permission field, which can be used if you only want certain players to be able to play music from the jukebox. By default permission is blank, which means anyone can play music from the jukebox.

Restrict Rotation

You can restrict the amount of rotation-facings a furniture has with restricted_rotation. It can be set to STRICT or VERY_STRICT, with 8 and 4 facings respectively.\

Limited placing

You can customize what blocks a custom block/furniture can be placed on with limited_placing subsection. You can use the roof, floor and wall options to dictate where a block can be placed. By default, all are set to true. The type specifies if it should only be allowed on or denied on specific blocks. If type is ALLOW the block can only be placed on the given blocks. If the type is DENY can be placed on all blocks not matching the given blocks. There is also a radius_limitation option, which allows you to limit the amount of a certain furniture within a radius.

The block_tags can be found at this page. Useful if you want to allow/deny a group of blocks. The block_types are materials. Useful if you want to allow/deny a specific list block. The nexo_blocks are blocks/furniture from Nexo. This allows all custom blocks and furniture in here, but furniture requires a barrier-hitbox.

Storage

This is a sub-mechanic for furniture & noteblock mechanics, that let you make a custom storage container. Essentially a chest, closet or whatever you might want.

There's a few different types: STORAGE, PERSONAL, ENDERCHEST & DISPOSAL. STORAGE is similar to a normal chest. Anyone can open it and view the content of it. PERSONAL is essentially a custom enderchest, letting you edit the row-count and so on. ENDERCHEST is literally just the enderchest inventory, but letting you make a custom block/furniture to access it. DISPOSAL is a custom trashcan, letting you throw items in it, and they will be deleted when closed.\

Waterloggable

You can make furniture waterloggable when placed underwater by following the below. This mainly applies to the barrier-hitboxes of your furniture

BlockLocker

You can use this to allow protection via BlockLocker Valid protectionTypes are CONTAINER, DOOR, ATTACHABLE

PreviousDialogActionNextHitbox

Last updated