PEZ WARS

== Team Members ===========================================

• Don Brown - Sound/Music/Gameplay
• Ava Jamshidi - Graphics/Gameplay/AI/Menus
• Alex Jurcik - Graphics/Gameplay/AI
• Michelle Tarson - Networking/Gameplay

== Screen Shots =============================================

Sample Map:

Game Select Menu:

Player Select Menu:

== Introduction =============================================

PEZ WARS is a multiplayer combat game with a top view. The combatants, Santa, Psychedelic Eye, Boba Fett, and Miss Piggy, roam one of four different rooms on the screen. The object of the game is to kill the other player(s) by shooting pez pellets. PEZ WARS has two modes of play, a single player vs. AI, and a networked mode. The AI has four different levels of difficulty. You can have up to 4 players in a networked game.

Features:

• Tile based map for ease in drawing to screen
• 2-4 player networked mode
• AI for single player mode
• Game-based wav sounds and MIDI music
• Hand drawn graphics and menus
• Multiple leveled AI to choose from
• Multiple Maps to choose from

== Problem Description =======================================

Pez Wars utilizes a tile based mapping format. Using this, we create four different maps for the players to roam around in. The tile map is its own PCX file that is loaded into its own segment. Various tiles are indexed and placed onto the screen; the screen will be double buffered in order to dramatically reduce screen flicker. All of our graphics are in a 320x200x256 format.

The networking for PEZ WARS uses peer-to-peer routines. The is the most efficient from of networking for this project. Each player may enter the game at any time during the play. Every player sends packets out and is responsible for processing the packets they receive.

Sound proposes another asset to the program. The sound consists of wav and MIDI files. The music is also screen dependent, and for that we will be using MIDI sound files. These will be done using the MIDPAK driver functions.

We based our code on given sound, network, and ECE 291 library functions, and the main procedure of MP5.

== Implementation ===============================================

A verbal description of the main loop:

Find out from the PlayIntroandMenus function if this is a networked game. If it is networked go to the NetworkGame function (the main loop for a networked game). Initialize health and position, draw the screen with the appropriate map and player. Check for exit conditions (esc pressed or health = 0) and exit to the main, win or lose screen as appropriate. If the exit condition fails, then have the AI move and move the bullets on the screen. Continue this in a loop until we exit.

The NetworkGame is quite different in the sense that it sends Hello messages every 2 seconds. The Hello Message is a structure that gives the players current position, facing direction and status so when another player joins, the joining player can draw the existing characters in the appropriate positions. Update messages are sent 9 times per second. The Update Message structure sends out the current position, player number (which determines which character they are), status, the direction the player is facing, and which direction they shot a bullet in. Every player is responsible for moving all the bullets on their screens by keeping track of each players bullets in a separt bullet array. These arrays contain bullet structures. The bullet structures say whether the bullet is active, which character shot it (to determine the color to make it), and which direction it is going in. The bullet arrays are of length 6 so that each character can only have 6 bullets on the screen at a time.

== Constants ===============================================

Networking:

These constants signify the status of the players/bullets.
 

These are various constants signifying what type of message has been recieved over the network.
 

Sounds:
Listing of Wav Files
 

helpful midi command constants
 

midi indexes
 

midi sizes
 

PCX file declaration taken from ECE291 Lab Manual

== Includes ================================================

Macros.inc., constants.inc, MSGTypes.inc --- structures for networking

== Variables ===============================================

exitFlag db 0     ;This is a flag of when to exit the program
oldKbdV db ?     ;This is the old keyboard handler interrupt address
tileArray db 'tiles.pcx',0    ;A null terminated string to the tile picture
mapFile db 'map.map',0     ;A null terminated string to the map file
openError db 'Error: File Not Found',CR,LF,'$'    ;A message to display for bad opening of files

tileTable ;array of words pointing to indices of tiles to draw to the screen

playerTable ; array of words pointing to indices of player tiles to draw to the screen

midilist ; a list of available midi files to play
midisize ; the size of the midi file to be played
WavName ;used to determine wav to play
MidiName ;used to determine midi to play
fileno ; file handle for opening wavs
wavremaining ; number of bytes left for the dsp to process
wavlength ; total length of the wav to be played
wavdone ;0 if still playing, 1 if wav stopped

== Lookup Tables ===========================================

MapTable

== Structures ==============================================

PlayerType STRUC
This strcuture contains all the basic variables needed to draw each player to the screen.

Status	db	INACTIVE
Health	db	?
CurXPos	dw	?
CurYPos	dw	?
Character	db	?
Direction	db	?

BulletType STRUC
This contains all the necessary information to write each bullet to the screen.

Character	db	?
BulXPos	dw	?
BulYPos	dw	?
Status	db	BULACTIVE
Direction	db	?

GenericMSG STRUC
This is the generic networking message format.

MsgType	db	?
PlayerNum	db	?
Status	db	?

HelloMSG STRUC
This is the message sent to each player to let everyone else know he is still there.

MsgType	db	HELLO
PlayerNum	db	?
Character	db	?
XPos	dw	?
YPos	dw	?
FaceDirect	db	?
FireDirect	db	?

UpdateMSG STRUC
This message updates a players information across the network.  

MsgType	db	UPDATE
PlayerNum	db	?
XPos	dw	?
YPos	dw	?
FaceDirect	db	?
FireDirect	db	?

FireMsg STRUC
This message is sent whenever any player fires a bullet.

MsgType	db	FIRE
PlayerNum	db	?
BulXPos	dw	?
BulYPos	dw	?
Direction	db	?
Status	db	?

GoodbyeMsg STRUC
This message gets sent when a player is leaving.

MsgType	db	Goodbye
PlayerNum	db	?

WavHeader STRUC
 

== Procedures ================================================

Basic Routines----------------------------------------------------------------------------
 
 

Graphics Routines------------------------------------------------------------------------

 Interrupt Routines-----------------------------------------------------------------------

Network Routines------------------------------------------------------------------------

GamePlay Processes---------------------------------------------------------------------

AI Processes------------------------------------------------------------------------------- 

Sound Routines---------------------------------------------------------------------------

Sound will be based on the Sound Library. (Some functions only minor changes from lib)