further refactor and improvements

README.md

@@ -1,6 +1,10 @@
-# FFXIV-Journey
+# FFXIV Journey
 
-Track your main story quest journey with the utmost ease.
+![Title](image.png)
+
+Sveltekit static site for tracking FFXIV MSQ quest progress.
+
+The goal is to provide a **simple but well designed** way to track your progress whilst being **self-updating from open source datamining** sources.
 
 ## TODO
 

data/prepare_quest_data.py

@@ -2,6 +2,7 @@
 import json
 import requests
 import time
+
 from tqdm import tqdm
 from io import StringIO
 
@@ -81,7 +82,7 @@ def convert_expansion_number_to_name(expansion_number):
             "#": row["#"],
             "Id": row["Id"],
             "Name": row["Name"],
-            "Expansion": expansion_name,
+            "ExpansionName": expansion_name,
             "EventIconType": row["EventIconType"],
             "PreviousQuests": [row[col] for col in ["PreviousQuest[0]", "PreviousQuest[1]", "PreviousQuest[2]", "PreviousQuest[3]"] if not pd.isna(row[col])],
             "NextMSQ": None,  # Initialize as None, to be filled later
@@ -161,7 +162,7 @@ def convert_expansion_number_to_name(expansion_number):
 quests_by_expansion = {}
 
 for quest in quests_by_number.values():
-    expansion = quest["Expansion"]
+    expansion = quest["ExpansionName"]
     starting_location = quest["StartingLocation"] if quest["StartingLocation"] else "Main Quest Line"
 
     if expansion not in quests_by_expansion:
@@ -173,7 +174,7 @@ def convert_expansion_number_to_name(expansion_number):
     quests_by_expansion[expansion][starting_location].append(quest)
 
 # Extract A Realm Reborn quests
-arr_quests = [quest for quest in quests_by_number.values() if quest["Expansion"] == "A Realm Reborn"]
+arr_quests = [quest for quest in quests_by_number.values() if quest["ExpansionName"] == "A Realm Reborn"]
 
 # Function to order quests based on the NextMSQ path, considering StartingLocation
 def order_quests_by_next_msq(quests, location=None):

src/lib/model.d.ts

@@ -3,23 +3,25 @@
  */
 
 export type Quest = {
-  "#": number; // Unique identifier for the quest
-  Id: string; // Quest identifier string
-  Name: string; // Name of the quest
-  Expansion: "A Realm Reborn" | "Heavensward" | "Stormblood" | "Shadowbringers" | "Endwalker" | "Dawntrail"; // Expansion name
-  EventIconType: number; // Event icon type, representing the type of quest (3 for MSQ)
-  PreviousQuests: number[]; // Array containing up to 4 previous quest IDs
-  NextMSQ: number | null; // ID of the next MSQ quest or null if none
-  StartingLocation: "Gridania" | "Limsa Lominsa" | "Ul'dah" | null; // Starting location or null if not applicable
-  Image: string | null; // Path to the quest image or null if not available
+  "#": number;                     // Unique identifier for the quest
+  Id: string;                      // Quest identifier string
+  Name: string;                    // Name of the quest
+  ExpansionName: string;           // Expansion name
+  EventIconType: number;           // Event icon type, representing the type of quest (3 for MSQ)
+  PreviousQuests: number[];        // Array containing up to 4 previous quest IDs
+  NextMSQ: number | null;          // ID of the next MSQ quest or null if none
+  StartingLocation: string | null; // Starting location or null if not applicable
+  Image: string | null;            // Path to the quest image or null if not available
+};
+
+export type Quests = {
+  [group: string]: Quest[];
 };
 
 export type Expansion = {
   name: string;
-  quests: {
-    [location: string]: Quest[];
-  };
+  quests: Quests;
 }
 
-export type Quests = Array<Expansion>;
+export type ExpansionsQuests = Array<Expansion>;
 

src/lib/stores/questsStore.ts

@@ -1,23 +1,26 @@
 import { writable, get } from "svelte/store";
-import type { Quests, Quest } from "$lib/model";
+import type { ExpansionsQuests, Quest } from "$lib/model";
 
 const LOCAL_STORAGE_KEY = "ffxiv-journey:completed";
 
+// Types
+export type ExpansionProgress = { percent: number; completed: number; total: number }
+
 // Store for quests
-export const quests = writable<Quests>([]);
-export const filteredQuests = writable<Quests>([]);
+export const quests = writable<ExpansionsQuests>([]);
+export const filteredQuests = writable<ExpansionsQuests>([]);
 export const completedQuests = writable<Record<number, boolean>>(
   JSON.parse(localStorage.getItem(LOCAL_STORAGE_KEY) || "{}")
 );
-export const progress = writable<Record<string, { percent: number; completed: number; total: number }>>({});
+export const progress = writable<Record<string, ExpansionProgress>>({});
 export const loading = writable<boolean>(true);
 export const currentExpansion = writable<string>("");
 
-export function saveCompletedQuests() {
+export function storeCompletedQuests() {
   localStorage.setItem(LOCAL_STORAGE_KEY, JSON.stringify(get(completedQuests)));
 }
 
-export function calculateProgress(expansionName: string) {
+export function CalculateExpansionProgress(expansionName: string) {
   const $quests = get(quests);
   const expansion = $quests.find((exp) => exp.name === expansionName);
   if (!expansion) return { percent: 0, completed: 0, total: 0 };
@@ -42,10 +45,10 @@ export function calculateProgress(expansionName: string) {
 
 export function calculateAllProgress() {
   const $quests = get(quests);
-  const newProgress: Record<string, { percent: number; completed: number; total: number }> = {};
+  const newProgress: Record<string, ExpansionProgress> = {};
 
   for (const expansion of $quests) {
-    newProgress[expansion.name] = calculateProgress(expansion.name);
+    newProgress[expansion.name] = CalculateExpansionProgress(expansion.name);
   }
 
   progress.set(newProgress);
@@ -87,8 +90,9 @@ export function toggleQuestCompletion(quest: Quest, isChecked: boolean) {
     });
   }
 
-  saveCompletedQuests();
+  storeCompletedQuests();
   calculateAllProgress();
+  updateCurrentExpansion();
 }
 
 export function updateCurrentExpansion() {