v9.7.2: Ebonhold Database integration and core logic refinements
This commit is contained in:
+264
@@ -0,0 +1,264 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Questie (3.3.5a) - Developer Documentation</title>
|
||||
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&display=swap" rel="stylesheet">
|
||||
<style>
|
||||
:root {
|
||||
--bg-primary: #0d1117;
|
||||
--bg-secondary: #161b22;
|
||||
--bg-tertiary: #21262d;
|
||||
--text-primary: #c9d1d9;
|
||||
--text-secondary: #8b949e;
|
||||
--accent-green: #3fb950;
|
||||
--accent-blue: #58a6ff;
|
||||
--accent-purple: #a371f7;
|
||||
--accent-orange: #d29922;
|
||||
--border-color: #30363d;
|
||||
--code-bg: #1b1f23;
|
||||
}
|
||||
|
||||
* {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
body {
|
||||
font-family: 'Inter', -apple-system, BlinkMacSystemFont, 'Segoe UI', sans-serif;
|
||||
background: var(--bg-primary);
|
||||
color: var(--text-primary);
|
||||
line-height: 1.6;
|
||||
}
|
||||
|
||||
.hero {
|
||||
background: linear-gradient(135deg, #1c2128 0%, #0d1117 100%);
|
||||
padding: 80px 20px;
|
||||
text-align: center;
|
||||
border-bottom: 1px solid var(--border-color);
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.hero h1 {
|
||||
font-size: 3rem;
|
||||
font-weight: 700;
|
||||
margin-bottom: 15px;
|
||||
background: linear-gradient(135deg, var(--accent-blue), var(--accent-purple));
|
||||
-webkit-background-clip: text;
|
||||
-webkit-text-fill-color: transparent;
|
||||
background-clip: text;
|
||||
}
|
||||
|
||||
.hero .subtitle {
|
||||
font-size: 1.2rem;
|
||||
color: var(--text-secondary);
|
||||
max-width: 800px;
|
||||
margin: 0 auto 30px;
|
||||
}
|
||||
|
||||
.container {
|
||||
max-width: 1000px;
|
||||
margin: 0 auto;
|
||||
padding: 60px 20px;
|
||||
}
|
||||
|
||||
section {
|
||||
margin-bottom: 80px;
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-size: 1.8rem;
|
||||
margin-bottom: 30px;
|
||||
padding-bottom: 10px;
|
||||
border-bottom: 1px solid var(--border-color);
|
||||
color: var(--accent-blue);
|
||||
}
|
||||
|
||||
h3 {
|
||||
font-size: 1.3rem;
|
||||
margin: 30px 0 15px;
|
||||
color: var(--text-primary);
|
||||
}
|
||||
|
||||
p {
|
||||
margin-bottom: 15px;
|
||||
color: var(--text-secondary);
|
||||
}
|
||||
|
||||
code {
|
||||
font-family: 'SFMono-Regular', Consolas, 'Liberation Mono', Menlo, monospace;
|
||||
background: var(--bg-tertiary);
|
||||
padding: 2px 6px;
|
||||
border-radius: 4px;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
|
||||
pre {
|
||||
background: var(--code-bg);
|
||||
padding: 20px;
|
||||
border-radius: 8px;
|
||||
border: 1px solid var(--border-color);
|
||||
overflow-x: auto;
|
||||
margin: 20px 0;
|
||||
}
|
||||
|
||||
pre code {
|
||||
background: none;
|
||||
padding: 0;
|
||||
color: #e6edf3;
|
||||
}
|
||||
|
||||
.grid {
|
||||
display: grid;
|
||||
grid-template-columns: 1fr 1fr;
|
||||
gap: 30px;
|
||||
margin: 30px 0;
|
||||
}
|
||||
|
||||
.card {
|
||||
background: var(--bg-secondary);
|
||||
padding: 30px;
|
||||
border-radius: 12px;
|
||||
border: 1px solid var(--border-color);
|
||||
}
|
||||
|
||||
.card h4 {
|
||||
color: var(--accent-green);
|
||||
margin-bottom: 10px;
|
||||
font-size: 1.1rem;
|
||||
}
|
||||
|
||||
.important {
|
||||
background: rgba(210, 153, 34, 0.1);
|
||||
border-left: 4px solid var(--accent-orange);
|
||||
padding: 15px 20px;
|
||||
margin: 20px 0;
|
||||
border-radius: 0 4px 4px 0;
|
||||
}
|
||||
|
||||
footer {
|
||||
text-align: center;
|
||||
padding: 40px;
|
||||
border-top: 1px solid var(--border-color);
|
||||
color: var(--text-secondary);
|
||||
font-size: 0.9rem;
|
||||
}
|
||||
|
||||
.file-path {
|
||||
color: var(--accent-purple);
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
@media (max-width: 768px) {
|
||||
.grid { grid-template-columns: 1fr; }
|
||||
.hero h1 { font-size: 2.2rem; }
|
||||
}
|
||||
</style>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<div class="hero">
|
||||
<h1>Questie (3.3.5a)</h1>
|
||||
<p class="subtitle">Developer documentation for Project Ascension & Project Ebonhold compatibility layers and core engine refinements.</p>
|
||||
<div style="display: flex; justify-content: center; gap: 10px;">
|
||||
<code>Version: v9.7.2</code>
|
||||
<code>Branch: feature/ebonhold-compat</code>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="container">
|
||||
<!-- Database Architecture -->
|
||||
<section id="database">
|
||||
<h2>Ebonhold Database Architecture</h2>
|
||||
<p>To support custom servers without polluting the base WotLK database, Questie now implements a modular override system. This allows custom quests, NPCs, and objects to be defined in a safe namespace that persists across upstream updates.</p>
|
||||
|
||||
<h3>1. Directory Structure</h3>
|
||||
<pre><code>Database/Ebonhold/
|
||||
├── EbonholdLoader.lua # Main injection hook
|
||||
├── Zones/
|
||||
│ └── EbonholdZoneTables.lua # Custom AreaID/MapID mappings
|
||||
└── Ebonhold/
|
||||
├── EbonholdQuestDB.lua # Custom Quest definitions
|
||||
└── EbonholdNpcDB.lua # Custom NPC spawn overrides</code></pre>
|
||||
|
||||
<h3>2. Injection Methodology</h3>
|
||||
<p>The system hooks into <code>QuestieDB:Initialize()</code>. Instead of modifying <code>QuestieDB.questData</code> directly, it populates the override tables which are checked during quest retrieval.</p>
|
||||
<pre><code>-- EbonholdLoader.lua snippet
|
||||
local function InjectOverrides()
|
||||
for id, data in pairs(EbonholdDB.questData) do
|
||||
QuestieDB.questDataOverrides[id] = data
|
||||
end
|
||||
end</code></pre>
|
||||
</section>
|
||||
|
||||
<!-- Logic Refinements -->
|
||||
<section id="logic-refinements">
|
||||
<h2>Core Logic Refinements</h2>
|
||||
|
||||
<div class="grid">
|
||||
<div class="card">
|
||||
<h4>Quest Arrow: Auto-Mode</h4>
|
||||
<p>Restored "Auto Nearby" logic which points to the closest available quest when the player has no active tracking list. Features <strong>Zone Filtering</strong> to prevent the arrow from pointing to distant continents when in auto-mode.</p>
|
||||
</div>
|
||||
<div class="card">
|
||||
<h4>Tracker Robustness</h4>
|
||||
<p>The tracker update loop is now protected with <code>pcall</code>. This prevents malformed quest data (like the "Fel Orc Scavengers" bug) from crashing the entire UI and hiding unrelated quests.</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3>Quest Icon Persistence Fix</h3>
|
||||
<p>Custom server quests often use auto-complete triggers which can bypass Questie's standard cleanup events. We implemented a two-tier cleanup strategy:</p>
|
||||
<ul>
|
||||
<li><strong>Delayed Verification</strong>: A 500ms check after <code>QuestComplete</code> to catch lingering frames.</li>
|
||||
<li><strong>Periodic Cleanup</strong>: A 5-second background timer in <code>AvailableQuests.lua</code> that audits the map for icons belonging to finished quests.</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
<!-- Custom Quest Implementation -->
|
||||
<section id="custom-quests">
|
||||
<h2>Custom Quest Implementation</h2>
|
||||
<p>For large-scale "kill count" quests (e.g., 75 Dragonkin), we utilize the <code>killCreditObjective</code> pattern. This allows a single quest objective to be mapped to a dynamic list of NPC IDs.</p>
|
||||
|
||||
<div class="important">
|
||||
<strong>Developer Note:</strong> Using <code>killCreditObjective</code> (Index [10][5]) ensures that all participating NPC spawns appear on the map, but only <strong>one</strong> counter appears in the tracker.
|
||||
</div>
|
||||
|
||||
<pre><code>-- Example implementation (EbonholdQuestDB.lua)
|
||||
[50064] = {
|
||||
[1] = "Heart of the Dragonflights",
|
||||
[10] = {
|
||||
nil, nil, nil, nil,
|
||||
{ -- killCreditObjective
|
||||
{
|
||||
{ 26276, 26277, 26322, ... }, -- All NPC IDs
|
||||
26322, -- Root ID (Icon/Text)
|
||||
"Dragonkin slain" -- Display Text
|
||||
}
|
||||
}
|
||||
},
|
||||
[30] = 30, -- Objective Count
|
||||
}</code></pre>
|
||||
</section>
|
||||
|
||||
<!-- Automated Text Retrieval -->
|
||||
<section id="automated-learning">
|
||||
<h2>Automated Learning (Self-Learning)</h2>
|
||||
<p>When Questie encounters a Quest ID that exists in the player's log but is missing from the local database, it triggers a <strong>Runtime Learning event</strong>.</p>
|
||||
<ol>
|
||||
<li>Scans <code>GetQuestLogTitle(index)</code> for the missing ID.</li>
|
||||
<li>Calls <code>QuestieLearner:OnQuestAccepted</code> to populate overrides.</li>
|
||||
<li>Immediately re-injects the data using <code>InjectLearnedData</code>.</li>
|
||||
<li>Retries the tracker render without requiring a UI reload.</li>
|
||||
</ol>
|
||||
</section>
|
||||
</div>
|
||||
|
||||
<footer>
|
||||
<p>Maintained by Xurkon • Part of the Project Ebonhold Addon Suite</p>
|
||||
</footer>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
Reference in New Issue
Block a user