Isaac 模組工作流程
絕不因為一個《以撒的結合》API 名稱聽起來合理就憑空發明它。 合理名稱並非證據。請先搜尋;如果仍找不到,則標註為「未驗證」。
任務路由
- 在編輯使用者模組前先檢查其專案:
metadata.xml、main.lua、內容 XML、include 內容、依賴項副本,以及目標/版本備註。 - 識別目標建置版本,以及 REPENTOGON/函式庫是否可用。若未指定,僅將儲存庫固定版本(repository pin)作為研究基準。不得聲稱使用者安裝的執行環境與該固定版本相容或未來相容。
- 將請求轉化為範圍、所有權、生命週期、合作模式、資源、依賴項、相容性、效能及測試需求。對於頭目/角色/關卡或大型系統,請先撰寫簡短的規格說明。如果視覺效果會改變,請盤點所需資產,並閱讀圖形生產規則。僅在需要時才建立美術資源;在最終 PNG/ANM2 工作前,先定義好圖集/動畫合約。
- 搜尋 indexes/tasks.json、別名,然後是精確的符號。閱讀 knowledge/INDEX.md 以及僅限相關領域的生成原始碼連結記錄。
- 當 REPENTOGON 啟用時,同時搜尋原始版(vanilla)與 REPENTOGON 的記錄;對於該目標,明確的修改記錄優先。
- 檢查回呼函式的語義、版本精確度、衝突/問題、可行性、本地合作模式、狀態生命週期、XML/資源、效能與相容性。
- 選擇一個帶有依賴項標籤的模式。區分「骨架」(scaffold)與「黃金靜態參考」(golden static reference);
runtime_tested: false永遠不代表經過遊戲玩法驗證。 - 實施最小的、與架構相容的變更。重複使用現有模組、ID、回呼、輔助函式與風格。在了解專案之前,不要建立替代的
main.lua。 - 執行
python scripts/validate_kb.py --project <mod-folder> --ecosystem <vanilla|repentogon>以及prompts/下相關的審計項目。 - 報告依賴項、所使用的確切證據、驗證限制,以及目標化的遊戲內測試。
當需要精確檢索時:
- 搜尋 indexes/symbols.json 以取得精確的 API/列舉/XML。
- 搜尋 indexes/callbacks.json 以取得引數、篩選條件、回傳值,以及 REPENTOGON 的修改。
- 搜尋 indexes/aliases.json 以取得自然語言術語。
- 搜尋 indexes/errors.json 以進行症狀導向的路由。
- 在進行不常見的工作前,請使用 knowledge/feasibility.md。
- 對於確切的語義,請檢查其 HEAD 是否與註冊表固定版本相符後,再讀取位於被忽略的
.cache/upstreams/<source>/簽出版本下的記錄的source_path。如果出現偏移,請使用git show <pin>:<path>讀取固定版本的檔案;不要將較新的簽出版本視為固定證據。如果檔案不存在,請執行經過策劃的安全更新工作流程,並在接受新的固定版本前檢閱原始碼的偏移內容。
在比較過當前原生的 REPENTOGON 與已維護的函式庫選項之前,不要重新實作關卡、自訂血量、小地圖、設定、成就或完成度系統。除非專案已在使用,或使用者接受,否則不要將 IsaacScript/TypeScript 或任何函式庫混入一般的 Lua 中。
不可協商的檢查
- 確認回呼引數、篩選器、回傳型別、取消/取代行為,以及 REPENTOGON 是否修改了原始回呼。
- 確認類別成員的拼寫與版本標籤在正規化記錄中是否正確。
- 從當前記錄或提取的本地資源中,確認實體類型/變體/子類型以及 XML 屬性。絕不猜測數值 ID 或資源路徑。
- 對玩家屬性和跟隨者數量使用快取回呼。在文件有說明處使用明確的回呼篩選器。避免在每幀/渲染回呼中進行完整的房間掃描,除非經過測量且經過嚴格篩選。
- 保持玩家所有權和本地合作模式的明確性。不要假設玩家索引為 0。
- 保持存檔資料為 JSON 安全格式;僅在遊戲開始後載入,並在文件說明的生命週期點儲存。在解碼舊的或不完整的存檔時,保留預設值。
- 不要複製或修改已安裝的遊戲資產。允許記錄衍生的路徑備註。
- 將圖形視為遊戲資產:比對實際的 PNG 裁切、ANM2、Lua/XML 以及動畫事件。預留位置僅供開發使用,絕非最終版本。若未進行觀察到的遊戲內視覺測試,請記錄
visual_runtime_tested: false。
僅閱讀任務所需項目
- API/回呼問題:生成的目錄加上 knowledge/callbacks/critical-callbacks.md。
- XML/資源/動畫/房間工作:
knowledge/下的對應指南以及schemas/下的供應商結構描述。 - 新的精靈圖、外觀、重繪或動畫工作:圖形生產、合約範本 以及 視覺品質稽核。執行
scripts/gfx_audit.py <mod-folder>;對最終資產/就緒閘道使用--release。 - 實作:patterns/INDEX.md 以及相符的模式系列。
- 除錯:knowledge/debugging/decision-tree.md。
- 函式庫:knowledge/libraries/index.md;在呼叫函式庫前,請先閱讀其當前的公開文件/程式碼。
當可信參考資料中不包含所請求的 API 時,請說明該 API 在已建立索引的修訂版本中不受支援或不存在。不要捏造替代方案。