ECEN 390 - Laser Tag Project

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
===== Milestone 5 =====

Implementing a Game with Sound, Having Fun With Your Laser-Tag System

===== Overview =====

To complete this final milestone, you will implement a complete game that supports play between two teams (of any number) Unlike your other programming assignments, you are free to implement the game as you like, as long as you meet the requirements for game functionality, including sound. The coding standard still applies.

----

==== "Last Person Standing" Game with Sound ====

The game functions as follows. The game is essentially a version of "last person standing". The game ends when all of the members of either Team-A or Team-B have "died". The winning team is the team that has at least one member remaining "alive" at the end of the game.

=== General ===

  - Only 2 frequencies are used. Team-A will use frequency 6 for shooting and will detect hits only on frequency 9. Team-B will shoot on frequency 9 and detect hits only on frequency 6.
  - Teams can consist of any number of persons; teams should start with the same number of members for fairness.
  - Each team member has their own system which consists of (1) the plastic box containing the electronics and (2) a gun.
  - Team membership is determined by the position of SW0 on the ZYBO board. If the switch is down, the person is part of Team-A. If the switch is up, the person is part of Team-B.
  - Each member starts the game with 3 lives. Once all lives are expended, the person's system disables shooting and the person leaves the game.
  - The game ends when all members of either team have lost all lives.
  - No inter-system communication is required. Each system functions independently and players drop out of the game as they lose lives. You can tell that the game is over when all members of one team have dropped out of the game and returned to base.

=== Details ====

Note that the game details below have been refined over several playing sessions. The current configuration seems to provide a nice balance of fun game play and low complexity.

  - Each team member starts with 3 lives.
  - A team member loses a life when they accumulate 5 hits.
  - The gun has a "clip" that contains 10 shots. Once a player has fired 10 shots they must wait for the clip to "autoload". Autoloading the clip requires 3 seconds. 
  - The player may force a reload of the clip at any time by pulling and holding the trigger for 3 seconds (if the clip contains shots, the initial push of the trigger will fire a shot).
  - Immediately after losing a life, a player is invincible for 5 seconds thus giving them time to quickly scurry away. Note that you are not allowed to shoot while invincible.

=== Sounds ===

Sound is essential to game play. It informs the player when they have been hit, when they have lost a life, and when they have expended all lives and must drop out of the game. In detail:
  - A laser-like sound is played each time a player fires a shot. If the clip is empty, a "click" sound is played when the trigger is pushed.
  - A "scream and die" sound is played when the player has lost a life.
  - A Gameboy startup sound will play when the system is first turned on.
  - A "reload" sound is played each time the clip is loaded (either automatically or manually).
  - An "ouch" sound is played each time a player is hit.
  - A Pacman "game over" sound is played once a player has lost all lives.
  - A voice will inform a player when they must drop from the game and "return to base." This voice sound will be infinitely repeated, alternated with 1 second of silence. 

These videos demonstrate when sounds should be played and also show more detailed behavior of the game.
  - [[https://youtu.be/klppe7oTng4|Sounds related to the gun, how the clip works, reloading, etc.]]
  - [[https://youtu.be/IDhDzBggeeo|Sounds made when hit by an opponent.]]
  - [[https://youtu.be/TV2oLZurPTU|Sounds that occur at the end of the game.]]

=== Pass Off and Grading ===

Grades for Milestone 5 will be determined by the functionality of the game and the lack of observable bugs. Groups will get credit for each feature that is correctly implemented. Additional credit will be given for a completely bug-free game.
  - Game startup sound (5%): correctly generating the game startup sound.
  - Gun firing (10%): correctly implementing the gun firing sound, e.g., the gun fires a shot when the trigger is pulled and makes a clicking noise when 10 shots have been fired and the gun has not been reloaded (automatically or manually).
  - Auto- and manual reload (20%): correctly implementing the auto and manual load feature; the gun autoloads once the clip is empty and the user can force a manual reload by holding the trigger for the appropriate amount of time.
  - Lives (15%): correctly keeping track of lives and properly generating the death sound when 5 shots have been accumulated.
  - End of Game (5%): correctly generate the end-of-life game sound, and play the "return to base" sound as required.
  - Bugs (25%): No detectable bugs. Subtract 5% for each detected bug up to the total for this category. Bugs can include:
      - False hits at any point.
      - Incorrectly keeping track of lives.
      - Undue static.
      - Incorrect game play.
  - Code quality based on the [[http://byu-cpe.github.io/ecen330/other/coding-standard/|coding standard]]. Submit your code by invoking ''./check_and_zip.py 390m5'' to create a zip file that you submit to learning suite.

One of the best ways to find bugs in your system is to play it extensively. If the TA detects a bug during pass-off, the team can attempt to fix their system and pass off later. However, don't depend upon the TA to detect bugs in your system. You must test and fully debug your system prior to bringing it to the TAs for pass off. If pass-off attempts become excessive, we will institute a penalty of some sort.

===== Code Submission =====

Assuming you added your code to runningModes2.c, you will use ''./check_and_zip.py 390m5'' to prepare your zip file for submission to Learning Suite.

----

===== Resources =====

----

==== Sound Code and Sound Data ====

The instructor provides working sound code and sound data. All sound data are contained in the sounds subdirectory of the lasertag directory. While coding this milestone, the student needs to add the necessary calls to the sound code so that sounds are correctly activated during game play.

Please read the comments and the function sound_runTest() function in [[https://github.com/byu-cpe/ecen330_student/blob/master/lasertag/sound.c#L281|sound.c]] to see how to use the sound code (it is straightforward). 

//Note: Make sure to add ''sound_tick()'' to isr_function() along with all of the ''_tick()'' functions.//

WARNING!!! WHEN SET TO ITS MAXIMUM VALUE, THE SOUND VOLUME MAY DAMAGE YOUR HEARING IF YOU PLUG EARPHONES INTO THE ZYBO BOARD. THE INSTRUCTOR STRONGLY RECOMMENDS USING THE ATTACHED SPEAKER WITH VOLUME SET TO ITS LOWEST SETTING WHEN IMPLEMENTING YOUR GAME. Volume can be controlled using the 'sound_setVolume()' that can found in the sound.c file. Please read sound.c for more detail on how to use this function.

==== Videos ====

These videos demonstrate when sounds should be played and also show more detailed behavior of the game.
  - [[https://youtu.be/klppe7oTng4|Sounds related to the gun, how the clip works, reloading, etc.]]
  - [[https://youtu.be/IDhDzBggeeo|Sounds made when hit by an opponent.]]
  - [[https://youtu.be/TV2oLZurPTU|Sounds that occur at the end of the game.]]

===== Appendix =====

----

In this appendix you can find additional information that can be used for creative projects.

==== Bluetooth Modem ====

The bluetooth modem is connected to the ZYNQ FPGA via a fixed-rate 9600 BAUD modem. Communication with the modem is simple enough: characters pushed out the Bluetooth UART are transmitted via the Bluetooth modem and vice versa for receive. You can get the base addresses for the Bluetooth UART in the xparameters.h file. I have included documentation for the UART below. Look in the Consolidated_330_SW_bsp/ps7_cortex9_0/libsrc/uartlite_v3_0 directory for the UART driver code.

  * [[https://www.adafruit.com/products/2479|Adafruit Bluetooth Modem Info]]
  * {{::pg142-axi-uartlite.pdf|Xilinx UART Lite Documentation}}
ECEN 390 - Laser Tag Project

User Tools

Site Tools

Page Tools
