Vítejte na stránkách dokumentace programu GBARPGMaker¶
GBARPGMaker je program, který má usnadnit práci programátorovi, který vytváří hru pro platformu Game Boy Advanced. Program se nejvíce hodí pro vývoj her, kde je nějaká hlavní postavička, kterou sledujeme seshora a chodíme s ní po mapě.
Program funguje tím způsobem, že uživatel mu pomocí konfiguračního souboru určí mapy a obrázky spritů, které uživatel chce ve hře použít, a program poté vygeneruje knihovnu v jazyce C, pomocí které pak uživatel může určené mapy a obrázky použít. Uživatel, tedy musí programovat v jazyce C.
Mapy se programu předávají ve formátu tmx, který používá editor Tiled a obrázky jsou png soubory. V C kódu už jsou pak uživateli přístupné funkce, které se starají o nastavování a vykreslování mapy, spritů a do značné míry i textu.
Uživatel pak také musí kód kompilovat. Vygenerovaná knihovna využívá knihovnu libgba, kompilátor k ní tedy musí mít přístup. Kompilovat kód na GBA lze několika způsoby, doporučuji projekt devkitPro a jejich toolchain devkitARM (instrukce pro instalaci jsou zde https://devkitpro.org/wiki/Getting_Started). Pro testování již zkompilovaného programu je také velmi vhodné mít na počítači nainstalovaný emulátor. Těch je mnoho, ale jeden z nejpřesnějších je mGBA, který já osobně používám. Program také obsahuje font z této stránky https://github.com/dhepper/font8x8. Nakonec pro informace o programování na GBA a návody také velmi silně doporučuji stránku Tonc, já jsem ji při psaní programu používal.
Samotný program je psaný v jazyce Python a využívá několik základních modulů:
argparse
xml.dom.minidom
a dvě knihovny:
Veškerý kód programu lze najít na mém gitlabu.
Nakonec, dokumentace je generována pomocí programů Sphinx a Doxygen a hostovaná je službou Read the docs.