Standard ładowania łańcucha DInput8
More actions
Wiele modloaderów Enshrouded i modów DLL chce być plikiem gry `dinput8.dll`, ale tę nazwę może mieć tylko jeden plik. Loader, który ją zajmuje, uruchamia pozostałe biblioteki wymienione w `dinput8-chain.ini` obok pliku wykonywalnego gry. EMF, Kiln, ShroudForge, XHL-Core i Auto Loot Plus odczytują ten plik. Ta strona zapisuje wspólne reguły, aby każdy loader odczytywał go tak samo, a lista gracza działała niezależnie od tego, który loader zajmuje `dinput8.dll`.
Ta strona jest domeną publiczną na licencji CC0. Możesz skopiować ją do dokumentacji swojego projektu i zmieniać bez podawania autorstwa. Zmiany zaakceptowane przez kilka loaderów są mile widziane jako pull requesty w repozytorium EMF.
Słowa must i should określają poniżej zachowanie loadera zgodnego z tą specyfikacją.
Plik
; my mods [Chain] mods\mymod\mymod.dll autolootplus.dll [EMF] creative.dll
- Lokalizacja: `dinput8-chain.ini` w folderze pliku wykonywalnego gry (`enshrouded.exe` lub `enshrouded_server.exe`).
- Kodowanie: loader musi odczytywać UTF-8 z BOM lub bez niego oraz UTF-16 LE z BOM. Powinien też obsługiwać systemową stronę kodową ANSI, gdy bajty nie są poprawnym UTF-8, na przykład dla pliku zapisanego w starym Notatniku. Narzędzie zapisujące plik musi zachować znalezione kodowanie i znaki końca linii.
- Wiersze: puste wiersze są pomijane. Wiersz zaczynający się od `;`, `#` lub `//` jest komentarzem. `; ` przed wierszem DLL wyłącza ją bez usuwania wiersza. Komentarz może być po nazwie i spacji lub tabulatorze (`mymod.dll ; my mod`), a nazwę można ująć w cudzysłowy.
- Sekcje nie rozróżniają wielkości liter. `[Chain]` jest wspólna i każdy zgodny loader uruchamia wymienione w niej biblioteki. Inne sekcje należą do konkretnych narzędzi, na przykład `[EMF]` lub `[Kiln]`, a pozostałe loadery muszą je ignorować. Wiersze przed sekcją należą do `[Chain]`. Starsze pliki mogą nie mieć sekcji.
- Wiersze `key=value`: `name=value` jest wpisem DLL, gdy wartość wskazuje `.dll`. Pozostałe klucze są ustawieniami narzędzia, które je zapisało i inne loadery je ignorują.
Biblioteki DLL
- Ścieżki są względne wobec folderu pliku wykonywalnego. `/` jest odczytywany jako `\`. Loader musi odrzucać ścieżki bezwzględne, litery dysków, ścieżki UNC (`\\server\...`) i każdy element `..`. Plik łańcucha nie może wychodzić poza folder gry.
- Tylko pliki `.dll`. Wiersz wskazujący inny plik jest pomijany i zgłaszany.
- Nie wolno ładować samego `dinput8.dll` ani uruchamiać drugiej kopii własnego loadera. Na przykład EMF rozpoznaje swój loader również pod inną nazwą i nie uruchamia tej kopii.
- Każda DLL tylko raz. Jeśli występuje dwa razy, w `[Chain]` i sekcji narzędzia lub dwukrotnie w jednej sekcji, zostaje uruchomiona tylko przy pierwszej pozycji.
- Kolejność: DLL są uruchamiane od góry do dołu. `[Chain]` i własna sekcja loadera są uwzględniane według kolejności występowania w pliku.
- Moment: użyj `LoadLibrary` z własnej funkcji `DllMain` lub zaraz po niej, zanim uruchomi się kod gry. To moment, w którym DLL łańcucha uruchomiłaby się, gdyby sama była `dinput8.dll`.
- Uwzględnia się najwyżej 256 wpisów. Dalsze są zgłaszane i pomijane.
- Błędy: brakująca DLL lub biblioteka, której nie można załadować, jest pomijana i zgłaszana. Dotyczy to błędu Windows 126 i błędu 1114 po niepowodzeniu `DllMain`. Gra działa dalej.
Raportowanie
Loader powinien zapisać po jednym wierszu dla każdej DLL: uruchomiona, pominięta, bo jest wyłączona, odrzucona lub już załadowana, albo zakończona błędem z numerem błędu Windows. EMF zapisuje te informacje także w tabeli `emf\chain_status.txt`, aby gracze mogli je udostępniać.
Przenoszenie dinput8.dll innego narzędzia
Instalator, który znajdzie `dinput8.dll` innego narzędzia, powinien zmienić jej nazwę, nigdy jej nie usuwać, wpisać nową nazwę we własnej sekcji `dinput8-chain.ini` i przy odinstalowaniu ją przywrócić. EMF używa `<tool>.dll`, gdy rozpoznaje narzędzie. W innym przypadku używa informacji o wersji DLL lub `dinput8-previous.dll` i zapisuje przeniesiony plik w `emf\moved.txt`.
Eksporty
Gra wywołuje `DirectInput8Create` na loaderze, który ma `dinput8.dll`. Loader musi przekazać wywołanie do systemowego pliku Windows `dinput8.dll` (`%SystemRoot%\System32\dinput8.dll`). DLL łańcucha nie otrzymują wywołań DirectInput. Mod wykonujący pracę w `DirectInput8Create` musi przenieść ją do `DllMain` lub uruchamianego przez siebie wątku.
Kto korzysta ze specyfikacji
| Narzędzie | Czyta `[Chain]` | Własna sekcja |
|---|---|---|
| EMF | tak, także wiersze przed sekcją | `[EMF]`, biblioteki zmienione przez instalator |
| ShroudForge | tak. Każdy wpis musi być w `mods\<folder>\`, pozostałe są zgłaszane | |
| Kiln | tak, także `[EMF]` dla DLL zmienionych przez starsze instalatory EMF | brak. Własna lista jest w `kiln\chain.ini`. Obsługa cudzysłowów i komentarzy po nazwie jest planowana. |
| XHL-Core, Auto Loot Plus | tak |
Daj znać, jeśli twoje narzędzie odczytuje plik lub interpretuje go inaczej, a zaktualizujemy tabelę.
Źródło
Wspólna specyfikacja EMF dla dinput8-chain.ini. Oryginalna specyfikacja jest domeną publiczną na licencji CC0.