Skip to content

Repository files navigation

The XIV Shinies mascot holding a teal gem

XIV Shinies Sync

Your collections, on xiv-shinies.com, the moment you earn them.

🌐 xiv-shinies.com  ·  💬 Discord  ·  💛 Sponsor

A Dalamud plugin for Final Fantasy XIV that automatically records your collection progress on XIV Shinies. New unlocks — quests, achievements, mounts, minions, and more — appear on the site within seconds, and everything else syncs automatically in the background, so you stop hand-marking what you already earned.

The settings window: sync status, collection toggles, and the branded header

How it works

The plugin reads completion facts directly from your own game client and uploads them over HTTPS to XIV Shinies, which does all the derivation server-side. A plugin upload is first-party evidence from inside the game client, so it verifies character ownership and outranks a Lodestone scrape. The plugin itself is deliberately a dumb fact-reader: it sends only raw facts the game knows and never computes site concepts like relic steps — which keeps it stable as the site grows new collections and rules.

Quests, Achievements, Mounts, Minions and Orchestrion rolls upload within seconds of the unlock, because the game announces those the moment they happen.

Everything else travels with the periodic full sync, or immediately when you press Sync now: Tracked items (the item counts that prove relic progress), Quest progress, Triple Triad cards, Triple Triad NPCs, Occult records and Phantom jobs.

What gets sent

Only your own local character's collection facts, and only for the categories you opt into:

  • Completed quest IDs
  • Unlocked achievement, mount, and minion IDs
  • Unlocked orchestrion roll IDs — the tunes playable from your orchestrion list, not the unused roll items sitting in your bags
  • Collected Triple Triad card IDs, and the IDs of the game's own Triple Triad NPCs you have defeated — computer opponents, never other players
  • Possession counts for the specific relic-stage items the server asks about — checked across your inventory, armoire, glamour dresser, saddlebag, and retainers
  • Phantom job levels and experience, read while you are inside the Occult Crescent, and your knowledge level when you open the review window yourself
  • Discovered occult record IDs
  • Live Occult Crescent instance state, while you are inside one: which critical encounters, FATEs, and Forked Tower windows are up in your instance, and which world you are on, powering the site's live occult tracker on the right data center. This is world state — nothing about you beyond your presence in the instance, and never anything about other players. It starts enabled (the setup wizard shows the ticked box before anything sends) and can be switched off any time in the settings. If XIV Shinies has the tracker switched off while you are setting up, the wizard cannot offer you that box — so it starts off instead, and you can turn it on from the settings whenever you like

For a collection the plugin can read end to end, the upload also records that the list is complete. That is what lets the site point out something you marked by hand that the plugin did not find, so you can review it — nothing is ever unmarked for you.

Your character is identified by a one-way fingerprint computed on your machine — the raw ContentId never leaves the game process, and never lands in logs or config. Your character's name and home world are sent so the site can match the character you already claimed. Nothing about other players is ever read or sent.

The exact wire format is documented in docs/api-contract.md; the deployed XIV Shinies server is its authority. How each Dalamud rule is satisfied is documented rule-by-rule in docs/dalamud-compliance.md.

Fully opt-in

Nothing uploads until you finish a short first-run setup that shows exactly what each collection sends and asks you to switch categories on explicitly. Every category — and syncing as a whole — can be toggled at any time from the settings window (/shinies).

Setup also offers to start collections added by later updates already switched on, so that if you always opt in you are not asked every time. It is off unless you tick it, and either way a new collection is marked New in the settings until you have seen it.

The first-run wizard: what it sends, and your privacy, before anything uploads

See exactly what was sent

The settings window keeps a Recent uploads log: every upload's time, trigger, outcome, and per-category counts, with changes since the previous upload highlighted. Copy log puts a plain-text version on your clipboard for bug reports — it carries counts, outcomes, and failure diagnostics only, never IDs or character identity. The log lives in memory and clears when the plugin unloads.

The Recent uploads log: per-upload counts, outcomes, and change highlights

Installing

From the plugin repository

  1. In-game, open /xlsettingsExperimental.

  2. Add this URL under Custom Plugin Repositories:

    https://raw.githubusercontent.com/XIV-Shinies/xiv-shinies-plugin/main/repo.json
    
  3. Save, then install XIV Shinies Sync from /xlplugins.

For development

See CONTRIBUTING.md for prerequisites, building, loading the dev plugin in-game, and the project's testing philosophy.

Contributing, security, and AI disclosure

License

MIT © Noranda

About

Dalamud plugin that syncs your FFXIV collection progress to XIV Shinies, the moment you earn it.

Topics

Resources

Contributing

Security policy

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages