DInput8 鏈式加載標準
More languages
More actions
許多 Enshrouded 模組加載器和 DLL 模組都希望成為遊戲的 `dinput8.dll`,但這個文件名只能由一個文件占用。占用該名稱的加載器會啟動遊戲可執行文件旁邊 `dinput8-chain.ini` 中列出的其他 DLL。EMF、Kiln、ShroudForge、XHL-Core 和 Auto Loot Plus 都會讀取此文件。本頁記錄這些規則,讓每個加載器以相同方式讀取文件,並使玩家的列表適用於占用 `dinput8.dll` 的任意加載器。
本頁以 CC0 方式奉獻給公有領域。你可以複製到自己項目的文檔中並修改,無需署名。多個加載器共同認可的修改歡迎以 pull request 的方式提交到 EMF 倉庫。
下文中的 must 和 should 表示遵循本規範的加載器應有的行為。
文件
; my mods [Chain] mods\mymod\mymod.dll autolootplus.dll [EMF] creative.dll
- 位置:`dinput8-chain.ini` 位於遊戲可執行文件(`enshrouded.exe` 或 `enshrouded_server.exe`)所在文件夾。
- 編碼:加載器必須讀取帶或不帶 BOM 的 UTF-8,以及帶 BOM 的 UTF-16 LE。對於無效 UTF-8 字節,例如舊版記事本保存的文件,也應讀取系統 ANSI 代碼頁。寫入文件的工具必須保留檢測到的編碼和換行符。
- 行:跳過空行。以 `;`、`#` 或 `//` 開頭的行是注釋。在 DLL 行前加 `; ` 可關閉該 DLL,而不必刪除行。名稱後可用空格或制表符添加注釋(`mymod.dll ; my mod`),名稱也可以用雙引號括起。
- 節區名稱不區分大小寫。`[Chain]` 是共享節區,遵循本規範的每個加載器都會啟動其中的 DLL。其他節區歸某個工具所有,並使用其名稱,例如 `[EMF]` 或 `[Kiln]`。其他加載器必須忽略這些節區。任何節區之前的行都屬於 `[Chain]`。舊文件可能沒有節區。
- `key=value` 行:當 `name=value` 中的值指向 `.dll` 時,它算作 DLL 項。其他鍵是寫入工具自己的設置,其他加載器忽略它們。
DLL
- 路徑相對於可執行文件所在文件夾。將 `/` 按 `\` 讀取。加載器必須拒絕絕對路徑、驅動器號、UNC 路徑(`\\server\...`)以及任何 `..` 路徑段。鏈文件不得越出遊戲文件夾。
- 僅允許 `.dll` 文件。指向其他文件類型的行會被跳過並報告。
- 絕不能加載 `dinput8.dll` 本身,也不得啟動自身的另一個副本。例如 EMF 即使遇到改名後的自身文件也會識別並跳過。
- 每個 DLL 只啟動一次。同一 DLL 即使同時列在 `[Chain]` 和工具專屬節區,或在同一節區重複出現,也只在第一次出現的位置啟動。
- 順序:按照行從上到下啟動 DLL。`[Chain]` 和加載器自己的節區按它們在文件中出現的順序處理。
- 時機:從加載器自己的 `DllMain` 中或緊接其後、遊戲代碼運行之前調用 `LoadLibrary`。若鏈式 DLL 本身是 `dinput8.dll`,它也會在此時啟動。
- 最多處理 256 個項目。超出的項目會被報告並跳過。
- 失敗:缺失或無法加載的 DLL 會被跳過並報告。包括 Windows 錯誤 126,以及其 `DllMain` 失敗時的錯誤 1114。遊戲繼續運行。
報告
加載器應為每個鏈式 DLL 記錄一行:已啟動、因已關閉、被拒絕或已加載而跳過,或記錄 Windows 錯誤號的失敗。EMF 也會將相同信息寫入 `emf\chain_status.txt` 表格,方便玩家分享。
移動其他工具的 dinput8.dll
安裝程序發現其他工具的 `dinput8.dll` 時應重命名而不要刪除,將新名稱寫入自己的 `dinput8-chain.ini` 節區,並在卸載時恢復。EMF 識別工具後會使用 `<tool>.dll`。否則會使用 DLL 版本信息或 `dinput8-previous.dll`,並將移動記錄寫入 `emf\moved.txt`。
導出函數
遊戲會對占用 `dinput8.dll` 的加載器調用 `DirectInput8Create`。加載器必須將該調用轉發給 Windows 自帶的 `dinput8.dll`(`%SystemRoot%\System32\dinput8.dll`)。鏈式 DLL 不會收到 DirectInput 調用。若模組在 `DirectInput8Create` 中執行邏輯,必須將其移到 `DllMain` 或自己啟動的線程中。
遵循此規範的工具
| 工具 | 讀取 `[Chain]` | 自有節區 |
|---|---|---|
| EMF | 是,也讀取任何節區之前的行 | `[EMF]`,用於其安裝程序重命名的 DLL |
| ShroudForge | 是。每個項目必須位於 `mods\<folder>\` 內,其他項目會被報告 | |
| Kiln | 是,也讀取 `[EMF]`,用於舊版 EMF 安裝程序重命名的 DLL | 無。它自己的列表位於 `kiln\chain.ini`。帶引號的名稱和名稱後的注釋尚在計劃中。 |
| XHL-Core, Auto Loot Plus | 是 |
如果你的工具會讀取此文件,或讀取方式不同,請告訴我們以便更新表格。
來源
EMF 的 dinput8-chain.ini 共享規範。原始規範以 CC0 方式奉獻給公有領域。