Merge pull request #51 from CCHSFBLA23/docs-update

Added Documentation

DOCS.md

@@ -0,0 +1,26 @@
+# Documentation
+
+### Key Logic:
+ - [BoxHandler.cs](#`BoxHandler.cs`)
+ - [AudioManager.cs](#`AudioManager.cs`)
+ - [SceneHandler.cs](#`SceneHandler.cs`)
+ - [SaveSystem.cs](#`SaveSystem.cs`)
+ - [LevelHandler.cs](#`LevelHandler.cs`)
+ - [OptionsHandler.cs](#`OptionsHandler.cs`)
+# `BoxHandler.cs`
+ - Handles box & player behavior
+
+# `AudioManager.cs`
+- Handles audio output
+
+# `SceneHandler.cs`
+- Handles scene loading & transitions
+
+# `SaveSystem.cs`
+- Handles save data
+
+# `LevelHandler.cs`
+- Handles level logic
+
+# `OptionsHandler`
+- Handles option management

README.md

@@ -1,2 +1,40 @@
-# game
-description
+# ![WordBox](WordGame.png)
+###  *A sokoban-inspired word puzzle game* 
+CCHS FBLA 2023 Computer Game & Simulation Programming
+___
+
+# Documentation
+See [DOCS.md](DOCS.md)
+# Usage:
+You can download the source code and build the game yourself in Unity if you desire.
+
+A build of the game is provided within the `build/` directory of the source code for your convenience.
+
+To start the game, run `WordGame.exe`. 
+
+# Credits:
+- #### Gil Powers (Game Mechanics & Level Design)
+- #### Zach Goodson (UI & Animation Design)
+- #### Safwan Morshed (Git Coordinator, Music, Level Design)
+# Acknowledgements
+ - All the producers of the public domain loops sampled in the soundtrack and SFX[^1]
+ - Hiroyuki Imabayashi for inspiration (Sokoban)
+ - Hempuli for inspiration (Baba is You)
+ - #### Libraries & Software Used
+   - Unity Game Engine (with C# Scripting)
+   - LiberationSans.ttf (SIL OFL)
+   - VarelaRound.ttf (SIL OFL)
+   - FL Studio 20 - for audio design
+   - Inkscape - asset design
+
+[^1]:  https://www.looperman.com/loops/detail/313141/cool-it-now-lofi-type-loop-free-80bpm-lo-fi-rhodes-piano-loop
+  https://www.looperman.com/loops/detail/317308/lush-124-calm-piano-x-lofi-x-lofigirl-free-124bpm-lo-fi-piano-loop
+  https://www.looperman.com/loops/detail/317567/lofi-acoustic-guitar-oakly-tinna-free-118bpm-lo-fi-acoustic-guitar-loop
+  https://www.looperman.com/loops/detail/318321/mountains-synth-loop-free-85bpm-chill-out-synth-loop
+  https://www.looperman.com/loops/detail/120308/the-mood-by-40a-free-80bpm-chill-out-brass-loop
+  https://www.looperman.com/loops/detail/177379/nc2u-drum-fill-by-bradosanz-free-80bpm-pop-drum-loop
+  https://www.looperman.com/loops/detail/317074/hope-you-die-piano-free-100bpm-chill-out-piano-loop
+  https://www.looperman.com/loops/detail/318496/emotional-grand-piano-3-free-100bpm-orchestral-piano-loop
+  https://freesound.org/people/GameAudio/sounds/220177/
+  https://freesound.org/people/GameAudio/sounds/220184/
+  https://freesound.org/people/GameAudio/sounds/220208/