Introduction to BulletBall Development

Code Structure

Note: This section is out-of-date as of commit dbcae31f59.

The BulletBall source code is written to be as easy to understand as possible. When familiarising yourself with the code base, you should start with main.cpp.

Everything important is in main.cpp. Generic helper functions are declared in BulletBall.h.in and implemented in BulletBall.cpp. Each class has its own header and C++ file (for example, IrrEventReceiver.h and IrrEventReceiver.cpp).

BulletBall-specific functions are declared at the top of main.cpp and implemented at the bottom of main.cpp.

Directory Structure

BulletBall has the following directory structure:

• BulletBall - contains the files for BulletBall
  • build - contains the build files generated by CMake
  • docs - contains the Doxygen documentation
  • modules - contains modules for CMake allowing it to find library files
  • res - contains resource files such as 3D models, textures, and music
  • src - contains the source code
• BulletBallLauncher - contains the files for the GTK+ and Qt graphical launchers
  • build - contains the build files generated by CMake
  • docs - contains the documentation generated by Doxygen
  • modules - contains modules for CMake allowing it to compile Vala files
  • src - contains the source code
    • gtk - contains the source code for the GTK+ graphical launcher
    • qt - contains the source code for the Qt graphical launcher