Jak na BOTa pro Halflife (CS)?

Tato sekce obsahuje část souboru readme.txt (přeloženou do češtiny a malinko upravenou) z adresáře Botman_Readme z archivu podbot26_src.zip. Obsahuje základní informace o tom, jak BOTa pro HL vytvořit. Jak poznamenává jeho tvůrce BOTMAN, je to jeden z možných postupů.

Co je potřeba pro vývoj BOTa ?

Základem je samotná hra. Pro práci na BOTu pro nějaký z modů Halflifu tedy potřebujete Halflife a příslušný mod - v našem případě Counter Strike. Důležité je, že musí jít o plnou verzi halflifu. Demo verze neumožňuje spouštění modů.

Pro práci se zdrojovými kódy budete potřebovat některý z následujících C++ kompilátorů:

Pro zkompilování otevřte soubor podbot.dsw a vyberte v menu Build položku Rebuild all. Vznikne soubor podbot.dll.

Jak BOT pro Halflife funguje ?

Obyčejně mody pro Halflife nemohou používat BOTy, pokud je tvůrci nezapracují přímo do modu. Nedá se tedy použít jeden BOT pro více modů.

BOT PODBot může být přidán do modu, bez toho aniž byste vlastnili zdrový kód modu. Většina vývojářů modů nezveřejňuje své zdrojovés soubory. Přesto lze vlastního BOTa do některého z modů přidat. Je to díky tomu, že engine Halflifu používá pro herní entity interní strukturu. Ta samá struktura je pak použita i pro entity v modech. Když se hráč připojí h serveru, engine Halflifu vytvoří entitu pro tohot hráče a v modu pak volá funkce, které představují akce prováděné s entitou. BOTi fungují na stejném principu jen s tím rozdílem, že u nich neexistuje síťové spojení, protože existují pouze na serveru.

Je důležité pochopit, jak funguje interface (meziksicht) mezi enginem a modem. V enginu Halflifu existuje seznam funkcí, které může mod volat a naopak v modu existuje seznam funkcí, které muže volat engin. Ostatní kód v modu je "samostatný" a nepotřebuje (kromě zmíněných funkcí) žádné spojení s enginem Halflifu.

Je možné vytvořit DLL knihovnu, která "sedí" mezi enginem Halflifu a modem, a která přenáší volání funkcí z jedné strany na druhou. Když chce engin Halflifu zavolat nějakou z funkcí modu, zavolá nejprve DLL a to "předá volání" dále modu a naopak mod volá prostřednictvím DLL knihovny funkce enginu.

Entity v Halflifu

Když vytvoříte nějakou mapu (použitím Wordcraftu nebo jiného nástroje pro tvorbu map), určíte jméno entity (objektu světa), kterou chcete vytvořit, na určitém místě mapy. Tato jména jsou uložena v obyčejných ASCII řetězcích (např. "weapon_shotgun", "item_healthkit" nebo "ammo_crossbow"). Když chce Halflife vytvořit některou z těchto entit, zavolá funci v DLL modu, která se jmenuje stejně jako ona (entita).

Například v Halflifu se jedna z exportovaných funkcí jmenuje "weapon_shotgun". Ve zdrojových souborech Standard SDK ji ale nenajdete. Vytvoří se totiž makrem LINK_ENTITY_TO_CLASS(). Toto makro je definováno v souboru utils.h ve Standard SDK a vytváří funkci, která volá funkci GetClassPtr(). GetClassPtr() je definována v souboru cbase.h ve Standard SDK. Provádí alokaci paměti pro neexistující entity a vrací ukazatel na část soukromých dat dané entity. Tím bude zařízeno, že každá entita v mapě bude mít v DLL modu exportovanou funkci stejného jména jaké má ona sama. To bude velmi důležité při vytváření DLL mezi enginem Halflifu a modem, viz výše. Takže až engine bude chtít vytvořit "weapon shotgun", zavolá se funkce weapon_shotgun() v DLL BOTa a ta zavolá funkci DLL modu weapon_shotgun().

Nyní víme, jak ovlivňovat volání z HL enginu do modu. Jak ovlivňovat volání z modu do enginu? To je poměrně jednoduché, protože HL engin volá funkci v modu, která má seznam funkcí enginu, které může mod volat. Tato funkce se jmenuje GiveFnptrsToDll() a najdete jí v souboru h_export.cpp. Ve Standard SDK udělá tato funkce pouze to, že zkopíruje tento seznam funkcí do globálně přístupné struktury g_engfuncs. V PODBotu, ale dělá i něco navíc. Po zkopírování struktury funkcí do proměnné g_engfuncs funkce GiveFnptrToDll() určí, jaký mod je právě aktivní (zavolá funkci enginu, která zjistí aktuální adresář hry = jméno modu). Jakmile ví, který mod je aktivní, nahraje DLL soubor, který je pro daný mod potřeba (mp.dll pro Counter Strike).

Jakmile je DLL modu nahráno, musí DLL BOTa zjistit adresy dvou exportovaných funkcí DLL modu (GiveFnptrsToDll() a GiveEntityApi()). BOT si přepíše adresy těchto funkcí v tabulce funkcí enginu svojí vlastní verzí těchto adres (takže DLL modu bude volat funkce BOTa místo volání funkcí enginu HL). Pak předá tuto upravenou tabulku funkcí enginu právě nahranému DLL modu zavoláním funkce GiveFnptrsToDll().

! DOPORUČUJI PŘEČÍST SI DVA POSLEDNÍ DOSTAVCE JEŠTĚ JEDNOU A POMALU, DOKUD SI NEBUDETE JISTI, ŽE TOMU OPRAVDU ROZUMÍTE. POKUD SE VÁM TO STÁLE NEDAŘÍ, ZKUSTE SE PODÍVAT DO PŮVODNÍHO SOUBORU readme.txt. I MĚ TO V TÉ ANLIČTINĚ PŘIJDE TROŠKU SROZUMITELNĚJŠÍ !

Poté engine Halflifu zavolá funkci GetEntityApi(). Ta zkopíruje seznam funkcí modu, které mohou být enginem volány, do paměti, na kterou odkazuje ukazatel předaný této funkci jako parametr. To umožní enginu tyto funkce zavolat, když chce vytvořit entitu, vytvořit nebo zrušit spojení hráče apod. BOT předává seznam těchto funkcí zpět HL enginu a pak zavolá GetEntityApi() - verzi z DLL modu. Jako parametr předá strukturu BOTa, která uchová seznam funkcí z DLL modu.

Jakmile jsou zavolány funkce GiveFnptrsToDll() a GetEntityApi() HL engine zavolá funkci GameDllInit(), která může být použita DLL modu pro inicializaci jakýchkoliv potřebných proměnných. Každá z těchto tří funkcí je volána pouze jednou za dobu, kdy je mod nahrán v paměti.

Jak HL ví jaké DLL patří kterému modu ?

Každý mod má v adresáři Halflife vlastní podadresář. Například Team Fortress je uložen v adresáři Halflife/tfc, Counter Strike v adresáři Halflife/cstrike. V podadresáři každého modu je soubor liblist.gam. Ten používá HL engin k nahrání modu. Jedná se o obyčejný textový, běžným editorem upravitelný soubor. Jeden z údajů, který je v něm uložen je gamedll. Vedle tohoto údaje je uvedeno jméno hlavního DLL souboru modu. Tento řádek vypadá po instalaci Counter Striku takto: gamedll "mp.dll". Pokud do něj doinstalujete PODBota, změní se na: gamedll "podbot\podbot.dll".

Inicializace vlastní hry

Takže engine nahraje DLL specifikované v parametru gamedll, pak v tomto DLL zavolá funkci GiveFnptrsToDll(), po ní GetEntityApi() a nakonec GameDllInit(). Všechny z loadovaného DLL. Potom začne vytvářet a rozmisťovat entity, které se v mapě nacházejí - volá funkce z loadovaného DLL, které mají stejné jméno jako příslušná entita.

Základní entitou, která se vyskytuje v každé mapě je entita "worldspawn". Ta je vždy ve světě mapy vytvořena jako první. Vytváří se pouze jednou pro každou mapu. V souboru dll.cpp (BOTa PODBot) ve funkci DispatchSpawn() je kontrolováno, zda se právě vytváří tato entita. Pokud ano, jsou provedeny inicializace různých proměnných a nacachováno několik zvuků.

Jakmile jsou všechny entity z mapy *.bsp vytvořeny, HL engin připojí klienty. Dokud je daný mod aktivní, HL engin volá funkci jménem StartFrame() na začátku každého video framu. Pokud tedy vaše video karta pracuje v režimu 30 framů za vteřinu, bude tato funkce volaná také 30krát za vteřinu. Tuto funkci tedy můžete využít k různým periodickým činostem a kontrolám. Z této funkce ja například každý frame volána funkce BotThink() pro každého BOTa ve hře, což je, jak již název napovídá, hlavní funkce "BOTí inteligence".

Struktura edict_t

Jednou z velmi důležitých struktur ve zdrojových soborech BOTů od botmana je struktura edict_t. Je zakomponovaná vlastně v každé další struktuře (entitě). Většina funkcí nemá jako parametr přímo strukturu BOTa bot_t, ale právě jeho "edict". Podle toho co jsem zjistil se jedná o "reprezentaci dané entity ve světě enginu HL". V podstatě ID (včetně jakéhosi stavu) dané entity pro engin HL. Pokud někdo čtete tyto řádky a jen nevěřícně kroutíte hlavou, můžete mne svým mailem vyvést z omylu. Rád zde pak vše uvedu na pravou míru (to se týká celých těchto stránek).

Jelikož se s touto strukturou setkáváme v kódu opravdu na každém kroku, myslím si, že by měla správná znalost její funkce zásadně přispět k pochopení celého kódu.

Rady na závěr

Nyní byste již měli vědět jak je zařízeno, že dojde k nahrání požadovaného modu a BOTa a jak mezi nimi a HL enginem probíhá komunikace. Také jste se již dozvěděli o základních funkcích StartFrame() a BotThink(). Pokud byste před započetím studia zdrojových kódů ještě dále chtěli čerpat teoretické informace, doporučuji:

Až se začnete zabývat vlastním zdrojovým kódem, může vám ve vašem zkoumání a pokusech posloužit následující trik:

Poznámka
Pokud by se vám stalo (jako mě), že vám hra s DLL BOTa přeloženým pod debugem nepoběží (za běhu hry padá), nezbyde vám nic jiného, než si nadefinovat vlastní přepínač a logovat do nějakého svého souboru akce, které vás zajímají. Já jsem udělal podobnou věc během své práce na multibotu. Nadefinoval jsem přepínač MULTIBOT_LOG a pokud byl aktivní, nechal jsem do souboru multibot.log zapisovat informace, které mne zajímaly.

Doufám, že vám tato stránka alespoň trochu pomohla v tom, co jste jste se chtěli dozvědět. Pokud ano, splnila svůj účel.

! Přeji vám hodně úspěchů při tvorbě BOTů a ostatních herních záležitostí. !

Vzhledem k tomu, že při své práci na BOTu pro Counter Strike jsem používal BOTa PODBot26 budou se všechny tipy a komentáře v této sekci vztahovat především k němu.

Archiv podbot26_src.zip

Aresář Botman_Readme
Obsahuje pouze soubor readme.txt, který obsahuje základní informace o tom jak bot funguje, jak zjišťovat informace se kterými chceme při vývoji pracovat apod. Některé z tipů, které v něm najdete jsou spolu uvedeny v předhozí kapitole na této stránce.

Adresář Podbot
Obsahuje vlastní zdrojové soubory. Ty jsou uloženy v dalších několika adresářích: Common, Dlls, Docs, Engine, PM_SHARED. Z těchto adresářů jsem pro vytvoření multibota využil pouze adresář Dlls, který obsahuje Visual C++ projekt DLL knihovny.

Přestože projekt BOTa PODBot není nijak extrémě rozsáhlý (15 CPP a 20 H souborů i s mým přidaným multibotem), co se týká modulů, ale některé z nich jsou obrovské, co se týká počtu řádek. Hlavní tři soubory BOT.CPP (10 000 řádek), DLL.CPP (3 500 řádek) a WAYPOINT.CPP (3 500 řádek) jsou opravdu poměrně složité. Naštěstí, jejich programátor byl velmi disciplinovaný, protože většina názvů proměnných i podprogramů pomáhá porozumět i nezasvěcenému člověku. Komentáře kódu nejsou nijak husté, ale výstižné. Myslím si, že lze říci, že se dá v tomto kódu orientovat velmi dobře.

Jak PODBot obecně funguje ?

Na začátku hry (každého kola) je provedena funkce BotSpawnInit(), která zinicializuje všechny potřebné struktury, popřípadě bota teprve vytvoří (pokud začíná úplně první kolo).

Bot má na svoje akce každou vteřinu k dispozici 30 framů (ve smyslu časového úseku). Na začátku každého framu je spuštěna funkce StartFrame(), která volá pro každého bota funkci BotThink(), což je hlavní funkce inteligence bota.

Právě funkce BotThink() se stará o zjišťování stavu bota (živý/mrtvý/zraněný) a provádění na něm závislých reakcí. V případě, že má bot zadány nějaké úkoly (tasky), stará se o jejich provedení atd. S trochou nadsázky se dá říci, že všechny ostatní klíčové funkce se volají v těle této rutiny nebo v tělech jí volaných rutin.

Na konci kola je provedena funkce UpdateGlobalExperienceData(), která vyhodnotí úspěšnost bota a nastaví podle toho příslušné dovednosti, např. zaznamená nebezpečná místa, kde byl bot zabit.

Jak PODBoti komunikují ?

Základní prostředkem pro komunikaci jsou fronty zpráv. Existují funkce pro vložení zprávy do fronty a pro její vyjmutí. Zprávy mohou být adresné (pro konkrétního bota) nebo obecné a pracují asynchronně.

Používané funkce:


      BotGetMessageQueue(bot_t *pBot)

      BotPushMessageQueue(bot_t *pBot,int iMessage)

      BotCheckMessageQueue(bot_t *pBot)

Úkoly

Boti mohou mít zadány úkoly, které se snaží vyplnit. Například zadání (ve hře) požadavku "Cover me" použitím vysílačky vyústí v uložení zprávy do fronty pro všechny boty v "doslechu". Pokud některý z kolemstojících botů tuto zprávu "pozitivně" vyhodnotí, přidělí se mu úkol TASK_COVERME. Ten pak plní dokud není splněn nebo pokud mu není zadán další úkol. Všechny zadané úkoly se ukládají do zásobníku, což znamená, že bot vždy plní poslední zadaný úkol. Po jeho dokončení začne plnit předposlední úkol atd.

Splnění úkolu může vypadat různě. Například u úkolu TASK_FOLLOWUSER (provádí radio-příkaz "Follow me") je vyhodnocováno (ve funkci BotFollowUser()), zda bot může svého kolegu stále následovat, tzn. jestli je naživu, jestli je v dohledu apod.

Používané funkce


      BotGetSafeTask(bot_t *pBot)

      BotPushTask(bot_t *pBot,bottask_t *pTask)

      BotRemoveCertainTask(bot_t *pBot,int iTaskNum)

      BotRemoveCertainTask(bot_t *pBot,int iTaskNum)

      BotTaskComplete(bot_t *pBot)

Pohyb BOTa

Bot má několik základních parametrů, které určují jakým směrem a jak rychle se pohybuje. Tyto parametry se v DLL vlastně jen nastavují jejich zpracování a "provedení" si pak zajišťuje přímo engine hry.

Příklad
float f_max_speed;
- maximální rychlost bota se zbraní, kterou drží

float f_move_speed;
- aktuální rychlost pohybu vpřed (vzad - záporná hodnota)

float f_sidemove_speed;
- aktuální rychlost do strany (úkroky)

Obecně se boti pohybují po předem známých "waypointech". Waypoint je místo v konkrétní mapě, které může být BOTu zadáno jako cíl jeho cesty. BOT se vlastně stále pohybuje od waypoint k waypointu. Pouze setkání s nepřítelem nebo následování kolegy může vyústit v "neowaypointovaný" pohyb. BOTi mají předdefinované útočné waypointy, obrané waypointy atd. pro každou mapu. Pokud tyto waypointy pro danou mapu neexistují, není ani možné boty do takové mapy přidat.

Používané funkce


      BotFindWaypoint( bot_t *pBot )   

      GetValidWaypoint(bot_t *pBot)

      BotFindDefendWaypoint(bot_t *pBot,Vector vecPosition)  

      BotFindCoverWaypoint(bot_t *pBot,float maxdistance)

      GetBestNextWaypoint(bot_t *pBot)

Vlastnosti a dovednosti BOTa

Bot má veliké množství vlastností a flagů. Ty jsou sdruženy ve struktuře bota bot_t.

Příklad
float fBaseAgressionLevel;
- základní úroveň agresivity bota

float fBaseFearLevel;
- základní úroveň strachu bota

float fAgressionLevel;
- aktuální úroveň agresivity bota

float fFearLevel;
- aktuální úroveň strachu bota

boolean bDead;
- určuje, zda je bot ještě na živu

int iTeam;
- index týmu bota - !!! proměnná bot_team obsahuje něco zcela jiného !!!

Podle hodnot těchto (a mnoha dalších) atributů bot reaguje na většinu podnětů ze svého okolí, provádí rozhodnutí o svém pohybu, střelbě nebo vyhledává nejbezpečnější úkryt.

Některé další užitečné funkce

Tato kapitola bude něco jako mix mezi známými kapitolami FAQ (často kladené dotazy) a HOWTO (jak na to?). Protože se mě ještě nikdo na nic neptal, tak to budou spíše PFAQ (předpokládané FAQ). Nicméně si myslím, že by se informace z této kapitoly mohli vývojáři BOTa pro CS určitě hodit. Jsou to všechno problémy, které jsem musel já sám řešit při implenetaci multibota. Prozatím jsou v této sekci řešeny následující problémy/otázky:

Všechny parametry, které BOT potřebuje pro úspěšné vykonání úkolu, mu musejí být předány před přiřazením úkolu. Jedná se především o časový údaj - jak dlouho se má BOT o dosažení cíle snažit.

Poznámka
Nepodařilo se mi zjistit jakým způsobem se dá globálně testovat dokončení úkolu, ať už úspěšné, či neúspěšné. Funkce BotTaskComplete() je provedena jakmile je úkol dokončen - je však volána automaticky v oblasti kódu, která se zabývá prováděním úkolu. Tento problém jsem tedy vyřešil tak, že jsem do kódu zkoumaného úkolu přidal řádek s nastavením flagu konce/průběhu úkolu.

Pokud chcete přidat do kódu zcela nový úkol, který by mohli BOTi provádět (jako např. můj multibot), musíte provést několik úprav:

Poznámka
Podobným způsobem (nadefinovat konstanty a přidat větev příkazu switch) se přidává i vysílačkový rozkaz nebo komunikační zpráva.

bude se neustále otáčet na místě a vyskakovat (i když mu nastavíte příznak aby si klekl).

Nejlepší výledky jsem dosáhl, když jsem botovi zadal úkol PAUSE:

Akce, které musíte provést pro přidání nového konzolového příkazu jsou relativně podobné přidání nového úkolu, ale přece jen se liší v několika detailech, takže bych tento problém popsal raději samostatně. Opět tu jsou základní kroky:

Poznámka
Reakce na příkaz by měla obsahovat co nejjednoduší kód, typicky nastavení některého flagu - ANO/NE.

Problém je v tom, že přestože tento řetězec může obsahovat formátovací znaky jako \n nelze použít standardní C argumenty. Je tedy možné vytisknout jen jeden konstantní řetězec nebo jednu řetězcovou proměnnou. Pokud chcete tisknout více řetězců najednou nebo dokonce nějaké číslo, musíte si vše nejprve předpřipravit do pomocných proměnných.

Vector je jedna z mála implementovaných tříd v kódu PODBota, téměř všechny ostatní typy jsou "obyčejné struktury". Ve své podstatě se jedná o trojici float čísel. Nad objekty této třídy se dají provádět standardní operace: sčítání a odečítání vektorů i dělení a násobení. Dále má metodu Length(), která vrací délku vektoru. Vektory lze zaké běžně porovnávat.

Důležitá informace pro práci s vektory je ta, že se jedná o tzv. poziční vektory. To znamená, že souřadnice obsažené ve vektoru udávají absolutní pocici od počátku systému souřadnic.

Nejdůležitější vektory ve struktuře BOTa jsou tyto: