GH-352 Add Arc Riders style flare - firework - indicating players death location

[CitralFlo]

📝 Description

feat: Add customizable flare that spawns after players death

🎯 Type of Change

• 🐛 Bug fix (non-breaking change which fixes an issue)
• ✨ New feature (non-breaking change which adds functionality)
• 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
• 🔧 Refactoring (no functional changes, just code improvements)
• 🎨 Style/Cosmetic (formatting, whitespace, visual changes)
• 📚 Documentation (updates to documentation or README)
• 🤖 CI/CD/Build (changes to workflows, gradle, etc.)

Test Environment:

• Minecraft Version: 1.21.10
• Java Version: 21
• Platform: Windows - Paper

📸 Screenshots (if applicable)

[gemini-code-assist]

Summary of Changes

Hello @CitralFlo, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a new visual effect for player deaths, where a customizable firework 'flare' is triggered at the death location. This enhancement provides more dynamic feedback to players and observers. The existing death lightning effect has also been separated into its own controller, and both effects now offer extensive configuration options, allowing server administrators to tailor the combat experience. The changes also include the integration of a new utility library to support these visual effects and an update to the project's documentation.

Highlights

• New Feature: Death Flare: Implemented an 'Arc Riders style flare' (firework) that spawns at a player's death location. This feature is highly customizable, allowing configuration of firework type, colors, power, and associated particle effects.
• Refactored Death Effects: The existing DeathEffectController was refactored and split into two distinct controllers: DeathFlareController for the new firework effect and DeathLightningController for the existing lightning strike effect. This improves modularity and configurability.
• Enhanced Configuration Options: The DeathSettings configuration was updated to provide granular control over both lightning and flare effects. Each effect now has settings for whether it occurs after every death or only in combat, along with specific parameters for firework appearance and particle trails.
• New Dependency: XSeries: The XSeries library (v13.6.0) was added as a dependency to facilitate advanced particle effects and other utility functions for the new death flare feature.
• Documentation Update: The README.md file was updated to include a new GIF showcasing the death flare feature and to standardize image tags with a width attribute for better presentation.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• README.md
  • Updated image tags to include a width attribute for consistent sizing.
  • Added a new GIF demonstrating the death flare feature.
• buildSrc/src/main/kotlin/Versions.kt
  • Added a new constant for the XSeries library version.
• eternalcombat-plugin/build.gradle.kts
  • Included the XSeries dependency.
  • Configured XSeries package for relocation within the shadow JAR.
• eternalcombat-plugin/src/main/java/com/eternalcode/combat/CombatPlugin.java
  • Updated imports to reflect the new death effect controllers.
  • Replaced the instantiation of DeathEffectController with DeathFlareController and DeathLightningController.
• eternalcombat-plugin/src/main/java/com/eternalcode/combat/fight/death/DeathEffectController.java
  • Removed the deprecated DeathEffectController file.
• eternalcombat-plugin/src/main/java/com/eternalcode/combat/fight/death/DeathFlareController.java
  • Added a new controller responsible for spawning customizable firework flares upon player death, including particle effects.
• eternalcombat-plugin/src/main/java/com/eternalcode/combat/fight/death/DeathLightningController.java
  • Added a new controller dedicated to handling lightning strikes upon player death.
• eternalcombat-plugin/src/main/java/com/eternalcode/combat/fight/death/DeathSettings.java
  • Refactored the lightning setting into a nested LightningSettings class for better organization.
  • Introduced a new nested FlareSettings class to configure the new firework death effect, including type, colors, power, and particle trails.

Activity

• No human activity has been recorded on this pull request yet.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

The pull request introduces a new "Arc Riders style flare" feature, which adds a firework effect at a player's death location. This involves adding a new XSeries dependency, refactoring the existing DeathEffectController into DeathFlareController and DeathLightningController, and updating the README.md to reflect the new feature. The changes are well-structured, separating the lightning and flare effects into distinct controllers, and providing comprehensive configuration options for the flare. The README.md update is also a good addition, clearly showcasing the new functionality.