DInput8-ketenlaadstandaard
More actions
Veel Enshrouded-modloaders en DLL-mods willen de `dinput8.dll` van de game zijn, maar die bestandsnaam kan maar één keer voorkomen. De loader met die naam start de andere DLL's uit `dinput8-chain.ini` naast het gameprogramma. EMF, Kiln, ShroudForge, XHL-Core en Auto Loot Plus lezen dit bestand. Deze pagina legt de regels vast zodat elke loader het bestand hetzelfde leest en de lijst van een speler werkt met elke loader die `dinput8.dll` beheert.
Deze pagina is publiek domein onder CC0. Je mag haar in de documentatie van je project kopiëren en aanpassen zonder bronvermelding. Wijzigingen waar meerdere loaders mee instemmen zijn welkom als pull request in de repository van EMF.
De woorden must en should beschrijven hieronder het gedrag van een loader die deze specificatie volgt.
Het bestand
; my mods [Chain] mods\mymod\mymod.dll autolootplus.dll [EMF] creative.dll
- Locatie: `dinput8-chain.ini` in de map van het gameprogramma (`enshrouded.exe` of `enshrouded_server.exe`).
- Codering: een loader moet UTF-8 met of zonder BOM en UTF-16 LE met BOM lezen. Ook de ANSI-codepagina van het systeem zou moeten worden gelezen als de bytes geen geldige UTF-8 zijn, bijvoorbeeld bij een oud Kladblokbestand. Een programma dat het bestand schrijft moet de gevonden codering en regeleinden behouden.
- Regels: lege regels worden overgeslagen. Een regel die begint met `;`, `#` of `//` is commentaar. `; ` voor een DLL-regel schakelt die DLL uit zonder de regel te verwijderen. Commentaar mag na een spatie of tab na de naam staan (`mymod.dll ; my mod`) en namen mogen tussen dubbele aanhalingstekens staan.
- Secties zijn niet hoofdlettergevoelig. `[Chain]` is gedeeld en elke loader die deze specificatie volgt start de DLL's daarin. Elke andere sectie hoort bij één programma, met bijvoorbeeld de naam `[EMF]` of `[Kiln]`. Andere loaders moeten die negeren. Regels vóór een sectie horen bij `[Chain]`. Oude bestanden hebben soms helemaal geen sectie.
- Regels `key=value`: `name=value` is een DLL-vermelding als de waarde een `.dll` noemt. Andere sleutels zijn instellingen van het programma dat ze schreef en worden door andere loaders genegeerd.
De DLL's
- Paden zijn relatief aan de map van het programma. `/` wordt als `\` gelezen. Een loader moet absolute paden, stationsletters, UNC-paden (`\\server\...`) en elk onderdeel `..` weigeren. Het ketenbestand mag niet buiten de gamemap komen.
- Alleen `.dll`-bestanden. Een regel met een ander bestand wordt overgeslagen en gemeld.
- Laad nooit `dinput8.dll` zelf en start geen tweede exemplaar van de eigen loader. EMF herkent bijvoorbeeld zijn eigen loader onder een andere naam en start die kopie niet.
- Elke DLL maar één keer. Staat een DLL dubbel in `[Chain]` en de eigen sectie van een programma, of tweemaal in één sectie, dan wordt ze alleen op de eerste plek gestart.
- Volgorde: DLL's starten van boven naar beneden. `[Chain]` en de eigen sectie van de loader tellen mee in de volgorde waarin ze in het bestand staan.
- Moment: gebruik `LoadLibrary` vanuit de eigen `DllMain` of direct daarna, voordat gamecode draait. Dat is het moment waarop een keten-DLL zou starten als die zelf `dinput8.dll` was.
- Er tellen maximaal 256 vermeldingen. Meer vermeldingen worden gemeld en overgeslagen.
- Fouten: een ontbrekende DLL of een DLL die niet kan laden wordt overgeslagen en gemeld. Dit omvat Windows-fout 126 en fout 1114 als `DllMain` mislukt. De game gaat verder.
Rapportage
Een loader zou per keten-DLL één regel moeten loggen: gestart, overgeslagen omdat deze uitgeschakeld, geweigerd of al geladen is, of mislukt met het Windows-foutnummer. EMF schrijft dezelfde informatie ook als tabel naar `emf\chain_status.txt`, zodat spelers die kunnen delen.
De dinput8.dll van een ander programma verplaatsen
Een installatieprogramma dat de `dinput8.dll` van een ander programma vindt zou die moeten hernoemen en nooit verwijderen, de nieuwe naam in de eigen sectie van `dinput8-chain.ini` zetten en het bestand bij het verwijderen terugzetten. EMF gebruikt `<tool>.dll` als het programma wordt herkend. Anders gebruikt het de versiegegevens of `dinput8-previous.dll` en noteert de verplaatsing in `emf\moved.txt`.
Exports
De game roept `DirectInput8Create` aan op de loader met `dinput8.dll`. De loader moet die aanroep doorgeven aan de Windows-eigen `dinput8.dll` (`%SystemRoot%\System32\dinput8.dll`). Keten-DLL's ontvangen geen DirectInput-aanroepen. Een mod die werk in `DirectInput8Create` doet moet dat verplaatsen naar `DllMain` of een thread die hij start.
Wie volgt dit
| Programma | Leest `[Chain]` | Eigen sectie |
|---|---|---|
| EMF | ja, ook regels vóór een sectie | `[EMF]`, voor DLL's die het installatieprogramma hernoemde |
| ShroudForge | ja. Elke vermelding moet in `mods\<folder>\` staan, andere worden gemeld | |
| Kiln | ja, ook `[EMF]` voor DLL's die oude EMF-installatieprogramma's hernoemden | geen. De eigen lijst staat in `kiln\chain.ini`. Namen tussen aanhalingstekens en commentaar achter een naam zijn gepland. |
| XHL-Core, Auto Loot Plus | ja |
Laat het weten als je programma het bestand leest of anders uitlegt, dan werken we de tabel bij.
Bron
Gedeelde EMF-specificatie voor dinput8-chain.ini. De oorspronkelijke specificatie is CC0-publiek domein.