Andreas Garmannslund
A simple one-level platform game. Developed as part of ELEC2645 at University of Leeds, spring 2015.
Dependencies: N5110 PinDetect PowerControl mbed
An ARM mbed LPC1768 microcontroller have been used to develop a handheld arcade game in the style of an old-school platformer. This project is entirely my own independent work in all stages of the development; including design, defining project specifications, breadboard prototyping, schematic and PCB layout using CAD, assembly, testing and software development. Due to this being part of the ELEC2645 Embedded Systems Project module at University of Leeds, spring 2015, limitations were given on the available hardware components. Credit is due to the authors of the dependent libraries (N5110, Pin Detect, PowerControl and mbed). I would also like to thank the author of Game Programming Patterns as well as the authors of SFML Game Development for providing me with useful sources for programming design patterns.
Project aims
- Implement simple gameplay:
- A single, fixed (no scrolling) level.
- Player can move left to right, jump and shoot.
- Enemies will drop from the top of the screen.
- The player gets points for shooting enemies.
- The player dies when it gets hits by an enemy.
- Implement a simple menu system.
- Enable the user to adjust the brightness of the display.
- Output sound to enhance the user experience.
Software
The program flow is controlled by a finite state machine. The implemented design was inspired by the State design pattern from the books Game Programming Patterns and SFML Game Development. The StateManager class is responsible for updating and rendering the current selected state. It also changes the state based on request from the current state. The framework built for the state machine used in this project makes it easy to add new screens.
The different main states (indicated by the background colour) and how the user interaction is shown below:
Hardware
Schematic:
Printed circuit board (PCB):
Images
A seperate program was written to convert images (png) to text-representation of the maps. Enemies and numbers on the screen are also collected from a sprite-sheet created in the same manner.
Revision 0:1f92de30d43e, committed 2015-04-26
- Comitter:
- Siriagus
- Date:
- Sun Apr 26 17:20:09 2015 +0000
- Child:
- 1:0cfe2255092a
- Commit message:
- Added Joystick support.
Changed in this revision
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Joystick.cpp Sun Apr 26 17:20:09 2015 +0000
@@ -0,0 +1,45 @@
+#include "Joystick.h"
+#include "mbed.h"
+#include <cmath>
+
+Joystick::Joystick(PinName x, PinName y, PinName button)
+{
+ xPot = new AnalogIn(x);
+ yPot = new AnalogIn(y);
+ btn = new DigitalIn(button);
+}
+
+Joystick::~Joystick()
+{
+ delete xPot;
+ delete yPot;
+ delete btn;
+}
+
+
+// Make sure that the Joystick is centered while calibrating
+void Joystick::calibrate()
+{
+ btn->mode(PullDown);
+ centerX = *xPot;
+ centerY = *yPot;
+}
+
+
+void Joystick::update()
+{
+ // Get position of joystick compared to the center values (delta x and delta y).
+ dx = *xPot - centerX;
+ dy = *yPot - centerY;
+
+ if (abs(dx) < DEAD_ZONE && abs(dy) < DEAD_ZONE)
+ dir = CENTER;
+ else if (abs(dx) < DEAD_ZONE) // Inside horizontal dead zone.
+ dir = (dy > DEAD_ZONE) ? UP : DOWN;
+ else if (abs(dy) < DEAD_ZONE) // Inside vertical dead zone.
+ dir = (dx > DEAD_ZONE) ? LEFT : RIGHT;
+ else if (dx > 0) // To the left, outside both deadzones.
+ dir = (dy > 0) ? UP_LEFT : DOWN_LEFT;
+ else // To the right, outside both deadzones
+ dir = (dy > 0) ? UP_RIGHT : DOWN_RIGHT;
+}
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Joystick.h Sun Apr 26 17:20:09 2015 +0000
@@ -0,0 +1,49 @@
+/**
+@file Joystick.h
+*/
+
+#ifndef JOYSTICK_H
+#define JOYSTICK_H
+
+#include "mbed.h"
+enum JoystickDirection {CENTER, UP, DOWN, LEFT, RIGHT, UP_LEFT, UP_RIGHT, DOWN_LEFT, DOWN_RIGHT, UNKNOWN};
+
+class Joystick
+{
+ public:
+
+ /** Creates a new Joystick object.
+ * @param x Pin connected to the horizontal potentiometer of the joystick.
+ * @param y Pin connected to the vertical potentiometer of the joystick.
+ * @param button Pin connected to the button of the thumb joystick
+ */
+ Joystick(PinName x, PinName y, PinName button);
+
+ /** Destructor. Delete all allocated memory. **/
+ ~Joystick();
+
+ /** Reads the current direction and button status of the joystick **/
+ void update(); // Updates the direction and button status of the joystick.
+
+ /** Calibrates the joystick. The joystick must be centered while this function is called. **/
+ void calibrate(); // Calibrates joystick by updating the center positions.
+
+ /** Returns the current JoystickDirection based on last update. **/
+ int getDirection() {return dir;}
+
+ /** Reads the value of the button. **/
+ int readButton() {return *btn;};
+
+ /** Square set around the center of the joystick where the input is ignored. The axes are treated seperately. Can be varied from 0 (no dead-zone) to 0.5 (max value for dx and dy). **/
+ static const float DEAD_ZONE = 0.1;
+
+ private:
+ AnalogIn *xPot;
+ AnalogIn *yPot;
+ DigitalIn *btn;
+ float dx, dy;
+ float centerX, centerY;
+ JoystickDirection dir;
+};
+
+#endif
\ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/N5110.lib Sun Apr 26 17:20:09 2015 +0000 @@ -0,0 +1,1 @@ +http://developer.mbed.org/users/eencae/code/N5110/#780a542d5f8b
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/main.cpp Sun Apr 26 17:20:09 2015 +0000
@@ -0,0 +1,72 @@
+/**
+@brief Simple platform game developed for ELEC2645 Embedded Systems Project at University of Leeds
+
+@author Andreas Garmannslund
+**/
+
+#include "mbed.h"
+#include "N5110.h"
+#include "Joystick.h"
+#include "map.h"
+#include <ctime>
+
+// Components
+N5110 *lcd; // VCC, SCE, RST, D/C, MOSI, SCLK and LED
+Joystick *joystick;
+
+// Brightness potentiometer
+AnalogIn ledPot(p20);
+
+// Buttons
+DigitalIn btnA(p27);
+DigitalIn btnB(p28);
+DigitalIn btnC(p29);
+
+// Debugging
+Serial pc(USBTX, USBRX);
+BusOut leds(LED1, LED2, LED3, LED4);
+
+// @brief Clears the screen and fill it with the static map layout.
+void clearAndRedrawMap()
+{
+ for (int i = 0; i < BANKS; ++i)
+ {
+ for (int j = 0; j < WIDTH; ++j)
+ {
+ lcd->buffer[j][i] = map[i][j];
+ }
+ }
+ lcd->refresh();
+}
+
+int main()
+{
+ // Init LCD
+ lcd = new N5110(p7, p8, p9, p10, p11, p13, p26);
+ lcd->init();
+ lcd->normalMode();
+ lcd->setBrightness(1.0 - ledPot); // Update brightness of screen
+
+ // Init joystick
+ joystick = new Joystick(p17, p16, p15);
+ joystick->calibrate();
+
+ // Game loop
+ while(true)
+ {
+ clearAndRedrawMap();
+
+ joystick->update();
+ pc.printf("Joystick direction: %d\n", joystick->getDirection());
+
+ lcd->setBrightness(1.0 - ledPot); // Update brightness of screen
+
+ wait (0.1);
+ }
+
+ delete lcd;
+ delete joystick;
+
+ return 0;
+}
+
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/map.h Sun Apr 26 17:20:09 2015 +0000
@@ -0,0 +1,11 @@
+#ifndef MAP_H
+#define MAP_H
+const int map[6][84] = {
+{0xff,0xff,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0xff,0xff},
+{0xff,0xff,0x0,0x0,0x0,0x0,0x0,0x0,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0x3,0xff,0xff},
+{0xff,0xff,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0xff,0xff},
+{0xff,0xff,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xff,0xff},
+{0xff,0xff,0x30,0x30,0x30,0x30,0x30,0x30,0x30,0x30,0x30,0x30,0x30,0x30,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0x0,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xc,0xff,0xff},
+{0xff,0xff,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xfc,0xfc,0xfc,0xfc,0xfc,0xfc,0xfc,0xfc,0xfc,0xfc,0xfc,0xfc,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xc0,0xff,0xff}
+};
+#endif
\ No newline at end of file
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/mbed.bld Sun Apr 26 17:20:09 2015 +0000 @@ -0,0 +1,1 @@ +http://mbed.org/users/mbed_official/code/mbed/builds/433970e64889 \ No newline at end of file