Merge pull request #8 from TechDudie/documentation

Documentation
master
Code-Sploit 2021-05-20 09:26:03 +00:00 committed by GitHub
commit ea38bdadd2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 86 additions and 0 deletions

33
docs/API.md Normal file
View File

@ -0,0 +1,33 @@
# API
<!--
Remeber to add any new functionality to the API here.
-->
## 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.

53
docs/KITS.md Normal file
View File

@ -0,0 +1,53 @@
# Kits
<!--
When you add a new kit, make sure to list it HERE.
-->
## 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