QuImUfu/structure-item-mod-fabric
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix and improve README

Browse Source
This commit is contained in:
QuImUfu 2021-04-01 13:09:47 +02:00
parent 9bfae0751b
commit 8f0c9fdf56
1 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -2,19 +2,25 @@
Started as a Fabric port of [structure-item-mod](https://github.com/QuImUfu/structure-item-mod).
Currently, the only supported version of the mod
## Example Usage
Usage:
-------
This is an item capable of placing structures on right click:
```
/give User structure_item:item{offset: [I; 0, 5, 0],structure: "structure:mine",allowedOn: "minecraft:stone",blacklist:["minecraft:bedrock"], replaceEntities:0, placeEntities:0} 1
structure_item:item{offset:{X:0,Y:5,Z:0},structure:"structure:mine",allowedOn:"minecraft:stone",blacklist:["minecraft:bedrock"],replaceEntities:0,placeEntities:0}
```
And tada, you have an item capable of placing structures on right click.
If the clicked block is Stone and neither Diamond blocks nor Bedrock is in the way, it will place the structure "structure:mine" 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). Blocks (non structure voids) delete intersecting entities.
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).
If you leave out "structure", it won't work.
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 centered above or below the block you clicked at.
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.
If you leave out "blacklist", it will replace anything.
If you leave out "allowedOn", it will allow "placement" on any block.
If you leave out "replaceEntities" or set it to 1, entities in the way will be deleted.
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.
Any errors made by the creators will be displayed in chat, any errors made by the user will produce a fat massage in the middle of the screen.
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.
If you use this mod, you may want to change the model of the item (currently = stick) and fix the language file.
Model & Localization:
---------------------
If you use this mod, you may want to change the model of the item (currently = stick) and edit the language file.