diff --git a/guide/docs/extensions/img/sword.png b/guide/docs/extensions/img/sword.png new file mode 100644 index 00000000..9d2d4bfb Binary files /dev/null and b/guide/docs/extensions/img/sword.png differ diff --git a/guide/docs/extensions/itemBuilder.md b/guide/docs/extensions/itemBuilder.md new file mode 100644 index 00000000..4a119d77 --- /dev/null +++ b/guide/docs/extensions/itemBuilder.md @@ -0,0 +1,27 @@ +## Create an itemStack + +Spigots ItemBuilder is often painful to use and confusing, especially for beginners. + +With KSpigot itemBuilders you have an easy to use ItemBuilder and you don“t have to worry about things like itemMeta again. + + +### Create a simple item +```kotlin +val sword = itemStack(Material.GOLDEN_SWORD) { + amount = 3 + addEnchantment(Enchantment.KNOCKBACK, 2) + meta { + name = "${KColors.GOLD}Magic Sword" + isUnbreakable = true + addLore { + + "This sword is truly special." + + "Try it!" + } + customModel = 1001 + flag(ItemFlag.HIDE_UNBREAKABLE) + } +} +``` +### This results in following item + +![](img/sword.png) diff --git a/guide/mkdocs.yml b/guide/mkdocs.yml index 7ec62e4a..ee27ddd7 100644 --- a/guide/mkdocs.yml +++ b/guide/mkdocs.yml @@ -37,3 +37,4 @@ nav: - Extensions: - Event listener: extensions/listener.md - Tasks: extensions/tasks.md + - Item Builder: extensions/itemBuilder.md