XIV Raid Planner - Dalamud Plugin

In-game companion plugin for FFXIV Raid Planner. Displays loot priority overlays during savage raids, tracks BiS gear progress, and auto-logs loot drops to the web app.

Features

• Priority Overlay — Loot priority rankings per floor during savage raids with top 3 per drop slot
• BiS Gear Viewer — In-game BiS gear table with progress tracking, equipped item comparison, and materia details
• Auto-Loot Logging — Detects loot distribution from chat and logs drops to the raid planner API
• Gear Sync — Sync your equipped gear to the web app to update your player card
• Purchase Detection — Detects BiS tome/book vendor purchases and offers to log them
• BiS Highlighting — Tints BiS items in the Need/Greed loot window and tome vendor shops
• Floor Clear Tracking — One-click "Mark Floor Cleared" for book tracking
• Party Matching — Automatically matches in-game party members to planner player entries
• Leave Warning — Warns if you have unclaimed priority loot when leaving an instance

Installation

Via Dalamud Custom Repository (Recommended)

1. Open FFXIV with XIVLauncher
2. Open Dalamud Settings (System menu or /xlsettings)
3. Go to the Experimental tab
4. Under Custom Plugin Repositories, add the following URL:

   https://raw.githubusercontent.com/aaronbcarlisle/XIVRaidPlannerPlugin/main/repo.json
   

5. Click the + button, then Save and Close
6. Open the Plugin Installer (/xlplugins)
7. Search for XIV Raid Planner and click Install

Manual Build

Requires .NET 8 SDK and a Dalamud development environment.

cd XIVRaidPlannerPlugin
dotnet build --configuration Release

The built plugin will be in XIVRaidPlannerPlugin/bin/Release/XIVRaidPlannerPlugin/.

Setup

1. Generate an API key from the FFXIV Raid Planner web app (User Menu > API Keys)
2. In-game, open settings with /xrp config
3. Paste your API key in the Connection tab and click Test Connection
4. Go to the Static tab and select your static group (tier defaults to Auto)
5. Go to the Players tab and link your party members to their planner roster entries

Commands

Command	Description
/xrp	Toggle the priority overlay
/xrp bis	Toggle the BiS gear viewer
/xrp sync	Sync equipped gear to the web app
/xrp config	Open the configuration window

How It Works

1. Enter a savage instance — the plugin fetches priority data and BiS gear from the API
2. Priority overlay appears showing who should get each drop slot (configurable timing)
3. Loot drops are detected from chat — the plugin offers to log them (Confirm/Auto/Manual modes)
4. BiS viewer shows your gear progress with equipped vs. BiS comparison
5. Gear sync reads your equipped items and updates your player card on the web app

Configuration

Settings Tab

• Auto-Log Mode — Confirm (dialog before logging), Auto (logs automatically), or Manual (overlay buttons only)
• Overlay Timing — Show on instance entry, duty complete, and/or loot window open
• Leave Warning — Warn when leaving with unclaimed priority loot
• BiS Highlighting — Highlight BiS items in Need/Greed and tome vendor windows

Advanced Tab

Override API and frontend URLs for local development/testing. Hidden behind a "Use custom URLs" checkbox — not needed for normal use.

Requirements

• FFXIV Raid Planner account with an API key
• Dalamud (XIVLauncher)
• FFXIV with a static group configured in the web app

Project Structure

XIVRaidPlannerPlugin/
  Plugin.cs                          # Entry point — wires services, events, lifecycle
  Configuration.cs                   # Persisted settings (Dalamud config)
  Api/
    RaidPlannerClient.cs             # HttpClient wrapper with Bearer auth
    Models.cs                        # C# DTOs (camelCase JSON <-> PascalCase C#)
  Services/
    TerritoryService.cs              # Detect savage raid instances (enter/exit events)
    PartyMatchingService.cs          # Match party members -> planner players
    LootDetectionService.cs          # Chat message loot parsing
    LeaveWarningService.cs           # Unclaimed priority loot warning
    ItemMappingService.cs            # BiS item ID lookup (O(1) dictionary + Lumina)
    BiSDataService.cs                # Fetch/cache player gear from API
    InventoryService.cs              # Read equipped gear, classify item sources
    AddonHighlightService.cs         # BiS highlighting in NeedGreed/shop addons
  Windows/
    ConfigWindow.cs                  # 4-tab settings + Advanced tab (ImGui)
    PriorityOverlayWindow.cs         # Priority overlay during raids
    BiSViewerWindow.cs               # BiS gear table with progress tracking
    LootConfirmationWindow.cs        # Confirm before logging a drop
    LeaveWarningWindow.cs            # "You have unclaimed loot" warning