redstrate/auracite
1
Fork 0
mirror of https://github.com/redstrate/Auracite.git synced 2025-04-20 11:47:47 +00:00
Code Activity

Update README for the latest features

Browse source
This commit is contained in:
Joshua Goins 2024-11-01 19:21:11 -04:00
parent 315b0b3750
commit 06fd0f2c03
1 changed files with 17 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -8,6 +8,17 @@ you can display in your browser.
## Usage ## Usage
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.
### Web
Auracite can run inside your web browser, accessed at [auracite.xiv.zone](https://auracite.xiv.zone/). It has the same features as the regular version.
### Desktop
A desktop version is available, just run `cargo run`. There is currently no binary distribution available.
### CLI ### CLI
Provide a character name via `--name`: Provide a character name via `--name`:
@ -16,20 +27,13 @@ Provide a character name via `--name`:
auracite --name "John Doe" 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 To enable support for the Dalamud plugin, add `--dalamud`.
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 ### Dalamud Mode
Auracite can only collect so much data from the Lodestone, some data can only be collected when logged in. To do this, 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 we provide a Dalamud plugin to run alongside the tool. The plugin is currently available
[in my personal Dalamud repository](https://github.com/redstrate/DalamudPlugins). [in my personal Dalamud repository](https://github.com/redstrate/DalamudPlugins). The plugin can be
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. safely removed if you're done using Auracite.
## Supported Data ## Supported Data
@ -44,9 +48,10 @@ safely removed if you're done using Auracite.
| Guardian | ✅ | | | Guardian | ✅ | |
| Portrait/Full-body Images | ✅ | These are the images displayed on the Lodestone. | | Portrait/Full-body Images | ✅ | These are the images displayed on the Lodestone. |
| Playtime | ✅ | Requires the Dalamud plugin. | | Playtime | ✅ | Requires the Dalamud plugin. |
| Currencies | 〰️ | Only gil is supported, and 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. | | Appearance Data | ✅ | Requires the Dalamud plugin. |
| Misc. state | 〰️ | Mentor and novice status, also player commendations. Requires the Dalamud plugin. | | Adventurer Plate | ✅ | 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. Currently, more types of data is planned to be supported in the future.