Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Robert5204/FFLogsUploader/llms.txt

Use this file to discover all available pages before exploring further.

The FFLogs Uploader plugin stores all its settings through Dalamud’s built-in configuration system. Settings are saved automatically whenever you interact with the login or main window — you never need to edit a file by hand. The config file is written to:
%APPDATA%\XIVLauncher\pluginConfigs\FFLogsPlugin.json
Never edit FFLogsPlugin.json directly while the game is running. The plugin reads configuration at startup and writes it on change; manual edits made while the game is open will be overwritten.

Credential settings

Email
string
The email address associated with your FFLogs account. Stored in plain text — used only to pre-fill the login form when RememberCredentials is enabled.
Password
string
Your FFLogs account password. Never stored in plain text. The plugin encrypts and decrypts the password transparently:
  • Windows: DPAPI (ProtectedData), bound to the current Windows user account.
  • Linux / Wine: AES-256-CBC with a PBKDF2-derived key (100,000 iterations, SHA-256) using a random per-install salt.
The raw encrypted bytes are saved as EncryptedPassword in the config file. If you migrate your config to a different machine or platform, saved credentials will fail to decrypt and you will be prompted to log in again.
RememberCredentials
boolean
default:"false"
When true, the plugin saves your email and encrypted password and automatically fills them in the login form on the next session. Disable this if you share a Windows account with other users or want to log in manually each time.

FFLogs API v2 credentials

These credentials are used by the parse viewer to fetch rankings and percentiles via the FFLogs GraphQL API. They are separate from your login password and are obtained from fflogs.com/api/clients.
ApiClientId
string
The OAuth client ID for your FFLogs API v2 application. Required to display parse percentiles in the parse viewer tab.
ApiClientSecret
string
The OAuth client secret paired with ApiClientId. Stored alongside the client ID in the config file.
Treat your client secret like a password. Do not share your FFLogsPlugin.json file if it contains API credentials.

Upload settings

LogDirectory
string
Absolute path to the directory containing your ACT FFXIV log files. The plugin auto-detects this at:
%APPDATA%\Advanced Combat Tracker\FFXIVLogs
The path must end with FFXIVLogs and the directory must contain at least one .log file for the plugin to accept it. If you point the field at a specific log file, the plugin will use that file’s parent directory and auto-select the most recently modified log in it.
Region
integer
default:"1"
The FFLogs server region API value for uploads. Must be one of:
ValueRegion
1North America (NA)
2Europe (EU)
3Japan (JP)
6Oceania (OC)
Choose the region that matches your game server’s data center. See FFLogs server regions for guidance.
Visibility
integer
default:"1"
Controls who can view uploaded reports on fflogs.com. Must be one of:
ValueVisibility
0Public — anyone can find and view the report
1Private — only you can view the report
2Unlisted — viewable by anyone with the direct link
Defaults to 1 (Private). You can change visibility for individual uploads from the main window.
SelectedGuildId
string | null
default:"null"
The FFLogs guild ID to upload reports under. When null, reports are uploaded as personal logs attached to your account. When set to a guild ID string, the report appears under that guild’s log list on fflogs.com.The guild ID is selected from a dropdown populated with guilds returned by the FFLogs API at login. You cannot enter an arbitrary ID here — the ID must correspond to a guild your account belongs to.

Build docs developers (and LLMs) love