From 0e9b33d867a18029e8968b1f28642846403379bf Mon Sep 17 00:00:00 2001 From: Quentin Manamela Date: Tue, 2 Oct 2018 18:30:55 +0200 Subject: [PATCH] Added Data Structure description (To add more later) --- README.md | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b8a4bc1..891c76f 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,11 @@ On OSX you need to install: brew install sdl2 ``` +If you don't have brew please run the following command to install: +``` +/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" +``` + ## Build & Run ``` @@ -18,4 +23,33 @@ cargo run ## Game -screen shot 2018-07-07 at 18 03 04 \ No newline at end of file +screen shot 2018-07-07 at 18 03 04 + +# About + +This Project uses the OpenGL Library "SDL2" for Graphics functionality (Creating Windows, Rendering, etc). + +The Data Structures used for the game are as follows: +``` +pub struct Game { + ....... +} +``` + +The Game struct contains all the objects needed to run the game such as the player Actor, the walls (which are stored in a vector), etc + +``` +struct Assets { + .......... +} +``` + +The Assets struct contains all the assets used in the game (mainly images, fonts and sound so far) + +``` + struct Actor { + .......... +} +``` + +The Actor struct contains all the variables needed for an Actor. An actor is basically a game object and can be either a wall, player or an enemy.