Skip to content

NexusFFXIV/PlayerNexusTracker

PlayerNexusTracker

A Dalamud plugin for FINAL FANTASY XIV, built on NexusKit + NexusKit.Modules.

Build CodeQL Release Dalamud API .NET License: AGPL v3

Overview

PlayerNexusTracker tracks players you meet in FFXIV — locally observed sessions plus optional enrichment from public sources (Lodestone, FFXIVCollect). It is the reference consumer of the NexusKit framework: see how the framework's hosting, persistence, IPC, UI, and module systems get wired together in a real plugin.

Install (as a player)

  1. Open Dalamud's Settings → Experimental tab.
  2. Under Custom Plugin Repositories, paste the NexusFFXIV repo URL and hit Save:
    https://raw.githubusercontent.com/NexusFFXIV/DalamudRepo/main/pluginmaster.json
    
  3. Reopen Settings → Experimental if needed and tick the new entry as Enabled.
  4. Open /xlplugins, switch to All Plugins, search PlayerNexusTracker, Install.

Testing builds (opt-in)

Tick Settings → Experimental → Get plugin testing builds to surface pre-release versions when available. Testing builds are tagged vX.Y.Z-rc.N in this repo and ship through the same Dalamud repo URL — non-testers continue to see only stable releases.

The standard Dalamud repo channel will follow once the plugin matures.

Build from source

git clone https://github.com/NexusFFXIV/PlayerNexusTracker.git
cd PlayerNexusTracker

# Configure access to NexusKit packages on GitHub Packages
# 1. Create a classic PAT at https://github.com/settings/tokens with scope: read:packages
# 2. Set it as a User env var:
[System.Environment]::SetEnvironmentVariable("GITHUB_PACKAGES_PAT", "<your_pat>", "User")
# (restart PowerShell so the var is visible)

dotnet build PlayerNexusTracker.sln -c Debug -p:Platform=x64

Output lands at PlayerNexusTracker.Plugin/bin/x64/Debug/PlayerNexusTracker.dll — the path XIVLauncher's dev-plugin loader expects.

Architecture

PlayerNexusTracker is intentionally thin: most of the heavy lifting lives in NexusKit + NexusKit.Modules. The plugin itself contains:

  • Composition wiring (Composition/PluginServiceCollectionExtensions.cs) — services.AddNexusKitX() calls
  • Plugin-specific notification producers (FC events, history events, …)
  • Plugin-specific UI windows
  • Localization resources (English + German)

For the framework architecture, see NexusKit/docs/architecture.md.

Contributing

Issue reports welcome. Code contributions accepted under AGPL-3.0-only.

License

AGPL-3.0-only. This plugin and its derivative works must stay open under the same license.

About

FFXIV Dalamud plugin: successor to PlayerTrack/PlayerNexus

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages