Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
BJTMastermind authored Aug 19, 2021
1 parent dead8c2 commit 1b9b3aa
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@

## Plan To Add / To Do

- [ ] Replace Armor Stands with Glow Item Frames in 1.17+
- [x] Replace Armor Stands with Glow Item Frames in 1.17+

## How To Use
To use the Custom Blocks API simply include it alongside your datapack and ensure to use the following for your custom blocks.

### 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,BlockEntityTag:{Lock:"CustomBlocks:Block"},BlockProperties:{CustomName:'{"text":"Block"}',SetblockCommand:"setblock ~ ~ ~ stone"}}
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"}',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>-->

Expand All @@ -27,15 +27,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. Add your custom blocks CustomModelData value<br> outside the display tag.
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.

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 Armor Stand, and the "SetblockCommand" in BlockProperties says what you want your base block to be.
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, and 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.16.4 (May work in older versions as low as 1.15.2 but has not been tested)
* 1.17

## About This Project

Expand Down

0 comments on commit 1b9b3aa

Please sign in to comment.