From 17cd3276a372137bd5db9e230d1efe311504b674 Mon Sep 17 00:00:00 2001 From: Lightling Date: Fri, 13 Sep 2019 15:45:29 -0400 Subject: [PATCH] Update README.md --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d1a3a3a..4c723d6 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,30 @@ # GibsoniaCraft - A plugin created for a dorm Minecraft server + +## About + +GibsoniaCraft is a plugin created for a dorm Minecraft server. GibsoniaCraft is partially a remake from the ground up of BradzCraft (a plugin made for a previous dorm server) (Credit: [BradzTech](https://github.com/bradztech)). There are three goals behind GibsoniaCraft: +- To have a custom plugin with desired features for for an otherwise lightweight server +- To begin learning Java +- To begin learning Bukkit API (and subsequent derivatives (-> Spigot -> Paper)) + +## Features + +### Tools + +GibsoniaCraft tools based off of BradzCraft which extends [PowerTool](https://bitbucket.org/bloodyshade/powermining/src/default/) which is based off of [Tinkers' Construct](https://github.com/SlimeKnights/TinkersConstruct). + +#### Current Features + +- Excavator + - Digs in a 3x3 square based off of the targetted direction + - Crafted with four of a corresponding tool material in a circle surrounding a shovel +- Hammer + - Mines in a 3x3 square based off of the targetted direction + - Crafted with four of a corresponding tool material in a circle surrounding a pickaxe + +#### Current Issues + +- Does not account for enchantments + +## License +[MIT](LICENSE)