diff --git a/README.md b/README.md index 3539e6e..efd7cef 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,22 @@ # CodFrame +A simple ItemFrame protect and in-frame item preview plugin. + +**This is a PAPER only plugin, can run on [Paper](https://papermc.io/), or Paper's fork like [Purpur](https://purpurmc.org/) only! DO NOT INSTALL ON SPIGOT!** + +**This plugin require Java 17 and up to be run.** + +## Why CodFrame + +CodFrame can protect your items in itemframe to avoid grief like explosion, shoot, lava, fire, block break, interact, rotate. + +Also provide a cool and useful item-showcase feature to allow any player preview your awesome armor/weapon, or read your book without take out from ItemFrame! + ## Command -`/codframe` - Set a ItemFrame to CodFrame. +`/codframe` - Set or remove a CodFrame when you looking at a ItemFrame. ## Permission - -`codframe.admin` - Permission to bypass the owner check, force remove any exists CodFrame. +`codframe.admin` - Bypass the owner check, force remove a exists CodFrame. ## Demo Video