Public Vanity

+ Readme
+ Logo
+ Example Image
+ License

Author: JustKato

LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012-2023 Daniel Legt
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,41 @@
+# Damage Display
+![Logo](./media/logo.png)
+
+A Minecraft Spigot plugin that offers the possibility to keep track of damage dealt and received.
+
+# Features
+![Damage Example Showcase](./media/damage_01.png)
+ - Show a [TextDisplay](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/entity/TextDisplay.html) whenever an entity takes damage
+ - Send out ActionBar messages to players in regard to damage that has been taken.
+ - Display an ActionBar message whenever a player has dealt an amount of damage to an entity.
+
+# Installation
+1. Download the latest version of the DamageDisplay plugin
+2. Place the downloaded `.jar` file inside of your server's plugins directory
+3. Restart your server
+
+# Usage
+Whenever a player is going to take or deal an amount of damage, an ActionBar message is automatically going to be
+shown to the player in question. There is also another case when an entity takes an amount of damage, that damage will
+be displayed to anyone looking as a TextDisplay floating near the position that the damage has been taken at.
+
+# Permissions
+
+### damagedisplay.enabled  **( !! WIP !! )**
+- Description: Enables the ActionBar messages for the player 
+- Default: True
+
+### damagedisplay.command.info  **( !! WIP !! )**
+- Description: Enables the ActionBar messages for the player
+- Default: True
+
+### damagedisplay.command.toggle  **( !! WIP !! )**
+- Description: Enables the ActionBar messages for the player
+- Default: True
+
+# Support & Contribution
+In regard to possible bugs that might show up, please open an issue on the [Github Repository](https://github.com/JustKato/DamageDisplay).
+Contributions are more than welcome! Fork the repository, make your changes and submit a pull request.
+
+# License
+This project is licensed under the [MIT License](./LICENSE)