MC Plugin ⚔ Heroes Premium ⚔ BEST MINECRAFT & SPIGOT RPG PLUGIN EVER 1.10.9 Alpha

The best class, race and skill Minecraft RPG plugin for Minecraft servers

Patch Notes
Version 1.10.9

• Merged 1.10.9-update branch into dev.
• Updated Internal Version: Ensured internal versioning reflects the latest updates for consistency.

Version 1.10.8 Hotfix

• Merged dev-1.10.8_hotfix branch into dev: Integrated critical fixes into the development branch.

General Improvements and Fixes

• Liquid Handling Enhancements: Added considerations for liquid mechanics, improving functionality where liquids are involved.
• Import Fixes: Resolved issues with import statements to ensure smoother integration and compatibility.
• Skill Utility Methods: Added a new non-colliding utility method to enhance skill functionality and prevent conflicts.
• Attribute Updates: Updated and added friendly attribute names to align with recent naming changes, improving clarity and usability.
• Block Transparency Adjustment: Removed transparent blocks again, but retained references within the file for potential future use.

THIS IS CONSIDERED AN ALPHA VERSION AND NEEDS TESTING/FEEDBACK.

CUSTOM SKILLS WILL NOT WORK TRY OUR NEW SCRIPT SKILLS SYSTEM INTEGRATED WITH MM!

==-- | 1.10.8 PREMIUM | --==
This is a MAJOR update that features MANY changes to internal code and functions due to the great number of API changes brought by 1.20.6 and above. Please make sure to update your skills as the OLD format may not work as intended!

With this update we have unfortunately removed support for versions 1.15 and below. This comes after we found a majority of our user base no longer uses these versions and it was becoming increasingly difficult to maintain the central codebase across all these different versions. 1.16.5 and above are still fully supported.

As always, please let us know if you have any issues with the latest update.

-- Supported Minecraft Versions --
1.16.5, 1.17.X, 1.18.X, 1.19.X, 1.20.X, 1.21, 1.21.1

-- Changes --

• Removed version handlers for all versions below 1.16.5
• Added stamina drain and mana drain stats as possible stats for MMOItems support
• Updated the code that checked for reagent potion types. A new format will now be used so old configurations that used reagents with potion types may not work anymore. The new format is <material>:<potion_type>, where material is either potion, splash_potion, or lingering_potion.
• Improved general reliability of skill casting and under what circumstances a skill will be cancelled and if resources are taken or not.
• A number of technical changes which should hopefully improve consistency and performance across the board

-- Bug Fixes --

• Corrected issues that would occur when using newer versions due to version-specific entity names and values.
• Passthrough blocks (blocks which can be walked through such as tall_grass or crops) were previously manually added to a list and checked during most skill casts. Due to updating to 1.16.5 we can use an in-built registry for this which should mean more accurate skill casts and faster updates in the future
• Many minor fixes to version incompatible things, improving consistency of internal functions.
• Modified the translations slightly for the attribute menu. Now attribute menu will show the 'allocated points', meaning the points you've already committed, then the 'pending points', the points you've pended but not confirmed yet. And then the 'total points' which will include the allocated points in addition to any points from items such as MMOItems. Hopefully this should clarify issues.

-- Technical Changes (For Developers) --

• Updated project Java version to 11
  
  
• Added a number of version friendly handlers for the once used enums that are now implemented final static variables as of Spigot 1.20.6. We will use these in the core code instead of the classic Particle.CLOUD or Enchantment.DAMAGE_ALL for example. The following wrappers that were added are listed below;

FriendlyParticle FriendlyEnchant FriendlyPotionType

• HeroesDamageType is another friendly wrapper that was added to account for the new 'DamageType' API that was added in Spigot 1.20.6. Heroes previous way of checking for damage involved manually calling an EntityDamageByEntityEvent, since the constructor for this event is deprecated and marked for removal, we have been forced to adopt the new API which involves calling LivingEntity.damage(Entity, DamageSource), where DamageSource takes a unique DamageType parameter among other sources. The HeroesDamageType is a wrapper which automatically is used to provide the correct damage type regardless of what version of Minecraft the plugin is running on. For now, simply know that when calling damage entity functions through Heroes, try to use HeroesDamageType instead of the previous EntityDamageEvent.DamageCause
• Since we no longer call an EntityDamageEvent ourselves to check for damage conditions, manual checks for Integrations such as in WorldGuard, Townships or anything else are now involved in the DamageCheck functions.

https://gitlab.com/herocraft/Heroes/-/wikis/changelog
to be updated soon...

Fixes for 1.20.4 server oddities and some client crashes

This will fix Heroes to load when not using MM, apologies and thanks for the reports!

Optional percent based strength increaser
combat but fixes
various other quality of life improvements

Read the entire changelog

==-- | 1.10.2 PREMIUM | --==
This is a minor update to fix some further bugs and implements some community suggested features.

-- Supported Minecraft Versions --
1.13.X, 1.14.X, 1.15.X, 1.16.X, 1.17.X, 1.18.X, 1.19.X, 1.20.X

-- Changes --

• Added a new feature which is intended to combat spawn-campers and general bad PvP behaviour. This feature is called 'death-bonus'. If a player is defeated a configurable amount of times, then they are given a special effect that boosts their speed and damage against all players that were involved in 'abusing' them. Similarly, the player also receives a reduced damage from the killers. The configuration is generated in config.yml but you can take a look here as well.

1. Aug 14, 2023
2. • 
     Merge branch '1.10.1' into 'dev'
     RAVINGAR authored 1 week ago
     
     a218b1f1
3. Aug 08, 2023
4. • 
     Fixed accidental ! which made broadcasting text not appear
     RAVINGAR authored 2 weeks ago
     
     91bcc1a4
5. Jul 15, 2023
6. • 
     Fix bugs with config manager.
     RAVINGAR authored 1 month ago

BUG FIXES!

• Add SummonFamiliar to allow for Pets and MythicMob AI to be controlled by the player!

RAVINGAR @RAVINGAR
Pushed to branchdev

• 192d4fe7 · Merge branch '1.10_bug_fixes' into 'dev'
• ... and 3 more commits. Compare 472ba68c...192d4fe7

19 hours ago

RAVINGAR @RAVINGAR
Acceptedmerge request!147"Fixed an exception that occurred when attempting to modify a monster's damage..."
19 hours ago

RAVINGAR @RAVINGAR
Openedmerge request!147"Fixed an exception that occurred when attempting to modify a monster's damage..."
19 hours ago

RAVINGAR @RAVINGAR
Pushed to branch1.10_bug_fixes

• e558e645 · Fixed issue that occurs only when loading a fresh version of Heroes...
• ... and 1 more commit. Compare 985637f6...e558e645

6 days ago

RAVINGAR @RAVINGAR
Pushed new branch1.10_bug_fixes

# ==-- | **1.10 PREMIUM** | --==
This update is a MAJOR step forward for Heroes and the future of the plugin! A significant number of rewrites, optimisations and new features are present in this update as we finally jump to the new 1.10 mark. As always, please let us know if you encounter any issues with this new update.

**You MUST update all your skills for this latest version, otherwise the skills WILL NOT LOAD!**

**It is also recommended to backup your old damages.yml and then generate a new one! As there are new options configuration options available!**

## -- **Supported Minecraft Versions** --
1.13.X, 1.14.X, 1.15.X, 1.16.X, 1.17.X, 1.18.X, 1.19.X, 1.20.X

## -- **New Features** --
- damages.yml now contains the option `use-pvx-damage-multipliers`. Previously, this has always been true, where a class's pvp and pve modifiers are considered during damage calculations. If you do not use this feature then simply set it to false, which can minorly improve performance.
- damages.yml now contains the option `item-damage-priority`. This has 5 modes and controls what affects a Hero's dealt damage. Previously, the highest value of all classes (primary, secondary and race) was chosen. It is advised to select the option that best suits your needs, as if you only use a primary class for damage, then choose that since it significantly reduces the amount of calculations required therefore improving performance.

The available options are;
```

• - highest (checks which value is the highest of the three classes)
• - primary (only uses primary class, if no value exists use global damage, if no global damage exists, use vanilla)
• - secondary (only uses secondary class, if no value exists use global damage, if no global damage exists, use vanilla)
• - race (only uses race class, if no value exists use global damage, if no global damage exists, use vanilla)
• - none (don't use class scaling, instead use global damage if it exists - and if it doesn't then use vanilla values.)

```
- A Hero's attributes are now available as variables through MythicMobs! This means using script skills, you can use per attribute increases for various skill variables. You can access a Hero's attribute using a format such as; `<caster.var.hero_strength>` or `<caster.var.hero_charisma>`
- Expansion for Placeholder API is now implemented directly into Heroes! So there is no need to use a separate expansion file!
- Added a new scriptable skill type for passives! This skill will essentially call a MythicMob skill when for when the passive is applied and for when it is removed. Since there are more than two types, a new option has been added to the configurations. **Please regenerate your script-skills.yml to see the new format and update your skills accordingly**

Example of a passive skill;
```
- name: FieryPresence
on-apply-mythic-skill-id: FieryPresence-Apply
on-remove-mythic-skill-id: FieryPresence-Remove
type: PASSIVE
skill-types: BUFFING,ABILITY_PROPERTY_FIRE
```
It's recommended that these Apply and Remove mythic skills should essentially apply and remove an Aura from Mythic Mobs. As this allows you to configure onTick skills, onApply and onRemove even further.
`requires-target` has now uses the 'type' option. Where if requires-target was true then use the new skill type `TARGETED`, or else if false, use `ACTIVE`

## -- **Changes and Optimisations** --

• - Mitigation can no longer be configured per class, simply due to exponential increase in calculations that was required to do this.
• - The enchantment mitigation values in damages.yml are now ONLY considered
• - Summoned mobs should now have improved AI behaviour
• - Experience boosts are no longer applied for players which are 'opped'. This does mean that even if a player is opped AND has permission for experience boosts, then they will receive no personal exp boosts regardless.

### **Damage Handler Rewrite**
The damage handling of Heroes has been completely rewritten! This was a major issue with Heroes, since the previous DamageEvent listener had become a bundle of spaghetti code spanning 11 years of history. This was clearly causing MANY issues such as bugs and huge performance losses.
As such, the old code has been completely discarded, with new code and API written to handle the many complex facets of Heroes damage. For example now, certain checks such as let's say for custom mitigation, are now made at startup rather than every single time a damage event is called - since not all users use custom mitigation.
For reference; on 1.9.30, a profiler run over 15 minutes (with only 2 players mind you) saw a contribution of over 100ms of CPU time. A similar test on 1.10 saw that number drop to less than 5ms, in some cases the time taken was so small that it didn't even show up on the profiler. This is a massive improvement and a huge undertaking to comprehensively scan and understand the mess that was the old spaghetti code and make something new that is optimised and efficient.
Additionally, damage seems to be handled more consistently and accurate with this rewrite. But this is extremely comprehensive, please let us know if you encounter any bugs!

### **SkillConfigManager Rewrite**
The SkillConfigManager has been rewritten to now cache values read from a skill configuration. In addition to other rewrites mentioned in the API section of this update document, **you can now specify ANY increase-per-attribute or per-level for ANY numeric skill setting on ANY skill**. For example, you can specify `damage-per-dexterity` or `duration-increase-per-intellect` on any skill setting. For example let's take a look at Kick. Previously, you could only increase the damage per strength as shown;
```
Kick:
damage: 5
damage-increase-per-strength: 1
duration: 2500
```
But now you can configure something such as this, where you can use any attribute and even `per-level` to have skills dynamically scale with a Hero's attributes.
```
Kick:
damage: 5
damage-per-intellect: 0.5
duration: 2500
duration-increase-per-charisma: 500
```
This change both allows for more customisation and also improves efficiency, reducing plugin latency.

With this change, you can now change the SkillSetting priority based on class and preference. In config.yml you can find this section.
```
classes:
# When getting the setting for a skill, here you can specify the priority type. The valid types are 'default', 'highest', or 'primary'
skill-setting-priority: HIGHEST
```
The available settings are;
**DEFAULT** -> Returns the first available skill setting in order of Primary, Secondary, Race, Global, Skills.yml. For example, if both a Hero's secondary class and race class have the skill setting for damage. Regardless of which is higher. The value from secondary will always be returned.

**HIGHEST** -> Returns the highest value for a skill setting based on each of a Hero's classes. For example if a Hero has the 'damage' setting equal to 8 for their primary, and 12 for their race. Then the 12 value is used. That 12 value is used even if a higher value of lets say 24 is specified in the skills.yml. In this mode only if neither the primary, secondary, race class, nor the global skill set have the skill setting specified is the skills.yml value used.

**PRIMARY** -> Only checks a player's Primary, Global and Skills.yml for a Skill Setting. Similar to default in that it will prefer primary over global. Where if neither primary and global has the setting set, then it will use the value from skills.yml.

### **Monster Handling Rewrite**
Monster objects are now initialised just as a monster spawns, rather than only as required. This reduces the required load on whatever execution is requesting a monster object, since they are almost always loaded anyway.
Removed outdated use of storing custom attributes in a monster's entity. This was contributing to significant server latency and served no real purpose anymore, hence it has been removed.

## -- **Bug Fixes** --
- Fixed major oversight regarding how armour and other mitigation is handled. Previously, the assumption was made that vanilla mitigation was not applied after all our handling; however I was wrong. What this meant is that when wearing armour, particularly with enchantments. The mitigation Heroes applied would be applied IN ADDITION to vanilla mitigation. This is why protection enchants were always so strong when using Heroes. Now, Heroes automatically adjusts for it's custom mitigation, ensuring that damage is dealt correctly.
- Side-effect of the above, is that custom enchant mitigation is now ONLY applied when custom mitigation is enabled! Additionally, the values read in damages.yml for protection is read as decimals, for example 0.04 will mean 4% per enchant level || if custom mitigation is disabled, then vanilla enchant mitigation values are applied.

• - Fixed issue where skills would not heal in combat
• - Effects which apply a 'no sprint debuff' now should work correctly. SlowEffect in particular and casting will now prevent a player from both sprinting and juping.
• - Fixed issue with SkillBaseSphere which threw an exception.
• - Fixed issue with SkillBaseMarkedTeleport which caused particles to not appear correctly
• - Fixed bug where some skills would not broadcast their message and instead would spew a warning in console.
• - Armour toughness is now considered correctly.
• - Fixed bug where armour could be equipped under circumstances when it shouldn't.
• - Removed old code that caused default health to be set incorrectly.
• - Fixed a significant number of other miscellaneous bugs and issues

## -- **API Changes** --
- MythicMobs now have their own CharacterTemplate subclass called MythicMonster. This way, Heroes WILL NOT override a Mythic Mob's stats regardless of any configured values. Additionally, if a MythicMob is using a casting skill, a Hero's interrupt now actually applies to a MythicMob as well.
- SkillSetting is now an abstract class which stores static objects. A new interface `Setting<T>` now represents a SkillSetting that returns a specific variable of it's type parameter.
- All methods relating to `SkillConfigManager.getUseSetting()` have been deprecated, in favour of the method `SkillConfigManager.getCachedUseSetting()` which considers the type parameter of the SkillSetting
- A number of methods in CharacterDamageManager has been updated, removed or deprecated. If you wish to get the amount of damage a Hero will deal, it is recommended to use `getMeleeDamage(Hero, Material)` or `getProjectileDamage(Hero, ProjectileType)`. Keep in mind these values do not consider PvX multipliers, nor do they include bonus enchantment damage.
- HDamageListener is now completely deprecated and no longer used, instead the DamageHandler class is the main handler of damage.

The nexus repository has been updated. Please note that the repository URL has been updated, but as per usual, you can use the Heroes API with the following artifact;
```
<repository>
<id>heroes-repo</id>
<url>https://nexus.hc.to/content/repositories/pub_snapshots/</url>
</repository>

<dependency>
<groupId>com.herocraftonline.heroes</groupId>
<artifactId>Heroes</artifactId>
<version>1.10-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
```

## -- **Developer Notes** --
Due to many massive rewrites, if any custom skills are used, they **need** to be recompiled against `1.10-SNAPSHOT` otherwise they will not load. This is because we changed the SkillSetting enum class to an interface. This change was made for optimisations, cleaner code and the possibility to cache values.

There exists now a number of preset SkillSetting implementations such as SkillSettingInt, SkillSettingString, SkillSettingDouble and so on. You can even create your own SkillSetting which may read a configuration for example, and then return a custom object for your use in a skill.

SkillSettings such as `damage-increase-per-dexterity`, `duration-per-level` etc, are now deprecated. This is since SkillSettingInt and SkillSettingDouble automatically consider all attribute increases and per level increases on every skill setting as mentioned. Therefore these deprecated SkillSettings, will always return 0. Hence its no longer necessary to include them in code.

For example, it is no longer necessary to use code such as this;
```
double damage = SkillConfigManager.getUseSetting(hero, this, SkillSetting.DAMAGE, 50, false);
final double damageIncrease = SkillConfigManager.getUseSetting(hero, this, SkillSetting.DAMAGE_INCREASE_PER_STRENGTH, 1.0, false);
damage += damageIncrease * hero.getAttributeValue(AttributeType.STRENGTH);
```

Now, this is the only code necessary to achieve the same effect;
```
double damage = SkillConfigManager.getCachedUseSetting(hero, this, SkillSetting.DAMAGE, 50.0)
```

**Please do not hesitate to let us know if you have any issues with the new changes or require assistance with the API**
*This update has been tested extensively but due to the comprehensive rewrites it possible there may be some things that we missed.*
Thank you for supporting Heroes throughout all these years!