Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 35 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

```
Expand All @@ -18,4 +23,33 @@ cargo run

## Game

<img width="912" alt="screen shot 2018-07-07 at 18 03 04" src="https://user-images.githubusercontent.com/223045/42412193-390bd758-8210-11e8-8cf3-45792e69aa27.png">
<img width="912" alt="screen shot 2018-07-07 at 18 03 04" src="https://user-images.githubusercontent.com/223045/42412193-390bd758-8210-11e8-8cf3-45792e69aa27.png">

# 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.