` Format:** Uses `

` elements where brackets are automatically added around headers. ```xml

Content here

``` **Formatting rules:** * Empty `` creates spacing between sections * Maximum 1023 characters total per tooltip (longer descriptions are truncated) * Use the `` format for all new configurations ## Event States The server automatically determines event states based on remaining time: | State | Display | Condition | | ------------- | ------------------ | ------------------------------------ | | Disabled | Hidden | Enabled=false OR remainTime=-1 | | Waiting | Normal countdown | remainTime > 300 seconds (5 minutes) | | Starting Soon | Yellow/highlighted | remainTime < 300 seconds | | Active | Active indicator | remainTime = 0 | ## Important Behavior {% hint style="info" %} **State-Based Events**: Some events (Crywolf, Castle Siege, Kanturu, Raklion, Imperial Guardian) use their game system state rather than simple timers. The plugin automatically handles state-to-time conversion. {% endhint %} {% hint style="warning" %} **Tooltip Length Limit**: Each tooltip can contain up to 1023 characters (flattened, including newline separators). Longer descriptions are truncated. {% endhint %} {% hint style="info" %} **Event Name Length**: Event names are limited to 31 characters (EVENT\_NAME\_LEN - 1). Longer names will be truncated when sent to the client. {% endhint %} {% hint style="warning" %} **Index Conflicts**: If you define multiple events with the same Index, only the first one loaded will be used. Always use unique indices. {% endhint %} ## Examples {% tabs %} {% tab title="Simple Event" %} ```xml [Description] PvE survival event for levels 15-400. Fight through waves to protect the statue. [Rewards] - Jewel of Chaos - Ancient Items - Experience bonus ``` {% endtab %} {% tab title="Disabled Event" %} ```xml This event is not available. ``` {% endtab %} {% tab title="Arena Event" %} ```xml [Description] Free-for-all PvP arena. Last survivor wins! [Rules] - No potions or buffs - Pure skill combat ``` {% endtab %} {% tab title="Custom Event" %} ```xml [Description] The Ice Queen invades the server! Defeat her for amazing rewards. [Location] Random spawns in Lorencia [Rewards] - Jewel of Guardian - Frozen equipment - Massive experience ``` {% endtab %} {% endtabs %} ## Tooltip Design Guidelines ### Structure Your Tooltips Use a consistent pattern across all events: 1. **Description** - What is this event? 2. **Requirements/Location** - How to access it 3. **Rewards** - What players can earn 4. **Rules/Strategy** - Special mechanics ### Use Clear Headers ```xml [Description] [How to Enter] [Rewards] [Rules] [Strategy] [Location] ``` ### Keep It Concise * Each line should be 40-50 characters max for readability * Use bullet points (- or •) for lists * Break long paragraphs into multiple lines * Use empty lines sparingly for section breaks ### Good Tooltip Example ```xml [Description] Team-based capture event. Carry the Sacred Ball to the enemy pedestal. [Rewards] - Illusion Shard Points - Old Scroll / Illusion Shard - Special armor sets [Strategy] - Protect your ball carrier - Use CC skills on enemies - Team coordination is key ``` ## Common Issues {% hint style="warning" %} **Events Not Appearing**: If an event doesn't show in the timer window, verify: 1. `Enabled="true"` is set 2. The underlying event is actually scheduled (check the matching event config file) 3. The Index is valid (0-41) {% endhint %} {% hint style="warning" %} **Tooltip Not Showing**: Empty or malformed tooltips will display "No description available." Ensure: 1. At least one `` element exists inside `` 2. XML is properly closed (``, ``, ``) 3. No invalid XML characters (use < > & for <, >, &) {% endhint %} {% hint style="danger" %} **Server Crash on Load**: If the server crashes when loading this file: 1. Verify XML is well-formed (matching open/close tags) 2. Check that Index values are 0-41 3. Ensure file encoding is UTF-8 4. Look for special characters that need escaping {% endhint %} {% hint style="info" %} **Default Fallback**: If the XML file fails to load or is missing, the plugin uses built-in default names and shows "No description available" for all events. The server will continue running with defaults. {% endhint %} ## Related Configuration | Config | Purpose | | ------------------------------------------ | ------------------------------------------------------------------------ | | [Event.dat](/docs/gameserver/event-dat.md) | Per-server event schedules, enables, and countdown sources | | [Event configs](/docs/data/event.md) | Individual event definitions (Blood Castle, Devil Square, Kanturu, etc.) | ## Behavior ### Event Time Sources Different events pull their countdown from different places: * Most scheduled events read their next-start time from the GameServer's event scheduler * State-driven events (Kanturu, Crywolf, Castle Siege, Raklion, Imperial Guardian) read their current state directly from the event system * Invasion slots (14-27) and Custom Arena slots (28-41) each have their own timers ### Loading At startup the plugin reads `Data/Plugins/Events/EventTimerInfo.xml`, validates each `` Index (0-41), and stores the enable flag, name, and tooltip lines. A malformed or missing file falls back to hardcoded defaults so the event timer UI never shows blank data.