First Commit

parents
The Crime Tracer (tct) is a classic 2D adventure crime game. The main character of the game is a detective who is investigating several crime cases while trying to arrest a professional serial killer...
\ No newline at end of file
<?xml version="1.0"?>
<gtodo>
<category title="Development" place="0">
<item>
<attribute id="1316361261" priority="2" done="0" start_date="734398" enddate="99999999" notify="0" endtime="-60" last_edited="1316361332"/>
<summary>Refactor: credits.py, kezmenu.py, menu.py</summary>
<comment>Refactor modules with MVC design pattern.</comment>
</item>
<item>
<attribute id="1316361358" priority="2" done="0" start_date="734398" enddate="99999999" notify="0" endtime="-60" last_edited="1316361358"/>
<summary>Error printing issue</summary>
<comment>The error messages should always be printed - regardless of the verbose flag.</comment>
</item>
<item>
<attribute id="1316361306" priority="2" done="0" start_date="734398" enddate="99999999" notify="0" endtime="-60" last_edited="1316361360"/>
<summary>Refactoring Listeners</summary>
<comment>At the moment all listeners are notified about all kinds of messages. This should not be the case; only the relevant listeners should be informed each time a new event is generated.</comment>
</item>
<item>
<attribute id="1316361386" priority="2" done="0" start_date="734398" enddate="99999999" notify="0" endtime="-60" last_edited="1316361386"/>
<summary>Informative printing issue</summary>
<comment>Informative messages should be printed only when the verbose flag is off.</comment>
</item>
<item>
<attribute id="1316361436" priority="2" done="0" start_date="734398" enddate="99999999" notify="0" endtime="-60" last_edited="1316361436"/>
<summary>Features checking in the Game Design Document</summary>
<comment>Some features described on the design document might be outdated (for example 1024x768 resolution, both keyboard and mouse support to control the character). Other are too abstract and perhaps not necessary (for example character's strengh and mood).</comment>
</item>
<item>
<attribute id="1316361461" priority="2" done="0" start_date="734398" enddate="99999999" notify="0" endtime="-60" last_edited="1316361461"/>
<summary>Use only docstrings for internal documentation</summary>
<comment>Use docstrings instead of doxygen, since they can be used for providing online documentation (for example through the interactive shell)</comment>
</item>
<item>
<attribute id="1316361491" priority="2" done="0" start_date="734398" enddate="99999999" notify="0" endtime="-60" last_edited="1316361564"/>
<summary>Should we use I18N in the game?</summary>
<comment>Maybe would be necessary for characters discussions.</comment>
</item>
<item>
<attribute id="1316361503" priority="2" done="0" start_date="734398" enddate="99999999" notify="0" endtime="-60" last_edited="1316361605"/>
<summary>Should we refactor long methods?</summary>
<comment>We have selected to work with OO, DRY, design patterns and modularity.</comment>
</item>
<item><attribute id="1316362093" priority="2" done="0" start_date="734398" enddate="99999999" notify="0" endtime="-60" last_edited="1316362093"/><summary>Version information</summary><comment>We should place version information at only one place!
Also we need to create a folder structure which can help us to maintain releases.
I believe that the following structure is nice for us to work:
DEV
Project1
DEV
source code
setup installation
resources
shared libraries
documentations
MAIN
source code
setup installation
resources
shared libraries
documentations
DEV-Faif
source code
setup installation
resources
shared libraries
documentations
DEV-Lafs
source code
setup installation
resources
shared libraries
documentations
Project2
Project3
QA
Project1
Functional Testing
Unit Tests
Test Use Cases
Project2
Project3
REL
Release 1
Release 2
Release 3</comment></item></category>
<category title="Quality Assurance" place="1"/>
</gtodo>
The Crime Tracer -- `AUTHORS' starts here.
Main Developers:
* Efstathios Chatzikyriakidis <contact@efxa.org>
* Sakis Kasampalis <faif@dtek.gr>
Contributors:
* Nikolaos Delis <delis89@gmail.com>
* Dimitris Ventas <rayone99@gmail.com>
* Mihalis Kasampalis <michaelkas@hotmail.com>
The Crime Tracer -- `AUTHORS' ends here.
The Crime Tracer -- `BUGS' starts here.
Bugs:
This release of the `The Crime Tracer' (version 1.0) is almost stable.
Some bugs surely remain.
Please include enough information for the maintainers
in order to reproduce the problem. Generally speaking,
that means:
- the contents of any input files necessary to reproduce the
bug and command line invocations of the program(s) involved.
- a description of the problem and any samples of the erroneous output.
- the version number of the program(s) involved (use --version).
- hardware, operating system, and compiler versions (uname -a).
- anything else that you think would be helpful.
See also the file `TODO'.
* ALSA lib pcm.c:7223:(snd_pcm_recover) underrun occured. Undeterministic
bug. It is generated sometimes when the game begins normal execution.
Invocation: ``python tct.py''
Python version: 2.6.6
Pygame version: 1.8.1release-2+b1 (python-pygame debian package)
Linux isengard 2.6.32-5-686 #1 SMP Thu Nov 25 18:43:34 UTC 2010 i686 GNU/Linux
The Crime Tracer -- `BUGS' ends here.
This diff is collapsed.
The Crime Tracer -- `Changelog' starts here.
Changelog:
2008-12-21 Efstathios Chatzikyriakidis <contact@efxa.org>
* change `README' file.
The Crime Tracer -- `Changelog' ends here.
The Crime Tracer -- `INSTALL' starts here.
Install:
Pending.
The Crime Tracer -- `INSTALL' ends here.
include AUTHORS BUGS ChangeLog COPYING NEWS README THANKS
recursive-include tct/gameobjects *.py
recursive-include tct/resources *.ogg *.jpg *.png *.ttf
recursive-include tct/ *.xml
recursive-include doc *.html *.css *.png *.pdf
The Crime Tracer -- `NEWS' starts here.
News:
History of user-visible changes.
v. 1.0
* Default game's resolution is 800x600.
* Add options pair `-a, --author'.
* Add options pair `-c, --copyleft'.
* Add options pair `-l, --license'.
* Add options pair `-h, --help'.
* Add options pair `-f, --fullscreen'.
* Add options pair `-v, --verbose'.
* Add long option `--nomusic'.
* Add long option `--nosound'.
* Add long option `--version'.
The Crime Tracer -- `NEWS' ends here.
The Crime Tracer -- `README' starts here.
Readme:
We are pleased to announce the version
1.0 release of the `The Crime Tracer'.
All reported bugs in previous test releases have been fixed.
Some bugs surely remain.
See the file `INSTALL' for building and installation instructions.
Please send all bug reports by electronic mail to:
* fsgamedev@googlegroups.com
The Crime Tracer is free software.
See the file `COPYING' for copying conditions.
The Crime Tracer -- `README' ends here.
The Crime Tracer -- `THANKS' starts here.
Additional contributors to `The Crime Tracer'.
Thanks to:
* God
* The PyGame Community
See also the AUTHORS and ChangeLog files.
The Crime Tracer -- `THANKS' ends here.
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
-rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/TheCrimeTracer.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/TheCrimeTracer.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/TheCrimeTracer"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/TheCrimeTracer"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
make -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
Generic functions
=================
.. automodule:: base
.. autoclass:: Base
:members:
# -*- coding: utf-8 -*-
#
# The Crime Tracer documentation build configuration file, created by
# sphinx-quickstart on Tue Sep 6 22:40:07 2011.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys, os
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('../../src'))
# -- General configuration -----------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.viewcode']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
# The encoding of source files.
#source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
# General information about the project.
project = u'The Crime Tracer'
copyright = u'2011, Free Software Gaming Geeks'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '1.0'
# The full version, including alpha/beta/rc tags.
release = '1.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build']
# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []
# -- Options for HTML output ---------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#html_favicon = None
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}
# If false, no module index is generated.
#html_domain_indices = True
# If false, no index is generated.
#html_use_index = True
# If true, the index is split into individual pages for each letter.
#html_split_index = False
# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'TheCrimeTracerdoc'
# -- Options for LaTeX output --------------------------------------------------
# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'TheCrimeTracer.tex', u'The Crime Tracer Documentation',
u'Free Software Gaming Geeks', 'manual'),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False
# If true, show page references after internal links.
#latex_show_pagerefs = False
# If true, show URL addresses after external links.
#latex_show_urls = False
# Additional stuff for the LaTeX preamble.
#latex_preamble = ''
# Documents to append as an appendix to all manuals.
#latex_appendices = []
# If false, no module index is generated.
#latex_domain_indices = True
# -- Options for manual page output --------------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'thecrimetracer', u'The Crime Tracer Documentation',
[u'Free Software Gaming Geeks'], 1)
]
Game Manager
============
.. automodule:: game_manager
.. autoclass:: GameManager
:undoc-members:
:members:
.. The Crime Tracer documentation master file, created by
sphinx-quickstart on Tue Sep 6 22:40:07 2011.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
The Crime Tracer documentation
==============================
**Contents:**
.. toctree::
:maxdepth: 2
base
gm
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
@ECHO OFF
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set BUILDDIR=_build
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .