structure-item-mod-fabric/README.md

26 lines
1.7 KiB
Markdown
Raw Normal View History

2020-04-19 22:59:14 +02:00
# Structure Item Mod (Fabric)
2021-03-31 22:32:08 +02:00
Started as a Fabric port of [structure-item-mod](https://github.com/QuImUfu/structure-item-mod).
Currently, the only supported version of the mod
2021-04-01 13:09:47 +02:00
Usage:
-------
This is an item capable of placing structures on right click:
2021-03-31 22:32:08 +02:00
```
2021-04-01 13:09:47 +02:00
structure_item:item{offset:{X:0,Y:5,Z:0},structure:"structure:mine",allowedOn:"minecraft:stone",blacklist:["minecraft:bedrock"],replaceEntities:0,placeEntities:0}
2021-03-31 22:32:08 +02:00
```
2021-04-01 13:09:47 +02:00
If the clicked block is Stone, no Bedrock and no entity is in the way, it will place the structure "structure:mine" excluding (potentially) saved Entities moved up by 5 blocks. (The low coordinate corner will start 5 blocks above the block you would have placed if this item were a block).
2021-03-31 22:32:08 +02:00
If you leave out "structure", it won't work.
2021-04-01 13:09:47 +02:00
If you leave out "offset", it will place the structure at the block you clicked at, expanding in your view direction, up and to both sides. if you look up or down, it'll place the structure centred above or below the block you clicked at.
2021-03-31 22:32:08 +02:00
If you leave out "blacklist", it will replace anything.
2021-04-01 11:57:58 +02:00
If you leave out "allowedOn", it will allow "placement" on any block.
2021-04-01 13:09:47 +02:00
If you leave out "replaceEntities" or set it to 1, it will allow placement even if non player entities are in the way of blocks (non structure voids). Those will get deleted.
If you leave out "placeEntities" or set it to 1, entities saved in the structure will be placed.
2021-03-31 22:32:08 +02:00
2021-04-01 13:09:47 +02:00
Error handling:
---------------
Errors made by the items' creator will be displayed in Chat, any errors made by the user will produce a fat massage in the middle of the screen.
2021-03-31 22:32:08 +02:00
2021-04-01 13:09:47 +02:00
Model & Localization:
---------------------
If you use this mod, you may want to change the model of the item (currently = stick) and edit the language file.