Documentation and help files for GGZ games
GGZ provides a lot of documentation, however the games themselves are currently not
well documented. Both players and developers will have a hard time being informed
of what might be important to them. Therefore, this page lists all available
documentation on the individual GGZ games as of GGZ 0.0.14.
Unix manual pages (manpage)
- Escape/SDL - escape-sdl(6)
- GGZBoard - ggzboard(6)
- Xadrez Chinês - xadrez-chines(6)
Handbook/Help files
- Mühle (KDE help system)
- TTT3D in sdl-games/ttt3d/HOWTOPLAY
Protocol documentation
- Xadrez Chinês in python/xadrez-chines/xadrez-protocol.txt
- GGZBoard (Bogaprot) in python/ggzboard/bogaprot.txt
- Geekgame in sdl-games/geekgame/protocol-description
- GGZCards in ggzd/game_servers/ggzcards/protocol.html, might be outdated
- Mühle in ggzd/game_servers/muehle/protocol.txt
- In addition to those listed here, see the GGZComm files which are self-explaining.
AI development
- Chess AI (description in grubby/games/guru-chess/DESIGN.ai)
- Krosswater AI (description in ggzd/game_servers/krosswater/stackpath/README.stackpath)
Artwork creation
- KReversi (theme guide in kde-games/KReversi/THEME.HOWTO)
- Chinese Checkers (theme guide in gtk-games/chinese-checkers/pixmaps/templates/README)
Additional developer documentation
- GGZBoard (architecture graphics in ggz-docs, design document in python/ggzboard/DESIGN.ggzboard)
- GGZCards (module adding guide in ggz-docs), might be outdated
- Hastings (module writing guide in ggz-docs), might be outdated
- Tic-Tac-Toe (architecture description and savegame format description in ggz-docs)
- Mühle (description in kde-games/muehle/muehle.txt)
- Keepalive (design document in ggzd/gameservers/keepalive/DESIGN)