Created README and FUNDING + update link to docs

This commit is contained in:
Christian Koop 2021-07-10 23:41:42 +02:00
parent b6074e181b
commit 636103a71c
40 changed files with 103 additions and 39 deletions

12
.github/FUNDING.yml vendored Normal file
View File

@ -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']

View File

@ -1 +1,53 @@
<!--suppress HtmlDeprecatedAttribute -->
<div align="center">
<img alt="EpicEnchants" src="https://cdn2.songoda.com/products/epicenchants/HmzkNQGNGNHbwBpF73mbEPQ0vXbpZr2YQl3hXiOE.gif">
# EpicEnchants # 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).

View File

@ -20,7 +20,7 @@ description:
item-whitelist: item-whitelist:
- "BOOTS" - "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: effects:
POTION: POTION:
# The trigger that will fire this effect. # The trigger that will fire this effect.

View File

@ -21,7 +21,7 @@ description:
item-whitelist: item-whitelist:
- "ARMOR" - "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: effects:
POTION: POTION:
# The trigger that will fire this effect. # The trigger that will fire this effect.

View File

@ -30,7 +30,7 @@ description:
item-whitelist: item-whitelist:
- "ARMOR" - "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: effects:
REMOVE_EFFECT: REMOVE_EFFECT:
# The trigger that will fire this effect. # The trigger that will fire this effect.

View File

@ -20,7 +20,7 @@ description:
item-whitelist: item-whitelist:
- "SWORDS" - "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: effects:
POTION: POTION:
# The trigger that will fire this effect. # The trigger that will fire this effect.

View File

@ -20,7 +20,7 @@ description:
item-whitelist: item-whitelist:
- "BOOTS" - "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: effects:
THROW: THROW:
# The trigger that will fire this effect. # The trigger that will fire this effect.

View File

@ -32,7 +32,7 @@ description:
item-whitelist: item-whitelist:
- "PICKAXE" - "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: effects:
SPAWN_TNT: SPAWN_TNT:
# The trigger that will fire this effect. # The trigger that will fire this effect.

View File

@ -21,7 +21,7 @@ description:
item-whitelist: item-whitelist:
- "ARMOR" - "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: effects:
POTION: POTION:
# The trigger that will fire this effect. # The trigger that will fire this effect.

View File

@ -20,7 +20,7 @@ description:
item-whitelist: item-whitelist:
- "AXES" - "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: effects:
POTION: POTION:
# The trigger that will fire this effect # The trigger that will fire this effect

View File

@ -21,7 +21,7 @@ description:
item-whitelist: item-whitelist:
- "HELMETS" - "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: effects:
MODIFY_HEALTH: MODIFY_HEALTH:
# The trigger that will fire this effect # The trigger that will fire this effect

View File

@ -30,7 +30,7 @@ description:
item-whitelist: item-whitelist:
- "ARMOR" - "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: effects:
POTION: POTION:
# The trigger that will fire this effect. # The trigger that will fire this effect.

View File

@ -20,7 +20,7 @@ description:
item-whitelist: item-whitelist:
- "ARMOR" - "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: effects:
MODIFY_HEALTH: MODIFY_HEALTH:
# The trigger that will fire this effect # The trigger that will fire this effect

View File

@ -20,7 +20,7 @@ description:
item-whitelist: item-whitelist:
- "BOOTS" - "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: effects:
POTION: POTION:
# The trigger that will fire this effect. # The trigger that will fire this effect.

View File

@ -20,7 +20,7 @@ description:
item-whitelist: item-whitelist:
- "SWORDS" - "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: effects:
STEAL_HEALTH: STEAL_HEALTH:
# The trigger that will fire this effect # The trigger that will fire this effect

View File

@ -20,7 +20,7 @@ description:
item-whitelist: item-whitelist:
- "ARMOR" - "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: effects:
POTION: POTION:
# The trigger that will fire this effect. # The trigger that will fire this effect.

View File

@ -20,7 +20,7 @@ description:
item-whitelist: item-whitelist:
- "ARMOR" - "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: effects:
POTION: POTION:
# The trigger that will fire this effect. # The trigger that will fire this effect.

View File

@ -20,7 +20,7 @@ description:
item-whitelist: item-whitelist:
- "SWORDS" - "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: effects:
STEAL_EXP: STEAL_EXP:
# The trigger that will fire this effect # The trigger that will fire this effect

View File

@ -20,7 +20,7 @@ description:
item-whitelist: item-whitelist:
- "HELMETS" - "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: effects:
POTION: POTION:
# The trigger that will fire this effect # The trigger that will fire this effect

View File

@ -21,7 +21,7 @@ description:
item-whitelist: item-whitelist:
- "HELMETS" - "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: effects:
POTION: POTION:
# The trigger that will fire this effect # The trigger that will fire this effect

View File

@ -21,7 +21,7 @@ description:
item-whitelist: item-whitelist:
- "TOOLS" - "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: effects:
MODIFY_EXP: MODIFY_EXP:
# Chance that this will happen # Chance that this will happen

View File

@ -20,7 +20,7 @@ description:
item-whitelist: item-whitelist:
- "HELMETS" - "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: effects:
POTION-1: POTION-1:
# The trigger that will fire this effect # The trigger that will fire this effect

View File

@ -21,7 +21,7 @@ description:
item-whitelist: item-whitelist:
- "TOOLS" - "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: effects:
POTION: POTION:
# The trigger that will fire this effect # The trigger that will fire this effect

View File

@ -21,7 +21,7 @@ description:
item-whitelist: item-whitelist:
- "SWORDS" - "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: effects:
POTION-1: POTION-1:
# Chance that this will happen # Chance that this will happen

View File

@ -21,7 +21,7 @@ description:
item-whitelist: item-whitelist:
- "BOWS" - "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: LIGHTNING:
# Chance that this will happen # Chance that this will happen

View File

@ -20,7 +20,7 @@ description:
item-whitelist: item-whitelist:
- "WEAPONS" - "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: effects:
THROW: THROW:
# Chance that this will happen # Chance that this will happen

View File

@ -21,7 +21,7 @@ description:
item-whitelist: item-whitelist:
- "TOOLS" - "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: effects:
POTION: POTION:
# The trigger that will fire this effect # The trigger that will fire this effect

View File

@ -21,7 +21,7 @@ description:
item-whitelist: item-whitelist:
- "WEAPONS" - "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: effects:
POTION: POTION:
# The trigger that will fire this effect. # The trigger that will fire this effect.

View File

@ -1,4 +1,4 @@
author: "Songoda" author: "Songoda"
# The enchant identifier must be unique. # The enchant identifier must be unique.
identifier: Dodge identifier: Dodge
@ -21,7 +21,7 @@ description:
item-whitelist: item-whitelist:
- "ARMOR" - "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: effects:
CANCEL_EVENT: CANCEL_EVENT:
# The trigger that will fire this effect # The trigger that will fire this effect

View File

@ -22,7 +22,7 @@ item-whitelist:
- "ARMOR" - "ARMOR"
- "TOOLS" - "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: effects:
FLY: FLY:
# The trigger that will fire this effect # The trigger that will fire this effect

View File

@ -20,7 +20,7 @@ description:
item-whitelist: item-whitelist:
- "SWORDS" - "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: effects:
STEAL_FOOD: STEAL_FOOD:
# The trigger that will fire this effect # The trigger that will fire this effect

View File

@ -20,7 +20,7 @@ description:
item-whitelist: item-whitelist:
- "BOWS" - "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:
effects: effects:
LIGHTNING-1: LIGHTNING-1:

View File

@ -21,7 +21,7 @@ description:
item-whitelist: item-whitelist:
- "AXES" - "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: effects:
POTION: POTION:
# Chance that this will happen # Chance that this will happen

View File

@ -21,7 +21,7 @@ description:
item-whitelist: item-whitelist:
- "AXES" - "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: effects:
DROP_HEAD: DROP_HEAD:
# Chance that this will happen # Chance that this will happen

View File

@ -21,7 +21,7 @@ description:
item-whitelist: item-whitelist:
- "BOWS" - "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:
EXPLODE: EXPLODE:
# Chance that this will happen # Chance that this will happen

View File

@ -21,7 +21,7 @@ description:
item-whitelist: item-whitelist:
- "TOOLS" - "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: effects:
POTION: POTION:
# The trigger that will fire this effect # The trigger that will fire this effect

View File

@ -20,7 +20,7 @@ description:
item-whitelist: item-whitelist:
- "PICKAXES" - "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: effects:
MODIFY_BLOCK: MODIFY_BLOCK:
# The trigger that will fire this effect # The trigger that will fire this effect

View File

@ -21,7 +21,7 @@ description:
item-whitelist: item-whitelist:
- "LEGGINGS" - "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: effects:
SPAWN_MOB: SPAWN_MOB:
# The mob type. # The mob type.

View File

@ -21,7 +21,7 @@ description:
item-whitelist: item-whitelist:
- "ARMOR" - "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: effects:
THROW: THROW:
# Chance that this will happen # Chance that this will happen

View File

@ -20,7 +20,7 @@ description:
item-whitelist: item-whitelist:
- "ARMOR" - "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: effects:
SPAWN_TNT: SPAWN_TNT:
# Trigger event that spawns the mob. # Trigger event that spawns the mob.