Skip to content

CozmicDev/Treasure-Maps-Tracker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

2 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Treasure Map Tracker Plugin for Final Fantasy XIV

A comprehensive Dalamud plugin for tracking treasure map activities, including loot drops, portal spawn rates, and detailed statistics.

Features

πŸ—ΊοΈ Map Tracking

  • Map Completion Counter: Tracks how many of each map type you've completed
  • All Map Types Supported: From Timeworn Leather Maps to Timeworn Gargantuaskin Maps
  • Manual Entry: Add missed map completions manually

πŸŒ€ Portal Statistics

  • Portal Spawn Tracking: Automatically detects when portals spawn
  • Spawn Rate Calculation: Shows actual vs expected portal spawn rates
  • Historical Data: View your portal luck over time
  • Expected Rates: Built-in knowledge of official portal spawn rates

πŸŽ’ Loot Tracking

  • Automatic Detection: Tracks all items obtained from treasure chests
  • Player Attribution: Records who received each item
  • Quantity Tracking: Counts total quantities of each item
  • High Quality Detection: Distinguishes between normal and HQ items
  • Loot History: Detailed log of all treasure hunt rewards

πŸ“Š Statistics & Analysis

  • Overview Dashboard: Quick summary of your treasure hunting activities
  • Detailed Reports: In-depth analysis of your treasure hunting performance
  • Item Distribution: See who in your group gets what items
  • Success Rates: Track your portal spawn luck

Installation

  1. Prerequisites:

    • Final Fantasy XIV with Dalamud installed
    • .NET 8.0 SDK for building
  2. Building the Plugin:

    git clone <repository-url>
    cd Dalamud-Plugin
    dotnet build
  3. Installation:

    • Copy the built plugin files to your Dalamud plugins directory
    • Enable the plugin in Dalamud settings

Usage

Basic Commands

  • /tmtracker - Opens the main Treasure Map Tracker interface

Interface Overview

πŸ“ˆ Overview Tab

  • Summary statistics of all your treasure hunting
  • Recent loot activity
  • Quick access to settings

πŸ—ΊοΈ Map Statistics Tab

  • Detailed breakdown of maps completed by type
  • Portal spawn counts and rates for each map type
  • Sortable table for easy analysis

πŸŽ’ Loot History Tab

  • Complete history of all items obtained
  • Item summary with total quantities
  • Player distribution showing who got what
  • Detailed chronological log

πŸŒ€ Portal Stats Tab

  • Portal spawn rate analysis
  • Comparison with expected rates (based on wiki data)
  • Sample size tracking for statistical accuracy

✏️ Manual Entry Tab

  • Add missed map completions
  • Add missed portal spawns
  • Reset all data (use with caution!)

Configuration Options

  • Auto-track loot: Automatically detect treasure chest rewards
  • Show portal chances: Display expected vs actual portal rates
  • Show map counts: Track map completion statistics
  • Movable windows: Allow repositioning of interface windows

How It Works

Automatic Tracking

The plugin monitors game chat messages to detect:

  • Treasure map completions
  • Portal spawns
  • Loot distribution messages
  • Player names and item quantities

Portal Detection

Portal spawns are detected by monitoring for keywords like:

  • "portal"
  • "aquapolis"
  • "uznair"
  • "lyhe ghiah"
  • "excitatron"
  • "gymnasion agonon"
  • "cenote ja ja gural"
  • "vault oneiron"

Loot Detection

Loot is tracked by parsing messages matching patterns like:

  • "You obtain [item]"
  • "[Player] obtains [item]"
  • Quantity detection (e.g., "x5")
  • High Quality item detection

Supported Map Types

A Realm Reborn

  • Timeworn Leather Map (Grade 1)
  • Timeworn Goatskin Map (Grade 2)
  • Timeworn Toadskin Map (Grade 3)
  • Timeworn Boarskin Map (Grade 4)
  • Timeworn Peisteskin Map (Grade 5)
  • Unhidden Leather Map (Special)

Heavensward

  • Timeworn Archaeoskin Map (Grade 6)
  • Timeworn Wyvernskin Map (Grade 7)
  • Timeworn Dragonskin Map (Grade 8) - Portal: The Aquapolis

Stormblood

  • Timeworn Gaganaskin Map (Grade 9)
  • Timeworn Gazelleskin Map (Grade 10) - Portal: Lost/Shifting Canals of Uznair
  • Timeworn Thief's Map - Portal: Hidden Canals of Uznair

Shadowbringers

  • Timeworn Gliderskin Map (Grade 11)
  • Timeworn Zonureskin Map (Grade 12) - Portal: Dungeons/Shifting Oubliettes of Lyhe Ghiah

Endwalker

  • Timeworn Saigaskin Map (Grade 13)
  • Timeworn Kumbhiraskin Map (Grade 14) - Portal: The Excitatron 6000
  • Timeworn Ophiotauroskin Map (Grade 15) - Portal: The Shifting Gymnasion Agonon

Dawntrail

  • Timeworn Loboskin Map (Grade 16)
  • Timeworn Br'aaxskin Map (Grade 17) - Portal: Cenote Ja Ja Gural
  • Timeworn Gargantuaskin Map (Grade 18) - Portal: Vault Oneiron

Known Portal Rates

Based on community data and official information:

  • Grade 8+ Maps: ~50% portal spawn rate
  • Special Maps: 100% portal spawn rate
  • Lower Grade Maps: No portals

Tips for Accurate Tracking

  1. Party Play: The plugin works best when in a party where loot messages are shared
  2. Manual Verification: Double-check automatic tracking with manual entry when needed
  3. Consistent Use: Keep the plugin enabled during all treasure hunting sessions

Troubleshooting

Common Issues

  1. Missing Loot: Some items might not be detected due to message variations
    • Use Manual Entry tab to add missed items
  2. Portal Detection: Portal spawns might be missed if messages aren't in expected format
    • Manually add portal spawns in the Manual Entry tab
  3. Map Counting: Map completions rely on specific chat messages
    • Use Manual Entry to correct map counts

Data Storage

All tracking data is stored in your Dalamud plugin configuration:

  • Map completion counts
  • Portal spawn records
  • Complete loot history with timestamps
  • Player attribution for all items
  • Item quantity totals

The data persists between game sessions and plugin updates.

Contributing

This plugin is built using the Dalamud framework. Contributions are welcome for:

  • Improved message parsing
  • Additional statistical features
  • UI/UX improvements
  • Bug fixes and optimizations

License

This project is licensed under AGPL-3.0-or-later - see the LICENSE file for details.


Note: This plugin is not affiliated with Square Enix. Final Fantasy XIV Β© 2010-2024 SQUARE ENIX CO., LTD. All Rights Reserved.

About

First test plugin

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages