https://github.com/a-tokyo/cave-runner
🕹An openGL 3d game where you run in a cave collecting coins and avoiding obstacles.
https://github.com/a-tokyo/cave-runner
Last synced: 28 days ago
JSON representation
🕹An openGL 3d game where you run in a cave collecting coins and avoiding obstacles.
- Host: GitHub
- URL: https://github.com/a-tokyo/cave-runner
- Owner: a-tokyo
- License: mit
- Created: 2016-11-26T04:12:32.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-09-09T18:25:48.000Z (over 2 years ago)
- Last Synced: 2025-02-05T01:44:02.654Z (3 months ago)
- Language: C++
- Homepage:
- Size: 69.5 MB
- Stars: 0
- Watchers: 6
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Cave Runner
An openGL 3d game where you run in a cave collecting coins and avoiding obstacles.
## Description
The player runs inside a cave and we have categories of coins and each one increases the score with a different increment depending on the category of the coin collected.
The player will jump using the space keyboard button and will use the left and right keyboard buttons to avoid rocks.
The mouse will be used to control the camera view .
The main target is to complete 5 minutes without colliding with any obstacle and ending up having the maximum score possible.
[Checkout the Demo video here](https://github.com/A-Tokyo/cave-runner/raw/master/Cave%20Runner%20Demo.mp4)
## Controls
* a: move to the left
* d: move to the right
* space: Jump
* n: new game.
* esc: exit game
## Project Structure
```shell
├── /cave-runner.xcodeproj/ # Holds the xCode project configuration
├── /cave-runner/ # Holds the full source code
│ ├── gameDrawing.cpp # Holds the game's graphics modeling and drawing logic
│ ├── gameDrawing.hpp # Holds the header for gameDrawing.cpp
│ ├── gameStructs.hpp # Holds the game data structures and static variables
│ └── main.cpp # Holds the main source code of the game, connecting everything
├── LICENSE.txt # The License of the project; MIT License
└── README.md # The README file
```
## Getting Started
Clone this repo and cd into it:
```
git clone https://github.com/A-Tokyo/cave-runner
cd cave-runner
```
If you are using macOS:
> - Open cave-runner.xcodeproj , it opens an xCode project.
If you are using windows:
> - Open the cave-runner directory in Microsoft Visual Studio as a project
> - comment the following lines:
> * #include \
> * #include \
> * #include \
> - add the following line:
> * #include \
## Contribution
#### Style Guide:
This project uses camelCase naming, single-quotes, 4 space indentation and multiple comments per function.
Use a single space after keywords.
Ex:
* int x = 3;
* int main(int argc, char** argv) { ... }