Game Documentation

Author:
Jeff Jackowski (jeffj@ro.com)

Goals

Game Design

Index

Common Rules and Requirements

Dependencies

Several libraries are used by this project. They are available on a number of platforms.

Languages

Written

The written language used in the source code and the documentation is English. The game will optionally support additional languages for players who don't know or aren't comfortable with English. However, the documentation will only mention the English version of the program's messages for the player. This is all largely because I am not qualified to translate from English to any other language, and I'm the one making this program.

To provide output in other languages, I have decided to use the GNU gettext library. Unfortunately, I cannot get the latest versions to compile on Windows; it seems version 0.15 has been changed in ways that are not meant to work with Windows. Older versions still work, however, and I will try to avoid using recently added features of gettext.

The program will compile with or without gettext and internationalization support. Without support, the English only version will use regular byte-sized characters. With support, all strings will be stored using the platform's wide character (wchar_t). In all cases, all strings sent over the network will be encoded in UTF-16; the English only version will replace characters it cannot properly represent with a question mark.

Programming

The program is written entirely in C. SCons is used to build the program on all platforms. Doxygen is used to generate the documentation from Javadoc styled comments. The dot tool from Graphvis is used to generate flowcharts from in-code documentation in addition to the graphs Doxygen creates with dot.

License Agreement

This program is made available under the terms of the GPL. The text of the GPL is in the file gpl.txt and is available from the Free Software Foundation at http://www.gnu.org/copyleft/gpl.html.

Copyright (C) 2007 Jeff Jackowski

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Or visit their website at: http://www.gnu.org/

Bitstream Vera font

Included with the data files is the Bitstream Vera Sans Serif font. Information about it and the license agreement is located at http://www.gnome.org/fonts/
Generated on Mon May 28 04:41:38 2007 for Retro Tank Super Attack by  doxygen 1.5.2