F20: Treasure Diver

Tiger Tiger Game from Xenoblade Chronicles 2

1 Treasure Diver
2 Abstract
3 Objectives
4 Introduction
- 4.1 How to Play Treasure Diver
- 4.2 Team Members & Responsibilities
5 Schedule
6 Parts Lists & Cost
7 Design & Implementation
8 Technical Challenges
9 Advice for Future Students
10 Conclusion
- 10.1 Project Video
- 10.2 Project Source Code
11 References

Treasure Diver

Abstract

Treasure Diver is a single player game in which the player descends into watery depths on the hunt for treasure. The player must dodge obstacles and enemy creatures all while collecting treasure along the way. While descending the player is able to attack enemies at a range which in turn may give them power ups such as extra air, faster move speed, or temporary invincibility. When they reach the bottom they can collect the Motherlode. After that they have to ascend the cavern and make it out with all their treasure in one piece. Hitting an enemy or obstacle causes the player to lose air and a treasure chest and when their air hits zero it’s game over. At the end of a level the player is given a score based on treasure collected, remaining air, and the amount of enemies destroyed.

Objectives

The main objective of this project was to create the treasure diver video game displayed on an RGB LED matrix, one SJ2 board as a graphics processor/matrix controller, and another SJ2 board as a game pad controller. Other objectives are the following:

Design custom PCBs for both the game pad and matrix controller SJ2 boards.
Design custom 3D printed enclosures for both the matrix and game pad controller.
Use the FreeRTOS Real-Time Operating System on both SJ2 boards.
Use a wireless interface for communication between both SJ2 boards.
Incorporate an acceleration sensor as one of the options to control the game character's movement.
Add background music to the game to enhance gameplay experience.

Introduction

This project was divided into the following modules for each SJ2 board:

Matrix Controller Board: The matrix controller board is responsible for displaying the graphics of the treasure diver game, controlling the treasure diver game logic, playing MP3 tracks based on the current game/menu screen, receiving character movement and button press signals over a bluetooth interface, and sending controller type (accelerometer or joystick) signals over a bluetooth interface.
Game Pad Controller Board: The game pad controller board is responsible for processing input joystick, accelerometer and button press signals, controlling the treasure diver game controls logic, sending character movement and button press signals over a bluetooth interface, and receiving controller type (accelerometer or joystick) signals over a bluetooth interface.

How to Play Treasure Diver

Using the joystick or accelerometer controls (chosen in options menu) on the game pad controller, move the game character down to the bottom of each screen in each game level.
Once the character reaches the bottom of a screen, the next screen of the level will appear.
Avoid all the obstacles while descending, collect as many treasure chests and shoot as many enemies as possible to increase your score.
You can shoot enemies by pressing the select button on the game pad controller (button on the left).
Try not to get hit by any enemies! Doing so will cause your score to decrease and you will lose some air. If you run out of air before finishing the level, you lose the game and will have to restart at the first level.
Once you get to the last screen of the level, you must pick up the chest at the bottom of the screen before you can start ascending.
Now that you've got the final chest, move the game character back up to the top of the first screen of the level before you run out of air!
When you are ascending, you will not be able to shoot any remaining enemies so make sure you shoot them all when you're descending!
Once you reach the top of the first screen in the level, you will enter the next game level.
Beat all levels in order to win the treasure diver game!

Team Members & Responsibilities

Treasure Diver GitLab

Ameer Ali GitLab LinkedIn
- LED Matrix Driver
- Matrix Graphics Development
- Game Logic Development
- Gameplay Mechanics Design
- Wiki Page Management

Jesus De Haro GitLab LinkedIn
- Game Pad Controller
- MP3 Decoder Driver
- Matrix Graphics Development
- PCB Design
- GitLab Repo Management

Nicholas Kaiser GitLab LinkedIn
- HC05 Bluetooth Driver and Interface
- Matrix Collision Detection Development
- CAD Enclosure Design
- PCB Design
- Wiki Page Management

Schedule

Week #	Start Date	End Date	Tasks	Status
1	9/27/2020	10/3/2020	Decide on day/time for weekly meetings Decide on 2 game ideas Decide on using wireless or wired controllers Decide on PCB software and manufacturer to order from Finalize parts list Setup splitwise account for cost sharing Discuss 3D printing options Break project up into tasks and begin assigning tasks to team members Setup team GitLab repo with master and working master branches Submit Project Proposal assignment	Completed Completed Completed Completed Completed Completed Completed Completed Completed Completed Completed
2	10/4/2020	10/10/2020	Read past semester reports to decide on parts vendors	Completed
3	10/11/2020	10/17/2020	Choose game based on Preet's Project Proposal feedback Submit Group Questions assignment Choose top picks for roles and responsibilities Finish schedule rough draft and upload to Wiki report	Completed Completed Completed Completed
4	10/18/2020	10/24/2020	Assign project tasks to team members Order project parts Submit Wiki schedule assignment Complete project GitLab Repo setup Obtain datasheets for all parts and upload to team Google Drive folder Brainstorm gameplay, rules, and level design on paper	Completed Completed Completed Completed Completed Completed
5	10/25/2020	10/31/2020	Read datasheets and conduct research for driver writing Plan CAD enclosure design on paper Finalize gameplay, rules, and level design on paper	Completed Completed Completed
6	11/1/2020	11/7/2020	Parts arrive Test all parts to ensure proper functionality Begin developing graphics driver for LED matrix Begin developing MP3 decoder board driver Begin developing bluetooth board driver Finalize CAD enclosure design on paper and begin designing in AutoCAD software	Completed Completed Completed Completed Completed Completed
7	11/8/2020	11/14/2020	LED matrix can light a pixel(s) at specified locations LED matrix can display our game character and obstacles MP3 decoder can play a song from the SD card MP3 decoder can play/pause, jump to next/previous song, and increase/decrease volume Bluetooth modules can send controls data back and forth between game pad board and master board Controls data can be accessed using "get" and "set" API Plan PCB design on paper Game pad controller can read joystick and accelerometer values and detect switch presses	Completed Completed Completed Completed Completed Completed Completed Completed
8	11/15/2020	11/21/2020	Decide how to handle each collision detection case (character/enemy, bullet/enemy, etc.) MP3 decoder folder structure is finalized MP3 decoder can play a song at a specified index Analog thumbstick and accelerometer values are read by game pad board and sent over bluetooth Button press logic is implemented on game pad board and sent over bluetooth Finish enclosure design in AutoCAD software and start printing Order PCB components (resistors, capacitors, etc.) Finalize PCB design on paper and design in PCB software	Completed Completed Completed Completed Completed Completed Completed Completed
9	11/22/2020	11/28/2020	LED matrix side bar data (health, power ups) is displayed and updates correctly LED matrix displays character orientation correctly depending on current movement direction Controller input (joystick or accelerometer) option is implemented on game pad controller Character moves on LED matrix based on received direction controls Bullet moves on LED matrix when button is pressed Finalize PCB design in software and order PCB	Completed Completed Completed Completed Completed
10	11/29/2020	12/5/2020	LED matrix menu screens and game over screens are implemented on matrix Volume controls in menu are implemented Integrate circuitry with 3D printed enclosure PCB arrives, conduct PCB testing to ensure proper connections Solder PCB and integrate with existing project circuitry LED matrix can scroll to next screen when character reaches the bottom of current screen Finalize MP3 track selection for each screen and during gameplay Collision detection logic is fully functional and displays correctly on LED matrix	Completed Completed Completed Completed Completed
11	12/6/2020	12/12/2020	Finish rough draft of project report Write gameplay logic code on master controller. Gameplay logic should update the score and status bar items correctly LED matrix graphics design for all levels is complete MP3 decoder plays correct song/track during gameplay and for each menu/game over screen Gameplay state machine switches to next state based on user button presses and gameplay progression
12	12/13/2020	12/19/2020	Film demo video and upload. Create link on Wiki report Demo Day Finalize project report and submit

Parts Lists & Cost

General Parts

Item #	Part	Vendor	Qty	Cost
1	64x64 RGB LED Matrix	Adafruit	1	$54.95
2	SJTwo Boards	SJSU	2	$100.00
3	HC-05 Bluetooth Boards	Amazon	2	$12.59
4	MP3 Decoder/Player Board	Amazon	1	$7.39
5	Speakers (with audio jack connection)	already had	1	$0
6	Audio Jack Cable	already had	1	$0
7	MicroSD Card & Adapter (32GB or smaller)	Amazon	1	$5.99
8	Power Supply for LED Matrix (5V 5A)	Amazon	1	$14.99
9	Tactile Push Buttons	Amazon	2	$7.98
10	Analog Thumbstick	Amazon	1	$4.89
11	Power Bank	already had	1	$0
12	6" USB to Micro-USB Cable	Amazon	1	$5.19

Game Pad PCB Components

Item #	Part	Vendor	Qty	Cost
1	M3 Size (or smaller) Screws & Nuts	Amazon	4	$11.99
2	5-pin Right Angle Male Header	Amazon	1	$4.99
3	6-pin Right Angle Female Header	Amazon	1	$7.99
4	1K Through-Hole Resistors	Amazon	2	$5.69
5	2x20 Female Header	Amazon	1	$6.99
6	Male Header Pins	Amazon	16	$4.99

Matrix Controller PCB Components

Item #	Part	Vendor	Qty	Cost
1	2.1mm DC Power Jack (Breadboard Compatible)	Adafruit	1	$0.95
2	2-pin Screw Terminal Block	Amazon	1	$5.99
3	2x20 Female Header	Amazon	1	$6.99
4	4-pin Right Angle Male Header	Amazon	1	$4.99
5	6-pin Right Angle Female Header	Amazon	1	$7.99
6	Male Header Pins	Amazon	20	$4.99
7	2x8 Box Header	Amazon	1	$9.99

Matrix & Game Pad Enclosures Parts

Item #	Part	Vendor	Qty	Cost
1	Game Pad and Matrix Enclosures	custom design	1	$153.34
2	M3 Size (or smaller) Screws & PCB Standoffs	Amazon	18	$11.99
3	#8-32 x 1/2 inch Machine Screws & Nuts	Home Depot	8	$1.18
4	Male Header Pins	Amazon	12	$4.99
5	Hot Glue Gun & Hot Glue Sticks	already had	1	$0
6	6" Slim Headphone Jack Extender (Male to Female)	Amazon	1	$6.99
7	6" DC Power Jack Extender (Male to Female)	Amazon	1	$9.89
8	Velcro Straps (20mm wide)	Amazon	2	$6.59

Design & Implementation

Insert diagram of all modules connected to each sj2 board (using pictures of actual modules)

PCB Design

Brief description. Insert PCB schematics and pictures of actual pcbs

CAD Enclosures Design

Brief description. Insert CAD design screenshots and pics of actual enclosures

RGB LED Matrix

Brief description of what this module does. Insert diagram of led matrix connected to sj2 (using pictures of actual modules)

Hardware Design

Discuss your hardware design here. Show detailed schematics, and the interface here. In this section, you can describe how your hardware communicates, such as which BUSes used. You can discuss your driver implementation here, such that the Software Design section is isolated to talk about high level workings rather than inner working of your project.

Software Design

Use a flowchart(s)

Implementation

Short code snippets or pseudo-code with explanations

MP3 Decoder

The YX5300 MP3 Music Player Module is used in the project to play music at the menu, gameplay and at the Victory/Gameover screen. Although we use it to decode MP3 files, it can also decode MAV files. This board contains a slot for SD card mounting, which we command the module to read from. Insert diagram of MP3 decoder connected to sj2 (using pictures of actual modules)

Image of MP3 Decoder board used in our project from Amazon

Hardware Design

This module is easy to interface since it only uses UART pins (Rx and Tx), excluding the Vcc and Ground. This board was able to be powered with the 3.3V power from the SJ2 board. The MP3 decoder was connected to 2 SJ2 pins....(to be continued). Discuss your hardware design here. Show detailed schematics, and the interface here. In this section, you can describe how your hardware communicates, such as which BUSes used. You can discuss your driver implementation here, such that the Software Design section is isolated to talk about high level workings rather than inner working of your project.

Connection diagram of MP3 decoder to SJ2 board.

Software Design

For ease of code reading, memory was unionized so it may be accessed as an array and by variable names that correspond to the command packet format that is specified in the module's datasheet. Use a flowchart(s)

Implementation

The datasheet specifies the command packet to the MP3 decoder to be a minimum size of 8 bytes composed of the START, VERSION, LENGTH, COMMAND, FEEDBACK, DATA (min of 2 bytes), and END bytes. To make the implementation self explanatory and easy to use (via array), the commands were placed in a unionized memory location (shown below). This approach made it easier

typedef struct {
  uint8_t bytes[8]; ///< 8 bytes of a mp3 decoder message
} mp3_decoder__command_t;

typedef union {
  mp3_decoder__command_t decoder_command; ///< 64-bit command message to decoder
  struct {
    uint64_t start_byte : 8;    // Will be set to 0x7E
    uint64_t version_byte : 8;  // Will be set to 0xFF
    uint64_t data_length : 8;   // Will be set to 0x06
    uint64_t command_byte : 8;  // Varies
    uint64_t feedback_byte : 8; // Will be set to 0x00
    uint64_t data_byte0 : 8;    // Varies
    uint64_t data_byte1 : 8;    // Varies
    uint64_t end_byte : 8;      // Will be set to 0xxEF
  } decoder_command_byte;
} mp3_decoder__msg_t;

The commands were structured as an enum for dedicated functions to use in setting command_byte in the command packet via decoder_command_byte members. Once the command is set, the packet is accessed as an array to simplify sending over UART.

Bluetooth Interface

Brief description of what this module does. Insert diagram of bluetooth connected to each sj2 (using pictures of actual modules)

Hardware Design

Discuss your hardware design here. Show detailed schematics, and the interface here. In this section, you can describe how your hardware communicates, such as which BUSes used. You can discuss your driver implementation here, such that the Software Design section is isolated to talk about high level workings rather than inner working of your project.

Software Design

Use a flowchart(s)

Implementation

(Short code snippets or pseudo-code with explanations)

Game Pad Controller

Brief description of what this module does. Insert diagram of joystick and buttons connected to sj2 (using pictures of actual modules) The main components in Game Pad controller are a joystick, accelerometer, two buttons, and bluetooth. The controller is used to send commands and control Steve (the main character) in Treasure Diver, along with navigation of the menus, with the joystick or the SJ2's on-board accelerometer (user's choice). With bluetooth on the game pad, the controller is wireless.

Amazon image of the joystick

On-board accelerometer

Hardware Design

Discuss your hardware design here. Show detailed schematics, and the interface here. In this section, you can describe how your hardware communicates, such as which BUSes used. You can discuss your driver implementation here, such that the Software Design section is isolated to talk about high level workings rather than inner working of your project.

Schematic of Game Pad controller

Software Design

Use a flowchart(s)

Implementation

Short code snippets or pseudo-code with explanations

Technical Challenges

Describe the challenges of your project. What advise would you give yourself or someone else if your project can be started from scratch again? Make a smooth transition to testing section and described what it took to test your project.

Include sub-sections that list out a problem and solution, such as: