Documentation

From Gnoll's Wiki

Revision as of 17:00, 22 May 2009 by Gabriel (Talk | contribs)
Jump to: navigation, search

Contents

Introduction

The C++ code is documented with Doxygen and the Python code is documented with Epydoc. This will allow us to generate a documentation of the code in HTML format. But this doesn't mean that you willn't find documentation in the code !, "normal" commentary is use in the code to detail the algorithm. A conception document will be maintain up to date too.

Dependencies

  • Ogre 1.4.X or 1.6.X
  • OIS
  • CEGUI
  • OgreCEGUI
  • Vorbis / ogg / OpenAL
  • libxml++ / glib / glibmm
  • boost::shared_ptr / boost::file_system / boost::thread / boost::program_option

Concept

Dynamic object

Game object

Scene

Input

Camera

Tutorials

Configuring a scene : A-Z

Configuring inputs

Adding a mesh

Personal tools