Created README and FUNDING + update link to docs

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: songoda
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

README.md

@@ -1 +1,53 @@
+<!--suppress HtmlDeprecatedAttribute -->
+<div align="center">
+<img alt="EpicEnchants" src="https://cdn2.songoda.com/products/epicenchants/HmzkNQGNGNHbwBpF73mbEPQ0vXbpZr2YQl3hXiOE.gif">
+
 # EpicEnchants
+
+**Unlock the potential of your weapons, tools and armor by making your own custom enchants
+using this highly customizable and versatile advanced enchantment system.**
+
+<!-- Shields -->
+[![Discord](https://img.shields.io/discord/293212540723396608?color=7289DA&label=Discord&logo=discord&logoColor=7289DA)](https://discord.gg/songoda)
+[![Patreon](https://img.shields.io/badge/-Support_on_Patreon-F96854.svg?logo=patreon&style=flat&logoColor=white)](https://www.patreon.com/join/songoda)
+<br>
+[![Latest version](https://img.shields.io/github/v/tag/songoda/EpicEnchants?include_prereleases&label=Latest&logo=github&labelColor=black)](https://songoda.com/marketplace/product/67)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=songoda_EpicEnchants&metric=alert_status)](https://sonarcloud.io/dashboard?id=songoda_EpicEnchants)
+[![GitHub last commit](https://img.shields.io/github/last-commit/songoda/EpicEnchants?label=Last+commit)](https://github.com/songoda/EpicEnchants/commits)
+<br>
+[![bStats Servers](https://img.shields.io/bstats/servers/5287?label=Servers)](https://bstats.org/plugin/bukkit/EpicEnchants/5287)
+</div>
+
+## Table of Contents
+
+* [Introduction](#introduction)
+* [Marketplace](#marketplace)
+* [Documentation](#documentation)
+* [Support](#support)
+* [Suggestions](#suggestions)
+
+## Introduction
+
+`// TODO: Write an introduction`
+
+## Marketplace
+
+You can visit [our marketplace](https://songoda.com/marketplace/product/67) to download EpicEnchants as well as take a
+look at many other fantastic plugins which are sure to catch your eye.
+
+## Documentation
+
+You can find all the information about EpicAnchors, including dependencies, commands, permissions and incompatible
+plugins on [our wiki](https://wiki.songoda.com/Epic_Enchants).
+
+Feel free to also contribute to the wiki as a way to help others in the community with using the plugin.
+
+## Support
+
+If you encounter any issues while using the plugin, feel free to create a ticket
+on [our support desk](https://support.songoda.com).
+
+## Suggestions
+
+For suggestions about features you think should be added to the plugin to increase its functionality, feel free to
+create a thread over on [our feedback site](https://feedback.songoda.com).

src/main/resources/enchants/elite/AntiGravity.yml

@@ -20,7 +20,7 @@ description:
 item-whitelist:
   - "BOOTS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   POTION:
     # The trigger that will fire this effect.

src/main/resources/enchants/elite/Frozen.yml

@@ -21,7 +21,7 @@ description:
 item-whitelist:
   - "ARMOR"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   POTION:
     # The trigger that will fire this effect.

src/main/resources/enchants/elite/Healy.yml

@@ -30,7 +30,7 @@ description:
 item-whitelist:
   - "ARMOR"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   REMOVE_EFFECT:
     # The trigger that will fire this effect.

src/main/resources/enchants/elite/Poison.yml

@@ -20,7 +20,7 @@ description:
 item-whitelist:
   - "SWORDS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   POTION:
     # The trigger that will fire this effect.

src/main/resources/enchants/elite/RocketEscape.yml

@@ -20,7 +20,7 @@ description:
 item-whitelist:
   - "BOOTS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   THROW:
     # The trigger that will fire this effect.

src/main/resources/enchants/elite/Shocky.yml

@@ -32,7 +32,7 @@ description:
 item-whitelist:
   - "PICKAXE"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   SPAWN_TNT:
     # The trigger that will fire this effect.

src/main/resources/enchants/elite/Wither.yml

@@ -21,7 +21,7 @@ description:
 item-whitelist:
   - "ARMOR"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   POTION:
     # The trigger that will fire this effect.

src/main/resources/enchants/legendary/DeathBringer.yml

@@ -20,7 +20,7 @@ description:
 item-whitelist:
   - "AXES"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   POTION:
     # The trigger that will fire this effect

src/main/resources/enchants/legendary/DeathGod.yml

@@ -21,7 +21,7 @@ description:
 item-whitelist:
   - "HELMETS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   MODIFY_HEALTH:
     # The trigger that will fire this effect

src/main/resources/enchants/legendary/Drunk.yml

@@ -30,7 +30,7 @@ description:
 item-whitelist:
   - "ARMOR"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   POTION:
     # The trigger that will fire this effect.

src/main/resources/enchants/legendary/Enlightened.yml

@@ -20,7 +20,7 @@ description:
 item-whitelist:
   - "ARMOR"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   MODIFY_HEALTH:
     # The trigger that will fire this effect

src/main/resources/enchants/legendary/Gears.yml

@@ -20,7 +20,7 @@ description:
 item-whitelist:
   - "BOOTS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   POTION:
     # The trigger that will fire this effect.

src/main/resources/enchants/legendary/LifeSteal.yml

@@ -20,7 +20,7 @@ description:
 item-whitelist:
   - "SWORDS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   STEAL_HEALTH:
     # The trigger that will fire this effect

src/main/resources/enchants/legendary/Overload.yml

@@ -20,7 +20,7 @@ description:
 item-whitelist:
   - "ARMOR"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   POTION:
     # The trigger that will fire this effect.

src/main/resources/enchants/legendary/Resist.yml

@@ -20,7 +20,7 @@ description:
 item-whitelist:
   - "ARMOR"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   POTION:
     # The trigger that will fire this effect.

src/main/resources/enchants/legendary/SkillSwipe.yml

@@ -20,7 +20,7 @@ description:
 item-whitelist:
   - "SWORDS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   STEAL_EXP:
     # The trigger that will fire this effect

src/main/resources/enchants/simple/Aquatic.yml

@@ -20,7 +20,7 @@ description:
 item-whitelist:
   - "HELMETS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   POTION:
     # The trigger that will fire this effect

src/main/resources/enchants/simple/Confusion.yml

@@ -21,7 +21,7 @@ description:
 item-whitelist:
   - "HELMETS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   POTION:
     # The trigger that will fire this effect

src/main/resources/enchants/simple/Experience.yml

@@ -21,7 +21,7 @@ description:
 item-whitelist:
   - "TOOLS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   MODIFY_EXP:
     # Chance that this will happen

src/main/resources/enchants/simple/Glowing.yml

@@ -20,7 +20,7 @@ description:
 item-whitelist:
   - "HELMETS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   POTION-1:
     # The trigger that will fire this effect

src/main/resources/enchants/simple/Haste.yml

@@ -21,7 +21,7 @@ description:
 item-whitelist:
   - "TOOLS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   POTION:
     # The trigger that will fire this effect

src/main/resources/enchants/simple/Insomnia.yml

@@ -21,7 +21,7 @@ description:
 item-whitelist:
   - "SWORDS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   POTION-1:
     # Chance that this will happen

src/main/resources/enchants/simple/Lightning.yml

@@ -21,7 +21,7 @@ description:
 item-whitelist:
   - "BOWS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   LIGHTNING:
     # Chance that this will happen

src/main/resources/enchants/simple/Obliterate.yml

@@ -20,7 +20,7 @@ description:
 item-whitelist:
   - "WEAPONS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   THROW:
     # Chance that this will happen

src/main/resources/enchants/simple/Oxygenate.yml

@@ -21,7 +21,7 @@ description:
 item-whitelist:
   - "TOOLS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   POTION:
     # The trigger that will fire this effect

src/main/resources/enchants/ultimate/Blind.yml

@@ -21,7 +21,7 @@ description:
 item-whitelist:
   - "WEAPONS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   POTION:
     # The trigger that will fire this effect.

src/main/resources/enchants/ultimate/Dodge.yml

@@ -1,4 +1,4 @@
-author: "Songoda"
+author: "Songoda"
 
 # The enchant identifier must be unique.
 identifier: Dodge
@@ -21,7 +21,7 @@ description:
 item-whitelist:
   - "ARMOR"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   CANCEL_EVENT:
     # The trigger that will fire this effect

src/main/resources/enchants/ultimate/Fly.yml

@@ -22,7 +22,7 @@ item-whitelist:
   - "ARMOR"
   - "TOOLS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   FLY:
     # The trigger that will fire this effect

src/main/resources/enchants/ultimate/FoodSteal.yml

@@ -20,7 +20,7 @@ description:
 item-whitelist:
   - "SWORDS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   STEAL_FOOD:
     # The trigger that will fire this effect

src/main/resources/enchants/ultimate/StormFall.yml

@@ -20,7 +20,7 @@ description:
 item-whitelist:
   - "BOWS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   effects:
   LIGHTNING-1:

src/main/resources/enchants/unique/Berserk.yml

@@ -21,7 +21,7 @@ description:
 item-whitelist:
   - "AXES"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   POTION:
     # Chance that this will happen

src/main/resources/enchants/unique/Decapitation.yml

@@ -21,7 +21,7 @@ description:
 item-whitelist:
   - "AXES"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   DROP_HEAD:
     # Chance that this will happen

src/main/resources/enchants/unique/Explosive.yml

@@ -21,7 +21,7 @@ description:
 item-whitelist:
   - "BOWS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   EXPLODE:
     # Chance that this will happen

src/main/resources/enchants/unique/FeatherWeight.yml

@@ -21,7 +21,7 @@ description:
 item-whitelist:
   - "TOOLS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   POTION:
     # The trigger that will fire this effect

src/main/resources/enchants/unique/ObsidianDestroyer.yml

@@ -20,7 +20,7 @@ description:
 item-whitelist:
   - "PICKAXES"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   MODIFY_BLOCK:
     # The trigger that will fire this effect

src/main/resources/enchants/unique/PlagueCarrier.yml

@@ -21,7 +21,7 @@ description:
 item-whitelist:
   - "LEGGINGS"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   SPAWN_MOB:
     # The mob type.

src/main/resources/enchants/unique/Ragdoll.yml

@@ -21,7 +21,7 @@ description:
 item-whitelist:
   - "ARMOR"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   THROW:
     # Chance that this will happen

src/main/resources/enchants/unique/SelfDestruct.yml

@@ -20,7 +20,7 @@ description:
 item-whitelist:
   - "ARMOR"
 
-# For a full list of effects, please visit: https://docs.songoda.com/epic-series/epicenchants/tutorials
+# For a full list of effects, please visit: https://wiki.songoda.com/Epic_Enchants#Tutorials
 effects:
   SPAWN_TNT:
     # Trigger event that spawns the mob.