Contributing

 

Q3lite Contributing Guide

    This is a general reference for contributing to the Q3lite project. If you're thinking about programming new features please use the Issues tracker to describe what your planning to write so that it can be discussed before you spend time programming.

Maintainer Perspective

    As the sole maintainer of the Q3lite project, I have limited time to commit to the project, no pun intended. I don't get paid for working on this, it's just a mix of hobbies so please keep that in mind if you don't get a response right away. If your pull request ends up not getting merged, your understanding is appreciated. Many factors go into deciding what to add to a project and sometimes in the end it's just personal preference. You're ideas and contributions are greatly appreciated!

Issues Tracker

Please use the Issues tracker to report issues with the game. I'll try to fix those issues as my time and expertise permit. Please avoid using the Issues tracker for non-critical issues with the wiki, typo's, etc. Your understanding and cooperation are appreciated.

Submitting Code Changes

Please submit patches as a GitHub pull request. New features and minor bug fixes will be added to the dev branch, with major bug fixes added to the master branch.

Become a Code Tester

You can help the project out by installing and testing the code, and using the Issues Tracker to report bugs.

Requested Features

Code Optimization

• Optimize code, remove unnecessary CPU intensive features such as the code to create avi videos, etc. This is a primary objective of the project as it will allow embedded systems to run the game well.

Client Features

• Improve/optimize the OpenGL ES renderer. This would include adding support for the open source Mesa driver. I didn't write the renderer code used in Q3lite, so I'm unable to modify or optimize it. Please use the Issues Tracker if you would like to help. I can add support to the compile/installation script if someone else can modify/optimize the renderer.
• Display ping - show actual player ping above lag-o-meter, controlled by a cvar.

Server Features

• Server real ping - Create a cvar to specify whether spectators that are following players in the game will have their actual ping reflected on the scoreboard.
• Replace map items with any other type of map item, such as:
  • Replacing quad damage with mega health.
  • Replacing rocket launcher with red armor (removes rocket launcher and ammo), etc.
• Move all players directly to spectator when joining the server, controlled by a cvar.