Created README and LICENSE.md

LICENSE.md

@@ -0,0 +1,36 @@
+# ECOENCHANTS LICENSE
+
+
+## Version 1.0, August 2020
+
+
+## Definitions
+
+"Package" refers to the collection of files (unless something else is indicated inside the file) distributed
+by the Copyright Holder, and derivatives of that collection of files created through textual modification.
+
+"Copyright Holder" is whoever is named in the copyright or copyrights for the package.
+
+"You" is you, if you're thinking about copying or distributing this Package.
+
+
+## Copyright (C) 2020 Will Favier-Parsons
+
+You are not allowed to redistribute full, partial or modified versions of the package to which the license 
+is associated. This license does not apply to modules or extensions that use but do not contain full, 
+partial or modified code from this package.
+
+
+## ECOENCHANTS LICENSE
+### TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+1. Do whatever you like with the original work, as long as you keep it for yourself or have the Copyright
+Holder's permission.
+
+2. You are not allowed to redistribute full, partial or modified versions of the package
+
+3. Code is provided with no warranty. You have the right (and are even encouraged) to propose improvements
+to the package as long as you don't use it as a way to circumvent the restrictions of the license.
+
+4. By proposing a modification you agree to assign all your rights on your code to the Copyright Holder.
+You must therefore own the modifications you propose or have the permission to assign their rights.

Plugin/src/main/java/com/willfp/ecoenchants/loader/Loader.java

@@ -88,7 +88,6 @@ public class Loader {
         Bukkit.getLogger().info("Loading Configs...");
         ConfigManager.updateConfigs();
         EnchantDisplay.update();
-        Main.getInstance().saveResource("README.txt", true);
         Bukkit.getLogger().info("");
 
         /*

Plugin/src/main/resources/README.txt

@@ -1,57 +0,0 @@
-Thanks for purchasing EcoEnchants!
-
-Some of the config can get quite confusing, so here's a little guide.
-
-Enchantment-Specific config files are in their respective folders related to their type.
-Or, more simply: curses are stored in /curse, artifacts are stored in /artifact
-
-If you want to disable an enchantment, set everything in obtaining to false, like this:
-obtaining:
-  table: true
-  villager: true
-  loot: true
-  rarity: rare
-
-You can set the rarity to any valid rarity, but you must still specify one.
-
----------------- TARGETS ----------------
-
-Some enchantments support modifying/refining their targets.
-Targets are the items that the enchantment can be applied to.
-
-You can specify a target like this:
-
-general-config:
-  target:
-    - material
-    - material2
-
-A list of available materials can be found here: https://hub.spigotmc.org/javadocs/spigot/org/bukkit/Material.html
-
-Most users won't need to modify targets, however it is recommended that the modified target is a subset of the original target.
-For example, a helmet enchantment can be refined to only gold helmets, a bow enchantment can be specified to work on a crossbow, and a sword enchantment can be specified to work on axes.
-
-** IMPORTANT **
-Piece-specific armor enchants will only work on their default piece.
-An example of this is sating, a helmet enchantment.
-Specifying sating to work on boots will allow boots to be enchanted, however the sating effect WILL NOT WORK.
-The only exception to this rule is magnetic, which can be specified to work on any piece of armor.
-
-Putting this into context:
-Dexterous can, by default, be applied to all swords and axes.
-However, maybe you want it to only be applied to diamond and netherite swords.
-So, add this to general-config:
-
-target:
-  - diamond_sword
-  - netherite_sword
-
-Another example:
-Hook, by default, can only be applied to bows.
-If you want it to be applicable to crossbows as well, simply set the target to this:
-
-target:
-  - bow
-  - crossbow
-
-It is worth mentioning that bow/crossbow enchantments will not work on tridents.``

README.md

@@ -1,8 +1,36 @@
-# EcoEnchants
+<h1 align="center">
-Custom Enchantments Plugin for Minecraft version 1.15 and higher
+  <br>
+  <img src="https://plugins.willfp.com/ecoenchants/logo.png" alt="EcoEnchants logo" width="256">
+  <br>
+</h1>
 
-## Learn More:
+<h4 align="center">Source code for EcoEnchants, a premium spigot plugin.</h4>
-[Information about the plugin is available here](https://www.spigotmc.org/resources/EcoEnchants.79573// "EcoEnchants on Spigot")
 
-## Docs:
+<p align="center">
-[The documentation is available here](https://ecoenchants.willfp.com/ "Documentation")
+    <a href="https://www.spigotmc.org/resources/ecoenchants.79573/">
+        <img alt="spigot" src="https://img.shields.io/badge/spigot-ecoenchants-brightgreen?style=for-the-badge"/>
+    </a>
+    <a href="https://bstats.org/plugin/bukkit/EcoEnchants" alt="bstats servers">
+        <img src="https://img.shields.io/bstats/servers/7666?color=brightgreen&style=for-the-badge"/>
+    </a>
+    <a href="https://bstats.org/plugin/bukkit/EcoEnchants" alt="bstats players">
+        <img src="https://img.shields.io/bstats/players/7666?color=brightgreen&style=for-the-badge"/>
+    </a>
+    <a href="https://ecoenchants.willfp.com/" alt="Docs (gitbook)">
+        <img src="https://img.shields.io/badge/docs-gitbook-brightgreen?style=for-the-badge&logo=appveyor"/>
+    </a>
+    <a href="https://discord.gg/ZcwpSsE/" alt="Discord">
+        <img src="https://img.shields.io/discord/452518336627081236?label=discord&style=for-the-badge"/>
+    </a>
+</p>
+
+
+![Title](https://i.imgur.com/O08LBOR.png)
+![Features](https://i.imgur.com/nrBvTlm.png)
+![Docs](https://i.imgur.com/3LzH2tB.png)
+![Compatibility](https://i.imgur.com/jMHT1rF.png)
+
+## License
+*Click here to read [the entire license](https://github.com/Auxilor/EcoEnchants/blob/master/LICENSE.md).* 
+
+EcoEnchants is not freeware. In order to use it you must purchase a license on [spigotmc.org](https://spigotmc.org).