Update documentation

Updated various files that can only be best described as documentation. Made the readme more new-user friendly. Updated the changelog... The previous changes don't exist ;)
JoshMullins · Mar 4, 2017 · 790bb99 · 790bb99
1 parent 215be47
commit 790bb99
Show file tree

Hide file tree

Showing 3 changed files with 71 additions and 35 deletions.
diff --git a/README.md b/README.md
@@ -2,29 +2,58 @@ MVP Gadgets
 ------------
 A centralized server administration plugin including player punishment administration, player donor perks, and much more.
 
-### Owners:
-[TGRHavoc](https://github.com/TGRHavoc)
-[JoshMullins](https://github.com/JoshMullins)
-
-
-### Features:
-
-1. Personalized Chat Configuration (i.e. The ability to change response messages when equipping, un-equipping, and purchasing gadgets.) **DONE** [(See #21)](https://github.com/JoshMullins/MVPGadgets/pull/21/)
-2. GUI Menu Configuration (i.e. The ability to change the names of the items in the GUI.) **DONE** [(See #21)](https://github.com/JoshMullins/MVPGadgets/pull/21)
-3. Permission Per Gadget (i.e. The requirement of a permission to use a certain gadget.) **DONE** [(See #26)](https://github.com/JoshMullins/MVPGadgets/pull/26/)
-4. Mob Cannon (Allow player to launch mobs at random or allow them to select the mob) - **DONE** [(See #17)](https://github.com/JoshMullins/MVPGadgets/pull/17)
-5. Paintball Gun (ex. A horse amour being right clicked towards blocks and temporarily changing the block into a colored wool.) **DONE** [(See #26)](https://github.com/JoshMullins/MVPGadgets/pull/26/)
-6. Melon Bomb (ex. The dropping/throwing of a melon and it exploding into glistening melons.)
-7. Flame Thrower (ex. A item exerting fire towards other players, mobs, or ground.)
-8. Black Hole (ex. A collection of black and grey particles to symbolize a black hole.)
-9. Disguises **DONE**[(See #29)](https://github.com/JoshMullins/MVPGadgets/pull/29)
+## Prerequisites
+
+In order to use this plugin, you will need to have a Spigot/Bukkit server.
+
+This plugin doesn't require any other plugins to be installed to function.
+If you want to give the Gadgets prices, you will need to have [Vault](https://dev.bukkit.org/projects/vault) installed.
+
+## Installing
+
+1. Download the latest JAR file from the [releases page](https://github.com/JoshMullins/MVPGadgets/releases) for your server version.
+2. Move the JAR file into the plugins folder.
+
+That's it, you have now installed MVPGadgets :smile:.
+When you start your server, you should see something like the image below in the console
+![Console output](http://i.imgur.com/3mPSH8b.png)
+
+
+## Contributing
+
+1. Fork it!
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Submit a pull request :grin:
+
+## Features:
+
+1. Personalized Chat Configuration
+2. GUI Menu Configuration
+3. Permission Per Gadget
+4. Mob Cannon (Allow player to launch mobs at random or allow them to select the mob)
+5. Paintball Gun
+9. Mob Disguises
 10. Mounts:
-  1. Normal Horse, (RightClick: The horse will despawn and an explosion of leather will occur.) - **DONE** [(See #21)](https://github.com/JoshMullins/MVPGadgets/pull/21)
-  2. Skeleton Horse, (RightClick: The horse will despawn and an explosion of bone will occur.) - **DONE** [(See #21)](https://github.com/JoshMullins/MVPGadgets/pull/21)
-  3. Zombie Horse, (RightClick: The horse will despawn and an explosion of rotten flesh will occur.) - **DONE** [(See #21)](https://github.com/JoshMullins/MVPGadgets/pull/21)
-11. Vault intergration **DONE** [(See #26)](https://github.com/JoshMullins/MVPGadgets/pull/26)
-12. Customizable description for the gadgets inside the GUI. **DONE** [(See #26)](https://github.com/JoshMullins/MVPGadgets/pull/26)
-
-### Additional Features
-1. Server Player Administration Panel; including the ability to mute, kick, tempban, and ban players. Possible dependecies. Bungeecord capibilty/ability to make punishments through networked servers?
-2. 
+  1. Normal Horse
+  2. Skeleton Horse
+  3. Zombie Horse
+11. Vault integration
+12. Customizable description for the gadgets inside the GUI.
+
+## Authors
+
+* **Josh Mullins** - *Inital work* - [JoshMullins](https://github.com/JoshMullins)
+* **Jordan Dalton** - *Various gadgets* - [TGRHavoc](https://github.com/TGRHavoc)
+* **Luke Fuller** - ** - [ldfuller01](https://github.com/ldfuller01)
+
+
+See also a list of [contributors](https://github.com/JoshMullins/MVPGadgets/contributors) who participated in this project.
+
+
+### TODO
+- Server Player Administration Panel; including the ability to mute, kick, tempban, and ban players. Possible dependencies. Bungeecord capability/ability to make punishments through networked servers?
+- Melon Bomb (ex. The dropping/throwing of a melon and it exploding into glistening melons.)
+- Flame Thrower (ex. A item exerting fire towards other players, mobs, or ground.)
+- Black Hole (ex. A collection of black and grey particles to symbolize a black hole.)
diff --git a/changelog.md b/changelog.md
@@ -1,6 +1,14 @@
 ChangeLog - Please create an issue to log your changes.
 =====
 
+### v1.4.0
+###### Date: 04-Mar-2017
+###### Developer: TGRHavoc
+- Fix package declaration for MobCannon
+- Update PaintballListener for 1.11
+- Add PaintballHandler for 1.11
+- Update Disguise to 1.11
+
 ### Bukkit 1.8.x Release
 ###### Date: 05-Oct-2016
 ###### Developer: TGRHavoc
@@ -68,22 +76,22 @@ removes disguise.
   - PRICE: The price of the gadget.
   - PERMISSION: Permission message (As suggested by @JoshMullins)
   - HAS_PERMISSION: Allows the server owner to change what is displayed when the user does/doesn't have permission for the gadget.
--plugin.yml 
+-plugin.yml
   - Added "authors" to credit the developer that have contributed to the plugin (Feel free to add anyone I've missed out)
   - Added "softdepend" for vault intergration
   - Added "Gadget_Prices" so owner can change prices of gadgets.
-- config.yml 
+- config.yml
   - Added "vault" to allow the server owner to enable/disable vault integration as they wish.
-- MVPGadgets.java 
+- MVPGadgets.java
   - Added vault hook.
   - If you want to check if Vaults is enabled/has been hooked then do MVPGadgets#hookedVault() this will return a Boolean (False if server owner has set config to false/Vault isn't installed) - I will add another check to see if it's a vault problem or if config is set to false.
   - Added methods getGadgetPrice(Gadget) and getGadgetPrice(String) to get prices of gadgets.
-- Gadgets.java 
+- Gadgets.java
   - Added a method to get the GUI item for the gadget (This has description, permission and price (If enabled) added to it).
   - Added some more string to help getting certain paths in configs.
-- ReadMe.md 
+- ReadMe.md
   - Updated to include extra features added
-- .classpath 
+- .classpath
   - Added the vault as a lib
 - players cannon use a gadget without permission (mvpgadgets.<gadgetName> (gadgetName is defined in the gadget class))
 - Add the "purchasing" mechanism
@@ -126,7 +134,7 @@ removes disguise.
 ### Multiple updates to MobCannon.java
 ###### Date: 12-Feb-2015
 ###### Developer: AdamQpzm
-- Update new lines - It's generally not conventional to have so many new lines. It's also not consistent with the other files in the project. There seems to be a new blank line after most, if not all, lines. I've removed a lot of the unnecessary blank lines, and have left some in to aid in readability. 
+- Update new lines - It's generally not conventional to have so many new lines. It's also not consistent with the other files in the project. There seems to be a new blank line after most, if not all, lines. I've removed a lot of the unnecessary blank lines, and have left some in to aid in readability.
 - Update the fields to be private and not needlessly static - This is another simple one. Convention dictates the correct use of access modifiers. Since I didn't really see a reason any of the fields should be public (and certainly not public and non-final) I made them private. There was also a static field - static should only really be used when there's a good reason for it (and the main reason being immutable constants). Since a good reason for this wasn't clear, I removed it.
 - Updated EntityType map in simple constructor - The way the EntityType map was set up before was using the same HashSet for every EntityType. So far as I could tell, this was meant to represent mob aliases. Using the same Object for that doesn't really make sense - if at any point one tries to add a mob alias, then the alias will be applied to every EntityType (as it uses the same Object). I also altered the system to loop over an array of EntityTypes to reduce code duplication - this also makes it easier to add an EntityType at any point - simply add the EntityType to the array.
 - Added null check for constructor - It makes more sense to throw an IllegalArgumentException with a helpful message than to just include in the JavaDocs comment not to pass null values. At best, that approach would cause NPEs to be thrown and would be harder to debug for develoers. At worst, it could cause even more damage to other parts.
@@ -181,7 +189,7 @@ removes disguise.
   - All per-mob launch permission: mvpgadgets.launchmob.all
   - Per-mob launch permssions: mvpgadgets.launchmob.mob_name (all lower case)
   - Random mob launch permission: mvpgadgets.launchmob.random
-  
+
 ### Update HorseListener.java
 ###### Date: 2-Dec-2014
 ###### Developer: 97WaterPolo
@@ -198,4 +206,3 @@ removes disguise.
   - Abstract gadget class was created
   - GUIGadget was created (Allows players to select a gadget)
   - Horse gadget was created
-
diff --git a/plugin.yml b/plugin.yml
@@ -1,6 +1,6 @@
 main: ovh.tgrhavoc.mvpgadgets.MVPGadgets
 name: MVPGadgets
-version: 1.3.0
+version: 1.4.0
 softdepend: [Vault]
 authors: [pookeythekid, TGRHavoc, JoshMullins, 97WaterPolom, TheFreakLord, AdamQpzm]