CrystalBuff

CrystalBuff is an Ashita v4 addon for Final Fantasy XI that automatically tracks and corrects your current crystal buff—Signet, Sanction, or Sigil—based on the zone you are in.

Note:
This addon is designed EXCLUSIVELY for the CatsEyeXI private server and will not function as intended on retail or other private servers.
The required commands (!signet, !sanction, !sigil) and zone assignments are specific to CatsEyeXI.

Features

• Automatic Detection: Monitors your active buffs and determines which crystal buff (Signet, Sanction, or Sigil) is required for your current zone.
• Buff Correction: If you are missing the required buff for your zone, CrystalBuff will automatically issue the appropriate command to correct it.
• Zone Awareness: Recognizes the zones where each buff is needed—Signet (vanilla zones), Sanction (ToAU zones), Sigil (past zones)—and adapts as you move.
• Smart Filtering: Automatically ignores city zones, non-combat areas, and other safe zones where crystal buffs are not needed.
• Event System Awareness: Skips corrections during cutscenes and scripted events to avoid interruption.
• Minimal Setup: No configuration required. Just load the addon and let it keep your crystal buff up-to-date.

Installation

1. Download or clone this repository into your Ashita v4 addons folder:

   git clone https://github.com/seekey13/CrystalBuff.git
   

2. Start or restart Ashita.

3. Load the addon in-game:

   /addon load crystalbuff
   

Usage

CrystalBuff runs automatically in the background. When you change zones or your buffs change, it will:

1. Check your location: Determines if you're in a zone that uses a crystal buff
2. Verify your buffs: Compares your current crystal buff against what's needed for the zone
3. Apply corrections: If needed, automatically issues the appropriate command to get the correct buff

Intelligent Behavior

• Safe Zone Detection: Automatically ignores cities, towns, and other non-combat areas where buffs aren't needed
• Event System Detection: Pauses during cutscenes and events to avoid interfering with scripted content
• Buff Change Monitoring: Detects buff list changes and re-evaluates requirements whenever your buffs update

When Corrections Happen

• If you have no crystal buff in a combat zone
• If you have the wrong crystal buff for your current zone (e.g., Signet in a ToAU zone)
• After zoning into a new area that requires a different buff
• Whenever your buff list changes

Supported Buffs

Signet, Sanction & Sigil

Output

CrystalBuff runs silently in the background. The only output you will see is a notification when a buff mismatch is detected and corrected:

[CrystalBuff] Mismatch detected, issuing command: !signet

No commands or configuration are required.

Compatibility

• Ashita v4 (required)
• CatsEyeXI server ONLY

License

MIT License. See LICENSE for details.

Credits

• Author: Seekey
• Inspired by the annoyance of forgetting your Signet/Sanction/Sigil.

Support

Open an issue or pull request on the GitHub repository if you have suggestions or encounter problems.

Special Thanks

Commandobill, Xenonsmurf, atom0s, and Carver

Completely unnecessary AI generated image

Changelog

Version 1.5 (Current)

• Removed debug mode and all user-facing commands for a simpler, zero-config experience
• Removed cooldown system and startup/zone-in delays in favor of reactive buff-change detection
• Checks now trigger immediately on buff list changes rather than on fixed timers
• Retains event system detection to skip corrections during cutscenes and events
• Significant code simplification and cleanup

Version 1.4

• Added event system detection to prevent commands during cutscenes/events
• Implemented 10-second startup delay after addon load for data initialization
• Implemented 10-second delay after zone-in before buff checks begin
• Improved timing logic to prevent premature buff corrections
• Enhanced world ready state detection for better reliability

Version 1.3

• Added 1-second delay for buff change detection to improve accuracy
• Enhanced packet handling for more reliable zone and buff detection
• Improved error handling with comprehensive pcall usage

Version 1.2

• Added command cooldown system (10-second rate limiting)
• Implemented smart delays (2-second delay for commands to avoid conflicts)
• Added non-combat zone filtering (cities, towns, safe areas)
• Introduced debug mode with /crystalbuff debug command
• Added zone ID command /crystalbuff zoneid for troubleshooting
• Enhanced error handling and logging
• Improved zone change detection with packet-based monitoring

Version 1.0

• Initial release with basic automatic buff detection and correction
• Support for Signet, Sanction, and Sigil buffs
• Zone-based buff requirements