ffxi-chronicle

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 19 Open GitHub ↗

A visual quest and mission tracker for Final Fantasy XI. Chronicle shows your completion progress across all quest areas and mission storylines, lets you browse entries with search and filters, and provides detailed guides with live inventory checking — all inside an interactive, clickable UI.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Chronicle

A visual quest and mission tracker for Final Fantasy XI. Chronicle shows your completion progress across all quest areas and mission storylines, lets you browse entries with search and filters, and provides detailed guides with live inventory checking — all inside an interactive, clickable UI.

![Chronicle overview](https://raw.githubusercontent.com/jintawk/ffxi-chronicle/master/screenshots/home.png)

## Features

- **Track quest completion** across all 11 quest areas with progress bars and percentages
- **Track mission completion** across 15 mission storylines (nation missions, expansion storylines, add-on scenarios, Assault, and Campaign)
- **Tabbed home view** — switch between Mission and Quest tabs to see overall progress for each category
- **Search and filter** entries by name, completion status, or sort order
- **Detailed guides** with start NPC, zone, rewards, fame requirements, and step-by-step walkthroughs
- **Live requirements checking** — see which items and key items you already own and which you still need
- **Quest/mission chain navigation** — click through Previous/Next links to follow multi-part chains
- **Scalable UI** — resize from 0.5x to 3.0x to suit your screen
- **Draggable and collapsible** window with per-character saved positions

## Installation

Copy the `chronicle` folder into your `Windower/addons/` directory, then load it in-game:

```
//lua load chronicle
```

To autoload on every login, add the line above to your `scripts/init.txt` file.

## Usage

Toggle the window with:

```
//cr
```

### Navigation

Chronicle uses a drill-down layout with three views. A breadcrumb bar at the top of the window lets you navigate back at any time.

#### Home View

The home screen has two tabs — **Missions** and **Quests** — letting you switch between the two categories. Each tab shows your overall completion and a grid of area cards. Each card displays the area name, number of completed entries, completion percentage, and a colour-coded progress bar. Click any card to drill into that area.

![Home view with area cards](https://raw.githubusercontent.com/jintawk/ffxi-chronicle/master/screenshots/home_quests.png)

#### Area View

The area view lists every quest or mission in the selected area. Each row shows the entry name, start NPC (for quests), and a status indicator. A toolbar at the top provides:

- **Search** — type to filter by name in real time
- **Sort** — order by Default (game ID), Name (alphabetical), or Status (active first)
- **Show** — filter to All, Completed, or Todo

Click any row to open its guide.

![Area view with quest list, search, and filters](https://raw.githubusercontent.com/jintawk/ffxi-chronicle/master/screenshots/area_view.png)

#### Guide View

The guide view shows everything you need to complete a quest or mission:

- **Status badge** — Completed, Active, Not Started, or Repeatable
- **Metadata** — Start NPC, zone with coordinates, reward, fame requirement, title, and repeatable status
- **Requirements checklist** — items and key items needed, with live OWNED/MISSING status pulled from your inventory, satchel, sack, case, wardrobe, safe, storage, and temporary items
- **Chain links** — clickable Previous and Next links to follow multi-part quest chains or mission storylines
- **Walkthrough** — step-by-step guide text (sourced from BG Wiki)
- **Notes** — additional tips where available

![Guide view with requirements and walkthrough](https://raw.githubusercontent.com/jintawk/ffxi-chronicle/master/screenshots/guide_view.png)

## Commands

| Command | Description |
|---|---|
| `//cr` | Toggle the window |
| `//cr show` | Show the window |
| `//cr hide` | Hide the window |
| `//cr compact` | Toggle collapsed/expanded mode |
| `//cr home` | Navigate to the home view |
| `//cr reset` | Reset window position to default |
| `//cr refresh` | Rebuild the UI with current data |
| `//cr size` | Show current UI scale |
| `//cr size +` / `//cr size -` | Increase or decrease scale by 0.1 |
| `//cr size <number>` | Set scale directly (0.5 to 3.0) |
| `//cr size reset` | Reset scale to 1.0 |
| `//cr autoshow` | Toggle auto-show on login |
| `//cr uncompletable` | Toggle visibility of quests that can no longer be completed |
| `//cr q` | Print quest summary to chat |
| `//cr q <area>` | Print quest detail for an area to chat |
| `//cr m` | Print mission summary to chat |
| `//cr m <area>` | Print mission detail for an area to chat |
| `//cr help` | Show help text in chat |

## Settings

Settings are saved per-character and persist between sessions. The following are stored automatically:

- **Window position** — drag the title bar to reposition
- **UI scale** — adjusted via `//cr size`
- **Sort and filter modes** — last-used sort order and show filter
- **Active tab** — whether the home view defaults to Missions or Quests
- **Visibility and collapse state** — whether the window is shown and/or collapsed on load
- **Show uncompletable** — whether quests that can no longer be completed are visible and counted

Settings are stored in `addons/chronicle/data/settings.xml`.

## Quest Areas

Chronicle covers all 11 quest regions in FFXI:

- San d'Oria
- Bastok
- Windurst
- Jeuno
- Other Areas
- Outlands
- Aht Urhgan (Treasures of Aht Urhgan)
- Crystal War (Wings of the Goddess)
- Abyssea
- Adoulin (Seekers of Adoulin)
- Coalition

## Mission Storylines

Chronicle tracks 15 mission categories:

- San d'Oria Missions
- Bastok Missions
- Windurst Missions
- Rise of the Zilart
- Chains of Promathia
- Treasures of Aht Urhgan
- Wings of the Goddess
- A Crystalline Prophecy
- A Moogle Kupo d'Etat
- A Shantotto Ascension
- Seekers of Adoulin
- Rhapsodies of Vana'diel
- The Voracious Resurgence
- Assault
- Campaign

## Technical Notes

### Mission Packet Parsing

Chronicle reads mission and quest state from incoming packet `0x056`, which the server sends on zone-in. Each sub-type carries data for a different quest region or mission storyline (see `libs/packets/fields.lua` for definitions).

Most mission lines track completion via bitflag packets (one bit per mission), but several "linear" storylines — COP, SOA, ROV, ACP, MKD, ASA, and TVR — only send a "current mission" integer. Chronicle infers completion from this: every mission before the current one is marked completed.

### TVR (The Voracious Resurgence) High-Bit Flag

TVR mission state arrives in packet `0x056` sub-type `0xFFFE` as a signed 32-bit integer at offset `0x04`. Unlike other linear mission lines, TVR allows the player to have **no active mission** after completing one (you don't automatically start the next). The server encodes this using bit 31 of the integer:

| Bit 31 | Meaning | Lower 31 bits |
|---|---|---|
| Clear (positive value) | Player has a mission in progress | Value near the active mission's DAT ID |
| Set (negative as signed int) | Player has no active mission | Value near the next uncompleted mission's DAT ID |

When bit 31 is set, all missions with DAT IDs below the lower 31-bit value are completed. For example, a raw packet value of `0x800001CC` (lower bits = 460) means missions through "Koru-Moru's Hypothesis" (DAT ID 452) are completed and "Altennia Burns Bright" (DAT ID 460) has not been started.

Note: the packet value does not exactly match DAT mission IDs in either case. Chronicle uses a fuzzy lookup (largest map ID <= packet value) to resolve the correct mission. The remaining 28 bytes in the `0xFFFE` packet (after the integer) are confirmed to be unused zeros.

Other linear mission lines (COP, SOA, ROV, etc.) do not use this flag because their final missions stay permanently "active" once the storyline is complete — the player always has a current mission value > 0.

## Credits

- Quest data sourced from [BG Wiki](https://www.bg-wiki.com/), licensed under [CC BY-NC-SA 3.0](https://creativecommons.org/licenses/by-nc-sa/3.0/)
- Built for [Windower 4](https://www.windower.net/)

ffxi-chronicle

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README