1
Fork 0
mirror of https://github.com/redstrate/Auracite.git synced 2025-04-23 13:17:45 +00:00
Export your FFXIV character in portable, generic formats
Find a file
2024-10-31 18:18:34 -04:00
.github Add initial files 2024-09-29 17:50:19 -04:00
dalamud Support grabbing from misc player state from the plugin 2024-10-05 12:36:36 -04:00
src Add Qt UI and add a separate CLI target 2024-10-31 18:18:06 -04:00
templates Add program name to the HTML template 2024-10-31 18:18:14 -04:00
.gitignore Add Dalamud bin files to gitignore 2024-10-31 18:18:34 -04:00
build.rs Improve character_archive & prepare for future supported UI 2024-10-31 18:16:42 -04:00
Cargo.lock Improve character_archive & prepare for future supported UI 2024-10-31 18:16:42 -04:00
Cargo.toml Add Qt UI and add a separate CLI target 2024-10-31 18:18:06 -04:00
index.html Add Qt UI and add a separate CLI target 2024-10-31 18:18:06 -04:00
LICENSE Add initial files 2024-09-29 17:50:19 -04:00
README.md Add Qt UI and add a separate CLI target 2024-10-31 18:18:06 -04:00

Auracite

Export your FFXIV character in portable, generic formats.

In the eventual future, the official servers will shut down and the Lodestone will disappear. This tool exports your character's data in machine-readable JSON (so it can be imported by something else) and a Lodestone-like HTML page which you can display in your browser.

Usage

CLI

Provide a character name via --name:

auracite --name "John Doe" 

The tool will create a new folder with the name "John Doe", which will contain the available data. See the table below for the currently supported data that can be recorded. You may want to check out the character.html file that can be viewed locally in your browser.

This tool makes several HTTP requests to the Lodestone, but they currently are only a few. The tool does not contact any 3rd-party external services.

Dalamud Mode

Auracite can only collect so much data from the Lodestone, some data can only be collected when logged in. To do this, we provide a Dalamud plugin to run alongside the tool. The plugin is currently available in my personal Dalamud repository.

When running the tool, append the --dalamud argument. It will walk you through starting the plugin. The plugin can be safely removed if you're done using Auracite.

Supported Data

Data Supported Notes
Name
World/Data Center
Race/Subrace/Gender
City-state
Nameday
Guardian
Portrait/Full-body Images These are the images displayed on the Lodestone.
Playtime Requires the Dalamud plugin.
Currencies 〰️ Only gil is supported, and requires the Dalamud plugin.
Appearance Data 〰️ Only some appearance data, and requires the Dalamud plugin.
Misc. state 〰️ Mentor and novice status, also player commendations. Requires the Dalamud plugin.

Currently, more types of data is planned to be supported in the future.

License

This project is licensed under the GNU Affero General Public License 3.