CrystalSpace client

From BZFlagWiki
Jump to: navigation, search
Picture Frame.png This page contains a design document for an possible enhancement or feature. It is a work of collaborative design and has not been accepted as a development goal at this time. The final implmented feature if any may differ from the information on this page. If you are not part of the development or design group, please post comments and suggestions on the talk page and not in the middle of the design.


The Crystal Space client was an effort is to provide implement the BZFlag client using the a crystalspace 3d engine and application framework. Development work never progressed past an inital prototype and was not picked up by the mainline system.

The current version is very experimental but, is compatible with all 2.0.x servers. It will be only available via SVN, using the v2_0_cs_branch.

Currently, the client is playable, does not contain all the features of the stable release. It is not recommended as a playing client, only to be used for development.

That is the plan on the development, subject to change without any prior notification:

Tank redone
  1. Integrate BZFlag client in the Crystal-Space framework, particularly regarding the event handling nature of it. (done)
  2. Handle the command line interface a la Crystal-Space: (done)
    • Option values separated by '=' instead of ' '
    • Own handling of -help
    • Request of option on the command line using CS API
  3. Joystick handling done from Crystal Space (done) This is actually having less functionality of native porting, as the force feedback is missing. I'll think I'll revert the joystick change when the work will go further.
  4. Remove the open GL calls from BZFlag (mostly done)
  5. Crystal-Space manages mouse and keyboard, as far as possible.(done)
  6. A world with a fixed sky with sun, the ground, and a wall all around the field. All done in XML using the CS rendering API and a camera.(partially done, missing the real time update, the moon and the stars)
  7. Reintegrate the 2D element like text and hud (mostly done). Some problem with the text, using bitmap instead of texture, and coordinate system in the 2d renderer.
  8. Tank models integrated, only a fixed size tank (done)
  9. Build the world element using CS API (need to fix use of material)
  10. Add shot
  11. Add the radar renderer, using a procedural texture.
  12. Change configuration file using the CS format
  13. Rework the debugging functionality (like screenshot and FPS) using the bugplug plugin, but controllable with the old way (T for FPS, F5 for screenshot, both configurable from option)
  14. Build the Menu selection using the Crazy Eddie GUI
  15. Rewrite the collision detection code using the ode plug-in
  16. Network layer done using a parallel thread that communicate with the engine
  17. Ship it! Actual ship should be done continuously during the development, to gain acceptance of the product

The idea is to have at any stage of development a working client, so we can see the product and change the direction of development at an early stage, if that is required, or abandon this idea at all.

Actual work on this project is on the 2.0.x branch, as to not delay the the 2.2 release. If the integration is successful, and the performance is acceptable then we can look into putting this work into a production release. Crystal Space, being a 3rd party library may have limited support for some of the less popular Operating Systems, as such support for those may be more difficult. Crystal Space does support the majority of our popular Operating Systems, including IRIX and Solaris.

All developers are invited to contribute if they have the desire. It is just asked that work be coordinated with the author and originator of the project, Alfredo Tupone.