Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BJTMastermind committed Mar 15, 2023
1 parent ae5263d commit 8a0b09d
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@ To use the Custom Blocks API simply include it alongside your datapack and ensur
### Give Command
If your pack includes a custom give command this is what the function should look like with this API:
```mcfunction
give @p dropper{display:{Name:'{"text":"A Name","italic":false}',Lore:['{"text":"A Lore","italic":false,"color":"red"}']},CustomModelData:0000001,CustomModelDataVertical:0000002,BlockEntityTag:{Lock:"CustomBlocks:Block"},BlockProperties:{CustomName:'{"text":"Block"}',FrameModel:0000003,SetblockCommand:"setblock ~ ~ ~ stone"}}
give @p dropper{display:{Name:'{"text":"A Name","italic":false}',Lore:['{"text":"A Lore","italic":false,"color":"red"}']},CustomModelData:0000001,BlockEntityTag:{Lock:"CustomBlocks:Block"},BlockProperties:{CustomName:'{"text":"Block"}',SetblockCommand:"setblock ~ ~ ~ stone"}}
```
<!--<p align="center">You first put your placer block (Must be: Furnace, Dropper, or Dispenser as non rotating block) then spcify its properites like the display name, an option lore, the custom model data value, the lock <b>Must be CustomBlocks:Block</b> which tells the pack that its a custom block, then inside "BlockProperties" you add any extra info<br> to give the armor stand and set the base block for when placed in the world.</p>-->

To set up your custom blocks with this API simple add the custom models to one of the following blocks with "custom_model_data":

Expand All @@ -23,15 +22,15 @@ To set up your custom blocks with this API simple add the custom models to one o
<b>Make Sure To Include</b> the Lock in the BlockEntityTag and set its value to <b>"CustomBlocks:Block"</b><br>
This tells the API that your block uses this Custom Blocks API system.

Then add your custom block name and an optional lore for the block. Outside the display tag add your custom blocks CustomModelData value and optionaly the CustomModelDataVertical value too, which is the model for when its placed facing up or down.
Then add your custom block name and an optional lore for the block. Outside the display tag add your custom blocks CustomModelData value, optionally if your block can be placed in all 6 directions make sure your other 2 models for up and down directions have the correct id (Up = Base CustomModelData ID + 1, Down = Base CustomModelData ID + 2).

Finally, add any extra information about the block for when it's placed in the "BlockProperties" tag. All the information in this tag will be copied to the Glow Item Frame, the "SetblockCommand" in BlockProperties says what you want your base block to be, and "FrameModel" in BlockProperties says what the item should look like when placed in a item frame by the player.
Finally, add any extra information about the block for when it's placed in the "BlockProperties" tag. All the information in this tag will be copied to the Item Display, the "SetblockCommand" in BlockProperties says what you want your base block to be.

For help on how to set these up see the above give command for an example.

## Minimum Minecraft Version

* 1.17
* 1.19.4

## About This Project

Expand Down

0 comments on commit 8a0b09d

Please sign in to comment.