diff --git a/Documentation/screenshot-01.png b/Documentation/screenshot-01.png new file mode 100644 index 0000000..cb36571 Binary files /dev/null and b/Documentation/screenshot-01.png differ diff --git a/Documentation/screenshot-02.png b/Documentation/screenshot-02.png new file mode 100644 index 0000000..9109614 Binary files /dev/null and b/Documentation/screenshot-02.png differ diff --git a/README.md b/README.md index a1bfe24..6318123 100644 --- a/README.md +++ b/README.md @@ -1 +1,42 @@ -# venture-adventure \ No newline at end of file +# 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.