Skip to content
Open
Show file tree
Hide file tree
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
Binary file added Documentation/screenshot-01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Documentation/screenshot-02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 42 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,42 @@
# venture-adventure
# Venture Adventure

1. Requires a [SplashKit installation](https://splashkit.io/installation/).
2. Build using `skm clang++ *.cpp -o venture-adventure` while in the project folder.
3. Run using `./venture-adventure` while in the project folder.

_See also: usage documentation for [SplashKit](https://splashkit.io/guides/using-splashkit/0-overview/) and [skm](https://github.com/splashkit/skm/blob/master/README.MD)._

## Technical overview

- **Language:** C++
- **Current scope:** Medium
- **Code quality:** Poor
- **Gameplay implementation:** Complete

## Gameplay overview

A Sokoban clone (box pushing puzzle game) for one player. Move boxes out of the way in order to collect gems. Collect all gems and return to spawn to clear the level.

### Player 1 Controls

| Action | Key |
|-------------|-------------|
| Move Up | Up arrow |
| Move Left | Left arrow |
| Move Right | Right arrow |
| Move Down | Down Arrow |

## Other notes

- Somewhat superceded by the later "Venture Adventure 2" project.
- Miscellaneous documentation is available in `/Documentation/`.

## Screenshots

![](Documentation/screenshot-01.png)

![](Documentation/screenshot-02.png)

## Credits

Originally created by Anthony George in 2022-T2.