Standard för DInput8-kedjeladdning
More actions
Många Enshrouded-modloaders och DLL-mods vill vara spelets `dinput8.dll`, men bara en fil kan ha det namnet. En loader med namnet startar de andra DLL-filerna i `dinput8-chain.ini` bredvid spelets körbara fil. EMF, Kiln, ShroudForge, XHL-Core och Auto Loot Plus läser filen. Den här sidan dokumenterar reglerna så att alla loaders läser den likadant och spelarens lista fungerar oavsett vilken loader som har `dinput8.dll`.
Den här sidan är allmän egendom under CC0. Du får kopiera den till dokumentationen för ditt projekt och ändra den utan krav på källhänvisning. Ändringar som flera loaders godkänner är välkomna som pull requests till EMF:s lagringsplats.
Orden must och should beskriver nedan vad en loader som följer specifikationen gör.
Filen
; my mods [Chain] mods\mymod\mymod.dll autolootplus.dll [EMF] creative.dll
- Plats: `dinput8-chain.ini` i mappen med spelets körbara fil (`enshrouded.exe` eller `enshrouded_server.exe`).
- Kodning: en loader måste läsa UTF-8 med eller utan BOM och UTF-16 LE med BOM. Den bör även läsa systemets ANSI-kodsida när byten inte är giltig UTF-8, till exempel från en äldre version av Anteckningar. Ett verktyg som skriver filen måste behålla kodningen och radsluten som hittades.
- Rader: tomma rader hoppas över. En rad som börjar med `;`, `#` eller `//` är en kommentar. `; ` före en DLL-rad stänger av DLL-filen utan att raden tas bort. En kommentar får stå efter namnet med ett blanksteg eller tabb (`mymod.dll ; my mod`) och namn får omges av dubbla citattecken.
- Avsnittsnamn är skiftlägesokänsliga. `[Chain]` är gemensamt och alla kompatibla loaders startar dess DLL-filer. Övriga avsnitt tillhör ett verktyg och namnges efter det, som `[EMF]` eller `[Kiln]`. Andra loaders måste ignorera dem. Rader före ett avsnitt hör till `[Chain]`. Äldre filer kan sakna avsnitt.
- Rader med `key=value`: `name=value` är en DLL-post när värdet anger en `.dll`. Andra nycklar är inställningar för verktyget som skrev dem och ignoreras av andra loaders.
DLL-filerna
- Sökvägar är relativa till mappen med den körbara filen. `/` läses som `\`. En loader måste neka absoluta sökvägar, enhetsbokstäver, UNC-sökvägar (`\\server\...`) och varje del `..`. Kedjefilen får inte nå utanför spelmappen.
- Endast `.dll`-filer. En rad med en annan fil hoppas över och rapporteras.
- Ladda aldrig själva `dinput8.dll` och starta inte en extra kopia av den egna loadern. EMF känner till exempel igen sin loader även under ett annat namn och startar inte kopian.
- Varje DLL en gång. Om en DLL står två gånger, i `[Chain]` och ett verktygs eget avsnitt eller två gånger i samma avsnitt, startas den bara vid sin första plats.
- Ordning: DLL-filer startas uppifrån och ned. `[Chain]` och loaderns eget avsnitt räknas i den ordning de visas i filen.
- Tidpunkt: använd `LoadLibrary` från den egna `DllMain` eller direkt efter, innan spelkod körs. Då skulle en kedjad DLL ha startat om den själv var `dinput8.dll`.
- Högst 256 poster räknas. Resten rapporteras och hoppas över.
- Fel: en saknad DLL eller en DLL som inte kan läsas in hoppas över och rapporteras. Det gäller Windows-fel 126 och 1114 om `DllMain` misslyckas. Spelet fortsätter.
Rapportering
En loader bör logga en rad per kedjad DLL: startad, överhoppad eftersom den är avstängd, nekad eller redan inläst, eller misslyckad med Windows felnummer. EMF skriver också informationen i en tabell i `emf\chain_status.txt` som spelare kan dela.
Flytta ett annat verktygs dinput8.dll
Ett installationsprogram som hittar ett annat verktygs `dinput8.dll` bör byta namn på den, aldrig ta bort den, skriva det nya namnet i sitt eget avsnitt i `dinput8-chain.ini` och återställa den vid avinstallation. EMF använder `<tool>.dll` om verktyget känns igen. Annars används DLL-filens versionsinformation eller `dinput8-previous.dll`, och flytten noteras i `emf\moved.txt`.
Exporter
Spelet anropar `DirectInput8Create` på loadern som har `dinput8.dll`. Loadern måste vidarebefordra anropet till Windows egen `dinput8.dll` (`%SystemRoot%\System32\dinput8.dll`). Kedjade DLL-filer får inga DirectInput-anrop. En mod som arbetar i `DirectInput8Create` måste flytta arbetet till `DllMain` eller en tråd som den startar.
Vem följer standarden
| Verktyg | Läser `[Chain]` | Eget avsnitt |
|---|---|---|
| EMF | ja, även rader före avsnitt | `[EMF]`, DLL-filer som installationsprogrammet bytt namn på |
| ShroudForge | ja. Varje post måste finnas i `mods\<folder>\`, andra rapporteras | |
| Kiln | ja, även `[EMF]` för DLL-filer som äldre EMF-installationer bytt namn på | inget. Den egna listan finns i `kiln\chain.ini`. Citattecken och kommentarer efter namn är planerade. |
| XHL-Core, Auto Loot Plus | ja |
Berätta om ditt verktyg läser filen eller tolkar den annorlunda så uppdaterar vi tabellen.
Källa
EMF:s gemensamma specifikation för dinput8-chain.ini. Originalspecifikationen är allmän egendom under CC0.