From b6fc9a86d3c480c637ea7ceb8541dc9d6bdc895c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Leon=20Gr=C3=BCnewald?= Date: Sun, 1 Sep 2019 20:31:03 +0200 Subject: [PATCH] Update 'README.md' --- README.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/README.md b/README.md index 8fce708..0eb0046 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,45 @@ # HeartContainersReloaded +## Setup + +Maven hasen't been added yet. I might do that in the future. For now just download the latest spigot api and add it to the project. + +## Configuration + +You can find the config inside `plugins/HeartContainersReloaded/config.yml` + +``` +# Set the default health +start_health: 20.0 +# Set the maximum health a player can reach +max_health: 30.0 + +# Configure the type of health that is going to be dropped +health_config: + + # Set the Entity which drops/gives the health to the killer + # Mob types can be found at + PLAYER: + # Sets how you get the heart (as a drop or direct) and how health is calculated. + health_type: "DIRECT_VALUE" + + # When using DIRECT_VALUE or DROP_VALUE health_value + # is dropped or added to the max health of the player + health_value: 0.5 + + # When using DIRECT_VAMPIRE or DROP_VAMPIRE (vampire_multiplicator * killed enemy health) + # is dropped or added to the player. + vampire_multiplicator: 0.5 + +# Example: +# drop_config: +# MOB_TYPE: +# health_type: DROP_VALUE | DROP_VAMPIRE | DIRECT_VALUE | DIRECT_VAMPIRE | NONE +# health_value: 0.5 +# vampire_multiplicator: 0.5 +# PIG: +# health_type: "DROP_VAMPIRE" +# vampire_multiplicator: 0.5 +``` + +All the entities can be found in the [Bukkit API Documentation](https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/entity/EntityType.html) \ No newline at end of file