Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

72 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PoE2 Area Overlay

讀取 Path of Exile 2Client.txt,在地圖或場景切換時顯示自訂提示。

文檔導航

你是… 從這裡開始
玩家/使用者 docs/USER_GUIDE.md
開發者(改程式、看架構) docs/ARCHITECTURE.md
維護者(sprint / task / AI 協作) docs/PROJECT_WORKFLOW.mddocs/AI_AGENT_SETUP.md
編輯 BD 或區域 JSON docs/BUILD_JSON.mddocs/CREATE_BUILD.md(AI 生成)、下方「區域提示配置」
不確定讀哪份 docs/README.md(完整索引)

技術棧

  • Tauri 2 + Rust:監聽日誌、解析目前區域;PoE2 BD Manager 第二 exe 編輯 build JSON;PoE2 Catalog Dev 第三 exe 瀏覽 catalog
  • React + TypeScript:Overlay UI;BD Manager 與 Catalog Dev 獨立前端入口

架構細節、目錄說明、IPC 與開發命令見 docs/ARCHITECTURE.md。使用 Cursor / Codex 時,工具會額外讀取 AGENTS.md.cursor/rules/

文字編碼

專案統一 UTF-8 無 BOM(含 .ps1)。含中文的 JSON/原始碼請勿使用 GBK 或 Big5。
scripts/*.ps1 僅支援 PowerShell 7+pwsh),請勿用 Windows PowerShell 5.1 執行。
詳見 docs/ENCODING.md(含編輯器、Git、編譯器與 AI Agent 的支援說明)。

前置需求

  1. Node.js 18+
  2. Rust;Windows 需 MSVC 工具鏈
  3. PowerShell 7+pwsh;Windows 可 winget install Microsoft.PowerShell
  4. 遊戲內開啟:設定 > 介面 > 寫入日誌檔案

本地執行

cd D:\Project\POE2Overlay
npm.cmd install
npm.cmd run tauri -- dev

tauri dev 預設會同時啟動 OverlayPoE2 BD ManagerPoE2 Catalog Dev(共用 repo 下 data/)。架構見 ARCHITECTURE.md § 多應用架構;IA 見 I002-01

可用 --target 單啟指定 dev exe:

npm.cmd run tauri -- dev --target overlay
npm.cmd run tauri -- dev --target bd-manager
npm.cmd run tauri -- dev --target catalog-dev
npm.cmd run tauri -- dev --target all

請在 pwsh 終端執行。Windows 建議使用 npm.cmd,避免直接用 PowerShell 的 npm shim。

常用檢查/格式化:

npm.cmd run format
npm.cmd run check:format
npm.cmd run build

使用方式

  • 預設視窗會鼠標穿透。
  • 按住 Alt 才能點擊視窗,或拖動右下角調整大小。
  • 設定中可配置 Client.txt 路徑、透明度與 Dev 模式。

完整界面說明見 docs/USER_GUIDE.md

Catalog 資料配置

區域、技能、底材與詞綴資料以 data/catalog.db 為 runtime 來源;透過 PoE2 Catalog Dev 的資料管理流程抓取、清理、生成候選 DB、對比、編輯與發布。區域結構基準保留在 data/areasInfo_zh-TW.json;舊 areas.jsondata/skills/poe2_item_bases_tw.*poe2_modifiers_tw.* 已不再保留。

Catalog 中的繁中區域顯示名必須與日誌中 [SCENE] Set Source [區域名] 的區域名完全一致(UTF-8 位元組一致)。

日誌示例:

2026/05/18 20:40:46 ... [INFO Client 48816] [SCENE] Set Source [龍蜥濕地]

配置示例:

{
  "sections": [
    {
      "name": "ACT1",
      "town": {
        "name": "皆伐營地",
        "defaultHint": ""
      },
      "maps": [
        {
          "name": "龍蜥濕地",
          "hint": "注意濕地區域的怪物密度和遠程攻擊。",
          "rewards": [
            {
              "label": "支線事件",
              "text": "技能寶石 (lv2)",
              "priority": "H"
            }
          ],
          "townHint": ""
        }
      ]
    }
  ]
}

(null)(unknown) 會被忽略。

資料檔

  • data/catalog.db:runtime catalog DB;schema 1.0 見 docs/CATALOG_DB_SCHEMA.md
  • data/areasInfo_zh-TW.json:areas 結構基準,供 Catalog Dev 生成候選 DB。
  • data/build/*.json:BD 配置(裝備、技能階段、可選區域提示)。Schema 見 docs/BUILD_JSON.md;用 AI 從攻略生成見 docs/CREATE_BUILD.md
  • data/flask_reminders.jsondata/gem_reminders.json:藥劑與技能寶石等級提醒。
  • data/settings.example.json:設定範例;首次使用可複製為 data/settings.json(程式亦會在缺少時使用預設值)。
  • data/settings.jsondata/profile/*.json:本機使用者設定與角色進度(gitignore);不要提交個人路徑或實際 profile。

打包

Portable ZIP(推薦發佈方式)

npm.cmd install
pwsh -File scripts/build_portable_zip.ps1

腳本會執行 npm run tauri -- build(產出 三個 release exe),並在 release/ 產生含 poe2-area-overlay.exepoe2-bd-manager.exepoe2-catalog-dev.exedata/(含 catalog.db)的資料夾與 .zip(不含本機 settings.jsonprofile/*.json)。三個 exe 來自獨立 target 目錄(src-tauri/target-overlaysrc-tauri/target-bd-managersrc-tauri/target-catalog-dev),避免多 binary 共用 build cache 導致 context 污染。打包前請確認 repo 內已有 data/catalog.db(gitignore,需自行生成或複製)。

若 exe 已編譯過,可跳過 build:

pwsh -File scripts/build_portable_zip.ps1 -SkipBuild

本地测试:解压或进入 release/PoE2-Overlay-Suite-<version>-win64/,执行 poe2-area-overlay.exepoe2-bd-manager.exepoe2-catalog-dev.exe

Release exe build

npm.cmd run tauri -- build

產物:src-tauri/target-overlay/release/poe2-area-overlay.exesrc-tauri/target-bd-manager/release/poe2-bd-manager.exesrc-tauri/target-catalog-dev/release/poe2-catalog-dev.exe。此命令只產 exe,不產 MSI/NSIS;發佈建議使用上方 Portable ZIP。

授權

本專案以 MIT License 釋出。

About

No description, website, or topics provided.

Resources

Stars

8 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages