diff --git a/docs/API.md b/docs/API.md new file mode 100644 index 0000000..0770b25 --- /dev/null +++ b/docs/API.md @@ -0,0 +1,33 @@ +# API + +## How to add a new Kit +### Step 1: +Open `kits.lua`. +### Step 2: Append this code to the end. +```lua +kitpvp.api.register_kit({ + name = "KIT_NAME", + items = { + item("ITEM_NAME", COUNT, {ENCHANTMENT = LEVEL, ENCHANTMENT = LEVEL}), + item("ITEM_NAME", COUNT, {ENCHANTMENT = LEVEL, ENCHANTMENT = LEVEL}), + item("ITEM_NAME", COUNT, {ENCHANTMENT = LEVEL, ENCHANTMENT = LEVEL}) + }, + armor = ARMOR_TYPE, + armor_enchantments = {{HELMET_ENCHANTMENT = LEVEL}, {CHESTPLATE_ENCHANTMENT = LEVEL}, {LEGGINGS_ENCHANTMENT = LEVEL}, {BOOTS_ENCHANTMENT = LEVEL}} +}) +``` +Replace: +* `KIT_NAME` +* `ITEM_NAME` +* `COUNT` +* `ENCHANTMENT` +* `LEVEL` +* `ARMOR_TYPE` +* `HELMET_ENCHANTMENT` +* `CHESTPLATE_ENCHANTMENT` +* `LEGGINGS_ENCHANTMENT` +* `BOOTS_ENCHANTMENT` + +with their corresponding values. diff --git a/docs/KITS.md b/docs/KITS.md new file mode 100644 index 0000000..8fd8d4a --- /dev/null +++ b/docs/KITS.md @@ -0,0 +1,53 @@ +# Kits + +## Kits +* Tank +* Archer +* Speedrunner +* Blaze +* Elytrian +* Spy +* Blaster + +## Items +### Tank +* Iron Sword - Sharpness I +* Iron Armor - Protection I +### Archer +* Stone Sword - Sharpness I +* Bow - Infinity +* Arrow +* Gold Armor - Protection I +### Speedrunner +* Stone Sword - Sharpness I +* Potion of Swiftness - Extended +* Gold Armor - Protection I +### Blaze +* Iron Sword - Sharpness I, Fire Aspect II +* Gold Armor - Fire Protection V +### Elytrian +* Iron Sword - Sharpness I +* Elytra +* Rocket - 50 +* Golden Apple +* Bread - 20 +* Bow +* Arrow - 20 +* Leather Armor - Protection I +### Spy +* Stone Sword - Protection I +* Potion of Invisibility - 2 +* Potion of Night Vision - 2 +* Iron Armor - Protection I +### Blaster +* TNT - 4 +* Redstone Dust - 64 +* Redstone Repeater - 64 +* Stone Button - 4 +* Stone Pressure Plate - 4 +* Iron Helmet - Protection I +* Iron Chestplate - Protection III +* Iron Leggings - Protection II +* Iron Boots - Protection I