This is a spigot plugin that aims to extend Minecraft's survival endgame by making mobs more interesting.
EliteMobs is a Spigot plugin focused around the creation of bosses. It also adds several other features, such as quests, arenas, items, an extension to in-game progression and dungeons, to name a few.
Feature and configuration documentation: https://github.com/MagmaGuy/EliteMobs/wiki
Discord support channel: https://discord.gg/QSA2wgh
Webapp where you can create content: https://magmaguy.com/webapp/webapp.html
Maven repository:
Maven:
<repository>
<id>elitemobs-repo/id>
<url>https://s01.oss.sonatype.org/content/repositories/snapshots</url>
</repository>
<dependency>
<groupId>com.magmaguy</groupId>
<artifactId>EliteMobs</artifactId>
<version>8.7.4-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
Gradle:
repositories {
//EliteMobs
maven { url = 'https://s01.oss.sonatype.org/content/repositories/snapshots' }
}
dependencies{
//EliteMobs
compileOnly group: 'com.magmaguy', name: 'EliteMobs', version: '8.7.4-SNAPSHOT'
}
The following is a list of key classes for the plugin:
com.magmaguy.elitemobs.api.utils.EliteItemManager
This class is specifically made to be the easiest way to interface with Elite Items.
These are the key classes for the boss system. RegionalBossEntity extends CustomBossEntity which extends EliteEntity.
This is used to check if an entity is from EliteMobs and to get the specific instance of that entity.
Note: This documentation is updated as requested. If you feel like it is incomplete and should further expand on some aspects, request it and it will be updated.
EliteMobs has a few basic APIs to interface with in the com.magmaguy.elitemobs.api
package. Here's the breakdown:
Fires when an arena is successfully beaten by players.
Fires when a Custom Event starts. Note that in this instance Custom Events refers to the mechanic in which bosses randomly spawn in the Overworld.
Fires when a dungeon is installed by an admin.
Fires when a dungeon is uninstalled by an admin.
Fires when an Elite Explosion happens. Note that elite explosions have a custom visual effect and regenerate the damage done to terrain after 2 minutes.
Used for listening to moments when one Elite damages another Elite. Uses:
Used for listening to events which trigger an antiexploit check - doesn't necessarily mean that it detected an exploit. Uses:
Used for listening to moments when a player damages an Elite. Uses:
Used for listening to moments when an elite is damaged in general. Uses:
Used to listening to moments when an elite is killed. Uses:
Used for listening to moments when an elite enters combat against a player. Note that bosses only enter combat after either striking a player or being struck, and not at the moment of targetting. Uses:
Used for listening to moments when an elite leaves combat against a player. Uses:
Used when an elite gets healed.
Used when an elite mob gets removed. Please note that not all removals are permanent as bosses can be removed because the chunks unload while still being persistent.
Used for detecting whether an ItemStack is an EliteMobs ItemStack (like a custom item or a procedurally generated item). Uses:
Used for detecting when an Elite spawns. Uses:
Used for detecting when an Elite has targetted a player. Uses:
Used for listening to moments when the antiexploit runs a check but no players damaged it. Uses:
Used when an npc gets removed. This removal may not be permanent, as it might just be a chunk unload.
Used when an npc gets spawned.
Used for listening to moments when players are damaged by an Elite. Uses:
Used when a player starts teleporting through EliteMobs features. There is a 3 second timer before the teleportation actually happens.
Used when a player actually teleports through EliteMobs features.
Used when a player accepts a quest.
Used when a player completes a quest.
Used when a player leaves a quest.
Used when all quest objectives for a quest are completed.
Used when a player progresses in a quest, such as by killing a quest mob or collecting a quest item.
Used when a player gets the reward from a quest.
Used when a Super Mob gets damaged.
Used when a Super Mob dies.
Used when a Super Mob gets removed. Note that removals might be temporary due to chunk unloads.
Used when a Super Mob spawns.
com.magmaguy.elitemobs.config.enchantments.premade
**
extending** EnchantmentsConfigFields
to initialize create its config file (naming convention: [EnchantmentName]
Config)CustomEnchantment
to initialize the config filecom.magmaguy.elitemobs.items.customenchantments
extending CustomEnchantment
to write
the logic for the enchantment (naming convention [EnchantmentName]Enchantment)CustomItem
so custom items detect it correctlygenerateCustomEnchantments()
method in EnchantmentGenerator
if the enchantment
should appear in procedurally generated itemsNote:
EventsRegistrer
if the part with logic in it requires events.CombatSystem
through the static "bypass" boolean field - it makes the next damage dealt
to the elite use the raw damage value. For correctly assigning damage, use
Bukkit's Damageable#damage(double amount, Entity source)
and assign the source to your player.to be documented
to be documented
to be documented
to be documented
Special Thanks to Illusion for spending a few hours proselytizing enums that are also have anonymous method implementations on their constructor.