A tároló szerkezete
A repó gyökerében (linux-port ág) ezek a fő részek vannak:
| Könyvtár / fájl | Mi van benne | Ki írta |
|---|---|---|
NOLF/ClientShellDLL/ | Kliensoldali játékkód: menük (a „folder”-ek), HUD, fegyverek effektjei, feliratok, kamera, CharacterFX. 166 .cpp, 182 .h. | Monolith, 2000 (eredeti) |
NOLF/ObjectDLL/ | Szerveroldali játéklogika: AI, ajtók, triggerek, küldetések. 147 .cpp, plusz egy flex (AnimationLex.l) és egy bison (AnimationParse.y) forrás. | Monolith (eredeti) |
NOLF/Shared/ | A kettő közös kódja, például a mozgás és a játékbeállítások. Kétszer fordul, lásd lent. | Monolith (eredeti) |
NOLF/ClientRes/ | ClientRes.h: a szövegazonosítók (IDS_*) nevei. A szövegek a játék CRES.DLL-jéből jönnek. | Monolith |
LT2/sdk/inc/ | A LithTech 2 motor SDK fejlécei: iltclient.h, iltserver.h, iclientshell.h, iservershell.h … Ez a „szerződés” a játék és a motor között. | Monolith |
LT2/lithshared/ | Segédkönyvtárak fejlécei (ButeMgr, ltguimgr, mfcstub, stdlith …). Az eredeti .lib-ek nincsenek meg, a megvalósítás az engine/libs/-ben van. | Monolith + port |
engine/ | Az új motor. Minden, ami a 2000-es LithTech motor helyett fut. | port (új kód) |
engine/linux/ | Linux-only réteg: SDL3, OpenGL, FreeType, SoundFont. | port |
launcher/ | A macOS SwiftUI indító és a hu.txt magyar szövegtábla. | port |
NOLF1.xcodeproj | A Mac-es build (Xcode). | port |
harness/ | Tesztkörnyezet: képkocka-összehasonlítás, motor-egységtesztek, dumpstrings. | port |
forditas.sh, play_linux.sh, nolfbin.sh | Linuxos fordító és indító szkriptek. | port |
README.md, LINUX.md, MAC_MAGYAR.md, OLVASS_EL_FORDITAS.md | Dokumentáció. | port |
Az engine/ alkönyvtárai
| Alkönyvtár | Feladat |
|---|---|
compat/ | Win32 és CRT „álfejlécek”. A windows.h (692 sor) pontosan annyit ad a Win32 API-ból, amennyit a NOLF kódja használ, hogy az eredeti forrás változtatás nélkül forduljon. A törzsek a windows_compat.c-ben vannak (988 sor). Az include-shims/ olyan szimlinkeket tartalmaz, amelyek neve szó szerint ..\ClientShellDLL\X.h, visszaperjellel. |
kernel/io/ | Fájlrendszer: ltfilemgr (fák verme), ltrezfile (REZ olvasó), ltfilestream. |
kernel/res/ | ltperes: a CRES.DLL PE-fájl szövegtáblája; ltstringmgr: szövegkezelő és a fordítás betöltése. |
kernel/tex/ | Képformátumok: PCX, DTX (S3TC-vel), SPR. |
kernel/console, math, record, time | Konzolváltozók, matek, determinisztikus futásnapló, óra (LT_REALTIME). |
libs/ | Az eredeti lithshared könyvtárak újraírása: butemgr_impl.cpp (attribútumfájlok, 1128 sor), ltguimgr (menüvezérlők, betűk), mfcstub (CString, CRect), regmgr (registry helyett fájl), cryptmgr, gamespy_stub. |
render/ | ltnullrender (renderfüggvények bekötése), lt2d, lt3d (bitpontos szoftveres raszterizáló), ltcomp (GPU kompozitor), ltfont (bitmap betűk), ltscene, ltmetal.mm (Mac). |
world/ | A .DAT pályák (v66) olvasása, ütközés, láthatóság, ajtók, rajzolás. |
model/ | A .ABC modellek olvasása és rajzolása. |
sound/ | Keverő, WAV, hangkezelő, és egy saját DirectMusic-csere (ltdmmgr, ltdmperf, ltdmsynth, ltdls). |
server/ | ltserverhost.cpp (8093 sor): az ILTServer megvalósítása; betölti az ObjectDLL-t és lépteti a szervert. |
shared/ | Kliens–szerver üzenetcső, objektum-replikáció. |
skeleton/ | skeleton_host.cpp: a main() és a képkocka-ciklus. gen_skeleton.py + skeleton_generated.*: a csonkok. |
platform/ | Bemenet, billentyű-hozzárendelések, config; Mac: ltwindow.mm, ltsysfont.mm. |
generated/ | A flex/bison által generált animációs parser (bekommitolva). |
linux/ | Linux platformréteg, lásd a 3. fejezetet. |
LT2/sdk/inc) alapján, a GPL-es Jupiter EX forrást referenciaként használva írta meg újra a motort. Így az eredeti játékkód lefordul, és a motor oldalán minden modern rendszeren fut.Két modul: kliens és szerver
A LithTech játékok mindig két részből álltak: egy CShell.dll (kliens: kép, menü, HUD) és egy Object.lto (szerver: játékvilág, AI) modulból. Egyjátékos módban is a gépen belül fut egy „szerver”. A port ezt a felosztást megtartja:
- Kliens: a ClientShellDLL kódja statikusan belefordul a
nolf1futtatható fájlba, a motorral együtt. - Szerver: az ObjectDLL valódi dinamikus könyvtár lesz:
libnolfobject.so(Linux) vagylibnolfobject.dylib(Mac). A motordlopen-nel tölti be.
NOLF/Shared/ kódot mindkét modul tartalmazza, de más-más tartalommal: a kliensváltozat -D_CLIENTBUILD-dal fordul, és kb. 44 függvénye (pl. CDebrisMgr::CreateDebris) csak ott létezik. Ha ugyanazokat a szimbólumneveket kétféle törzzsel egy binárisba linkelnéd, ütköznének. A build_linux.sh megjegyzése szerint: „a duplikált szimbólumok nem véletlenek, hanem maga az architektúra”.A program indulása
A main() az engine/skeleton/skeleton_host.cpp 3312. sorában kezdődik. A sorrend számít, ezért itt van az eleje magyarázattal:
int main(int argc, char** argv){ bool bClient = true; // alapból kliens; --server csak teszthez for (int i = 1; i < argc; ++i) if (!strcmp(argv[i], "--server")) bClient = false; printf("=== NOLF 1 engine skeleton host ===\n"); LTRecord_Init(); ↳ LEGELŐSZÖR a futásnapló, hogy ne legyen lyuk benne LTHost_InstallCrashHandlers(); ↳ SIGSEGV stb. -> [LTFATAL] + hívási verem LTGetClock()->Init(); ↳ óra: fix lépés, vagy LT_REALTIME=1 esetén valós LTInput_InitScript(); ↳ LT_TEST_KEYS / LT_TEST_MOUSE tesztszkriptek LTCommand_InitScript(); LTRecord_Event("host", "mode %s", bClient ? "client" : "server"); { const char* pEnv = getenv("NOLF_GAME_DIR"); ↳ a játékadat könyvtára(i) char dirs[2048]; strncpy(dirs, pEnv ? pEnv : NOLF_DEFAULT_GAME_DIRS, sizeof(dirs) - 1); dirs[sizeof(dirs) - 1] = 0; const char* aDirs[16]; // max. 16 könyvtár int nDirs = 0; for (char* p = strtok(dirs, ":"); p && nDirs < 16; p = strtok(0, ":")) ↳ kettősponttal elválasztva aDirs[nDirs++] = p; printf("mounting game data (%d director%s)...\n", nDirs, nDirs == 1 ? "y" : "ies"); int nTrees = LTGetFileMgr()->InitFromGameDirs(aDirs, nDirs); ↳ felcsatolja a REZ fákat (2. fejezet) printf("mounted %d tree(s)\n", nTrees);Ezután a main() sorban:
- Konfiguráció:
LTBind_LoadConfig("autoexec.cfg")a játék könyvtárából (csak olvasva), rá a játékos sajátautoexec.cfg-je (~/.local/share/NOLF1/vagy~/Library/Application Support/NOLF1/). - Szövegtábla:
LoadResourceDll(…, "CRES.DLL")(3409. sor); ha aNOLF_LANG_FILEbe van állítva, rátölti a magyar fordítást. - Szerver indítása (3466–3528. sor):
LTServerHost_Startbetölti alibnolfobject-et,Rep_Installbekapcsolja a replikációt,LTServerHost_StartWorld,AddClient. - Kliens létrehozása:
CreateClientShell(&client). Ez a játék saját belépési pontja, közvetlen hívással, mert statikusan belinkelt kód. - OnEngineInitialized: a játék felépíti a menüket, betölti a betűket és a képeket.
- Képkocka-ciklus (3881. sortól), amíg be nem zárod az ablakot.
printf("calling the game's CreateClientShell()...\n");fflush(stdout);IClientShell* pShell = CreateClientShell(&client);↳ a ClientShellDLL exportja, itt sima függvényhívásLTRecord_Event("host", "CreateClientShell %s", pShell ? "ok" : "null");g_pHostClientShell = pShell;↳ AZONNAL, még az OnEngineInitialized előtt:LTMessage_SetClientDeliver(LTHost_DeliverToClient);↳ a kliens már az inicializáláskor üzen a szervernekA képkocka-ciklus (rövidítve)
for (int i = 0; nUpdates == 0 || i < nUpdates; ++i)↳ LT_UPDATES=n -> n képkocka után kilép (teszt){ LTGetClock()->Tick(); // eltelt idő LTGetNullRender()->ClearScreenForFrame(); LTInput_ScriptTick(i); LTInput_ClickTick(i); ↳ valódi + szkriptelt bemenet LTServerHost_Update(LTGetClock()->GetFrameTime()); ↳ a SZERVER lép egyet: AI, fizika, triggerek LTHost_UpdateFog(); pShell->Update(); // a KLIENS: menü vagy 3D jelenet kirajzolása LTScene_UpdateParticles(...); LTScene_UpdateSprites(...); pShell->PostUpdate(); // itt van pl. a gyorsmentés if (bWindow) { LTGetNullRender()->PresentToWindow(); ↳ a MOTOR teszi ki a képet, nem a játék LTComp_FrameEnd(); LTWindow_PumpEvents(); } ↳ kompozitor, ablakesemények if (LTWindow_ShouldClose() || g_bHostQuit) break;}FlipScreen-t, de a mérés ezt mutatta: „837 Start3D, 837 End3D, 0 FlipScreen”. Ezért a portban a gazdaprogram jeleníti meg a képet, nem a játék.Hogyan „valósul meg” a LithTech interfész?
Az LT2/sdk/inc/iltclient.h több száz virtuális függvényt és függvénymutatót ír elő. Ezeket a port nem kézzel gépelte be:
- A
engine/skeleton/gen_skeleton.pyvégigolvassa az SDK fejléceit, és minden tisztán virtuális metódushoz csonkot generál askeleton_generated.h/.cpp-be. A csonkLT_ERROR-t ad vissza, szándékosan nemLT_OK-t: így ami nincs megírva, az látványosan hibát jelez, nem csendben „sikerül”. - A
LTSkeletonClientosztály (skeleton_host.cpp:1309) ebből származik, és felülírja azt, ami már kész. A kész függvényeketLTIMPL, a hiányzókatLTSTUBjelöli. - A függvénymutatós tagokat (pl.
FlipScreen,Start3D) azLTNullRender_Wire,LTScene_WireésLTConsole_Wireköti be.
LTRESULT GetPointStatus(LTVector *pPoint) override { LTSTUB("ILTClient::GetPointStatus"); return LT_ERROR; }↳ első hívásnál kiírja: ez még nincs készvoid LTNullRender_Wire(ILTClient* p){ if (!p) return; p->SetRenderMode = NR_SetRenderMode; ↳ a játék ILTClient::SetRenderMode-ot hív... p->GetRenderMode = NR_GetRenderMode; ↳ ...és a port NR_* függvénye fut le p->GetRenderModes = NR_GetRenderModes; ↳ ez adja a menü felbontáslistáját p->RelinquishRenderModes = NR_RelinquishRenderModes; p->ShutdownRender = NR_ShutdownRender;A LT_STUB_QUIET=1 elnémítja a csonkok bejelentéseit. A play_linux.sh mindig beállítja.
A Win32 helyettesítése (engine/compat)
A játékkód #include <windows.h>-t ír, DWORD-ot, HWND-t, GetTickCount()-ot, OutputDebugString-et használ. A port nem módosítja a játékkódot, ezért a engine/compat/windows.h szolgáltatja ezeket:
// PURPOSE : Enough of the Win32 API for the original NOLF 1 sources to compile↳ csak annyi Win32, amennyi a fordításhoz kell// unmodified on macOS / arm64.//// SCOPE : Deliberately NOT a general Win32 emulation. Every declaration here↳ nem Wine: csak a ténylegesen// corresponds to something the NOLF 1 game code or LT2 lithshared↳ használt deklarációk, számlálással// actually references, established by census rather than by guessing.↳ összegyűjtve//// RULE : Anything that cannot be implemented honestly must announce itself↳ ami nem valósítható meg,// when it runs -- see LTCOMPAT_UNIMPLEMENTED below.↳ az futáskor bejelenti magátHasonlóan: a dinput.h csak a DIK_* billentyűkódokat adja (a NOLF nem hívja a DirectInputot). Az mmsystem.h, winreg.h, io.h, direct.h és a régi iostream.h is csak vékony álfejléc. Az MFC-t (CString, CPoint, CRect) az engine/libs/mfcstub/mfcs_impl.cpp pótolja.
A tesztkörnyezet (harness)
A szoftveres raszterizáló bitpontos, ezért egy futás képe pontosan összevethető egy referenciaképpel:
harness/checkcontract.sh: lefuttatja a játékot ablak nélkül (LT_UPDATES=n LT_DUMP_SCREEN=… LT_NOSERVER=1 LT_REALTIME=0 LT_SCREEN=640x480), és a 120. és a 700. képkockát 0,000 eltéréssel kell visszaadnia.harness/selftest.sh: maguknak a mérőeszközöknek a tesztje (egy pixel eltérésnek bukást kell adnia).harness/enginetests.sh: alrendszer-tesztek valódi adaton (string, pcx, dtx, world, abc, wav, mixer …). Ez Mac-orientált:-frameworkkapcsolókkal fordít.harness/dumpstrings.cpp: kiírja a CRES.DLL összes szövegétazonosító TAB szövegformában. Ebből készült a fordítás alapja (5. fejezet).