pieromacaluso/cppnd-capstone-snake-game

A 2D Snake game using C++ and SDL

CPPND: Capstone Snake Game Example

• CPPND: Capstone Snake Game Example
  • Introduction
  • Extensions
  • Dependencies for Running Locally
  • Basic Build Instructions
  • Comment to the Project Rubric
    • README
    • Compiling and Testing
    • Loops, Functions, I/O
    • Object Oriented Programming
    • Memory Management
    • Concurrency
  • CC Attribution-ShareAlike 4.0 International

Introduction

This is the implementation of Capstone project in the Udacity C++ Nanodegree Program. It is created by forking the original template of Udacity. The code for this repo was inspired by this excellent StackOverflow post and set of responses.

As Capstone project, I decided to extend the Snake game, following the principles I have learned throughout this Nanodegree Program.

Extensions

The extensions implemented are:

• Game stop/restart: At the end of the game and after the joining of the threads the user can press ESC to exit, or SPACE to restart the game.
• Obstacles: It is possible to load a map of obstacles and load it at the start of the game.
• PowerUps: there will be two power-ups. SpeedUp (red one) that will increase the speed of the snake and SlowDown (green one) that will decrease the speed of the snake.

Dependencies for Running Locally

• cmake >= 3.7
  • All OSes: click here for installation instructions
• make >= 4.1 (Linux, Mac), 3.81 (Windows)
  • Linux: make is installed by default on most Linux distros
  • Mac: install Xcode command line tools to get make
  • Windows: Click here for installation instructions
• SDL2 >= 2.0
  • All installation instructions can be found here

  Note that for Linux, an apt or apt-get installation is preferred to building from source.

• gcc/g++ >= 5.4
  • Linux: gcc / g++ is installed by default on most Linux distros
  • Mac: same deal as make - install Xcode command line tools
  • Windows: recommend using MinGW

Basic Build Instructions

1. Clone this repo.
2. Make a build directory in the top level directory: mkdir build && cd build
3. Compile: cmake .. && make
4. Run it: ./SnakeGame.

Comment to the Project Rubric

README

This README contains all the information required by the rubric:

• A README with instructions is included with the project.

• The README indicates which project is chosen.

• The README includes information about each rubric point addressed.

Compiling and Testing

This can be tested by using the instructions here.

• The submission must compile and run.

Loops, Functions, I/O

• The project demonstrates an understanding of C++ functions and control structures

It is possible to see modification and additional implementations that proves this in the code.

• The project reads data from a file and process the data, or the program writes data to a file.

This part is implemented to gather the map from a txt file. The code used can be found here

• The project accepts user input and processes the input.

The code gets the input of the user to make the snake do actions, but also to close/restart the game. In addition, at the start of the game we can put the name of the map we want to use as argument (e.g., ./SnakeGame map_2.txt).

Object Oriented Programming

• The project uses Object Oriented Programming techniques.

• Classes use appropriate access specifiers for class members.

• Class constructors utilize member initialization lists.

• Classes abstract implementation details from their interfaces.

• Classes encapsulate behavior.

• Classes follow an appropriate inheritance hierarchy.

• Overloaded functions allow the same function to operate on different parameters.

• Derived class functions override virtual base class functions.

And example here

• Templates generalize functions in the project.

Memory Management

• The project makes use of references in function declarations.

We have two functions that use pass-by-reference in the project code here.

• The project uses destructors appropriately.

• The project uses scope / Resource Acquisition Is Initialization (RAII) where appropriate.

Not necessary for the project itself.

• The project follows the Rule of 5.

Not necessary for the project itself.

• The project uses move semantics to move data, instead of copying it, where possible.

Not necessary for the project itself

• The project uses smart pointers instead of raw pointers.

I used a shared_ptr for the powerups here.

Concurrency

The implementation of the points in this part can be seen herehere

• The project uses multithreading.

• A promise and future is used in the project.

• A mutex or lock is used in the project.

• A condition variable is used in the project.

CC Attribution-ShareAlike 4.0 International

Shield:

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.