Standardized documentation pass

README.md

@@ -1,74 +1,66 @@
 # Below The Surface
 
+1. Requires a [SplashKit installation](https://splashkit.io/installation/).
+2. Build using `skm clang++ *.cpp -o below-the-surface` while in the project folder.
+3. Run using `./below-the-surface` while in the project folder.
 
-## How to Install
-
-- Install [Splashkit](https://www.splashkit.io) to your computer 
-- Enter command `git clone https://github.com/thoth-tech/arcade-games` to your terminal
-- Enter command `cd arcade-games/games/BelowTheSurface`
-- Enter command `skm g++ program.cpp -o game`
-- Enter command `./game` to play
-
-<!--
-Orginal Controles for game updated to suit Arcade Machine
- ### **Player 1**   
-
-| Input | Description |     
-| --- | ----------- |   
-| W Key | Jump |          
-| A Key | Move Left |
-| D Key | Move Right |          
-| S Key | Crouch |
-| F Key | Attack/Interact |
-
-### **Player 2**  
-
-| Input | Description |     
-| --- | ----------- |   
-| Up Arrow | Jump |          
-| Left Arrow | Move Left |
-| Right Arrow | Move Right |          
-| Down Arrow | Crouch |
-| L Key | Attack/Interact |
-
-### **Other Buttons**
-
-| Input | Description |     
-| --- | ----------- |   
-| Enter / H Key | Pause |          
-| Enter / F Key | Selection | -->
-
-> controls for arcade machine
-### **Player 1**   
-
-| Input | Description |     
-| --- | ----------- |   
-| Up Key or Left Alt| Jump |          
-| Left Key | Move Left |
-| Right Key | Move Right |          
-| Down Key | Crouch |
-| Left Crtl Key | Attack/Interact |
-
-### **Player 2**  
-
-| Input | Description |     
-| --- | ----------- |   
-| R Key or S Key| Jump |          
-| D Key | Move Left |
-| G Key | Move Right |          
-| F Key | Crouch |
-| A Key | Attack/Interact |
-
-### **Other Buttons**
-
-| Input | Description |     
-| --- | ----------- |   
-| Enter / P Key | Pause |          
-| Enter / Left Ctrl Key | Selection |
-
-
-#### Edited:
-
-- Enter command `skm g++ -O3 program.cpp -o game` for optimisations
-- Reduced resolution on game and assets.
-- Changed button placement and asset placement to better fit new resolution
+_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:** Large
+- **Code quality:** Poor
+- **Gameplay implementation:** Complete
+
+## Gameplay overview
+
+A puzzle-platformer supporting 1-2 players. Players have to redirect the flow of water through pipes while avoiding or eliminating enemies in order to reach the portal at the end of each level.
+
+### Player 1 Controls
+
+| Action        | Key                  |
+|---------------|----------------------|
+| Move Left     | Left arrow           |
+| Move Right    | Right arrow          |
+| Jump / Climb  | Up arrow / Right ALT |
+| Crouch        | Down arrow           |
+| Use/Attack    | Right CTRL           |
+| Dance (both)  | Z                    |
+
+### Player 2 Controls
+
+| Action        | Key                  |
+|---------------|----------------------|
+| Move Left     | D                    |
+| Move Right    | G                    |
+| Jump / Climb  | R / Left ALT         |
+| Crouch        | F                    |
+| Use/Attack    | Left CTRL            |
+| Dance (both)  | Z                    |
+
+## Other
+
+- This game has an associated GUI level editor: [Splashkit-LevelEditor](https://github.com/thoth-tech/Splashkit-LevelEditor).
+- Some miscellaneous documentation from the original authors is in `/docs/`, alongside additional documentation related to level editing.
+- Relevant resources to use the 3rd-party Tiled level editor are in `/levels/tiled/`.
+- The game was originally designed to run at a resolution of 1600x896, but this was lowered to 800x446 for performance reasons on the arcade machines. The change has several implications for gameplay, level design, and screen layout.
+- [Morgaine Barter](https://github.com/MorgaineBarter) has offered to be a point of contact for future students who have need to get in touch from someone on the original team. She can be contacted via e.g., MS Teams via her staff account (not her student account).
+
+## Screenshots
+
+![](/documentation/screenshot-01.png)
+
+![](/documentation/screenshot-02.png)
+
+## Credits
+
+Originally created by 2022-T2 team:
+
+- Morgaine Barter
+- Daniel Agbay
+- Lily Lan
+- Robert Osborne
+- Jiahao Zheng
+- Roy Chen
+- Lachlan Morgan

documentation/README-old-02.md

@@ -0,0 +1,74 @@
+# Below The Surface
+
+
+## How to Install
+
+- Install [Splashkit](https://www.splashkit.io) to your computer 
+- Enter command `git clone https://github.com/thoth-tech/arcade-games` to your terminal
+- Enter command `cd arcade-games/games/BelowTheSurface`
+- Enter command `skm g++ program.cpp -o game`
+- Enter command `./game` to play
+
+<!--
+Orginal Controles for game updated to suit Arcade Machine
+ ### **Player 1**   
+
+| Input | Description |     
+| --- | ----------- |   
+| W Key | Jump |          
+| A Key | Move Left |
+| D Key | Move Right |          
+| S Key | Crouch |
+| F Key | Attack/Interact |
+
+### **Player 2**  
+
+| Input | Description |     
+| --- | ----------- |   
+| Up Arrow | Jump |          
+| Left Arrow | Move Left |
+| Right Arrow | Move Right |          
+| Down Arrow | Crouch |
+| L Key | Attack/Interact |
+
+### **Other Buttons**
+
+| Input | Description |     
+| --- | ----------- |   
+| Enter / H Key | Pause |          
+| Enter / F Key | Selection | -->
+
+> controls for arcade machine
+### **Player 1**   
+
+| Input | Description |     
+| --- | ----------- |   
+| Up Key or Left Alt| Jump |          
+| Left Key | Move Left |
+| Right Key | Move Right |          
+| Down Key | Crouch |
+| Left Crtl Key | Attack/Interact |
+
+### **Player 2**  
+
+| Input | Description |     
+| --- | ----------- |   
+| R Key or S Key| Jump |          
+| D Key | Move Left |
+| G Key | Move Right |          
+| F Key | Crouch |
+| A Key | Attack/Interact |
+
+### **Other Buttons**
+
+| Input | Description |     
+| --- | ----------- |   
+| Enter / P Key | Pause |          
+| Enter / Left Ctrl Key | Selection |
+
+
+#### Edited:
+
+- Enter command `skm g++ -O3 program.cpp -o game` for optimisations
+- Reduced resolution on game and assets.
+- Changed button placement and asset placement to better fit new resolution