Feature: Broodmother alerts/messages and damage indicator support

[MTOnline69]

What

Adds Broodmother to the damage indicator, and a new category to the Combat features for various Broodmother alerts, messages and a countdown:

• Shows a countdown on screen once we can figure out when the Broodmother will spawn (must observe a stage change)
• Warns the player when there is 1 minute left until the Broodmother will spawn
• Alerts the player with a title and sound that the Broodmother spawned, with a link in chat to quickly warp
  • Alert sound, pitch, amount of times repeated and title text can all be changed
• Sends chat messages upon each Broodmother spawn stage change (choose which stages to get notified about)

Images

Since i'm still new to contributing, my code may need work.

Changelog New Features

• Added Broodmother spawn alert, countdown and stage change messages. - MTOnline
  • Countdown will not show until a spawning stage change is observed, and may be off by a few seconds.
• Added Broodmother support to the Damage Indicator. - MTOnline

[hannibal002]

The features work fine for me in the game.
The code looks great. You use a ton of different features of the SkyHanni framework perfectly fine.

I've found a couple of suggestions that could improve the maintainability and consistency of the code, nothing big, though. Thanks for the cool PR!

[qtlunya]

One thing, the Spider Mound technically encompasses the whole area, including at the bottom of the mountain which is the early game spider area. It may be better to refer to it as the "Top of the Nest", as the travel scroll and the warp menu do in the game, and the check for whether the player is in the Spider Mound should probably reuse getBroodmotherShowWhen from the ScoreboardEvent class instead (currently private, probably best to extract it into a utility function).

[MTOnline69]

One thing, the Spider Mound technically encompasses the whole area, including at the bottom of the mountain which is the early game spider area. It may be better to refer to it as the "Top of the Nest", as the travel scroll and the warp menu do in the game, and the check for whether the player is in the Spider Mound should probably reuse getBroodmotherShowWhen from the ScoreboardEvent class instead (currently private, probably best to extract it into a utility function).

Alright, I'll change the text. Which utils class would getBroodmotherShowWhen best fit?

[qtlunya]

LocationUtils is probably a good choice, could rename the method to isAtTopOfNest or similar.

[hannibal002]

LocationUtils is probably a good choice, could rename the method to isAtTopOfNest or similar.

I would like to have the abstract util classes as abstract as possible. Sure, this is location related. But this check is only relevant for spiders den features, for nothing else that touches location. Therefore a newly created SpidersDenAPI class feels better imo

[github-actions]

This pull request has conflicts with the base branch "beta". Please resolve those so we can test out your changes.

[MTOnline69]

Ignore the absolute mess I made of this PR earlier

All requested changes dealt with and I tested quite extensively with no issues.

[hannibal002]

LGTM