Add README.md

Generate native executable

.github/workflows/blank.yml

@@ -17,6 +17,13 @@ jobs:
       with:
         arguments: desktop:dist
         gradle-version: 5.6.2
+    - name: Generate Desktop build
+      run: java -jar packr.jar packr-config.win64.json
+    - name: Archive Release
+      uses: thedoctor0/zip-release@master
+      with:
+        filename: 'win64.zip'
+        basepath: 'out-win64'
     - uses: xresloader/upload-to-github-release@v1
       id: upload_release
       env:

LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright 2020 Srikavin Ramkumar, Nicholas Quach, David Rogers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,59 @@
+# The Quest for Success
+TODO - tagline/simple description
+
+## Gameplay
+
+*The Quest for Success* was designed from the ground up to be an intuitive and fun experience.
+
+## Topic Correlation
+
+TODO
+
+### Controls
+
+| Type | Key |
+|------|-----|
+| Move Left | *Left Arrow* |
+| Move Up | *Up Arrow* |
+| Move Down | *Down Arrow* |
+| Move Right | *Right Arrow* |
+| Use Item | *E* |
+
+## Run Instructions
+
+Launch `quest.exe` in the [`game`](game) directory.
+
+## Development Instructions
+For more technical information, read `technical_readme.md`.
+
+### Running a Development Copy
+1. Open the `src` directory with an editor of your choice
+2. Make changes
+3. Run `gradle desktop:run` to compile and run the updated game
+4. View the [license](./LICENSE.txt)
+
+### Editing Maps
+1. Install [Tiled](https://www.mapeditor.org/)
+2. Open a map in `core/assets/assets/maps` with Tiled
+3. Make changes to the map
+4. Save the map
+5. Run it following the instructions above
+
+### Technologies Used
+ * [IntelliJ IDEA](https://www.jetbrains.com/idea/) - used to efficiently write code
+ * [Adobe Illustrator](https://www.adobe.com/products/illustrator.html) - used to create icons and images
+ * [Gradle](https://gradle.org/) - used to automate builds and manage dependencies
+ * [Git SCM](https://git-scm.org) - used for version control
+ * [Kotlin](http://kotlinlang.org/) - used to write readable and ergonomic code
+ * [Tiled](https://www.mapeditor.org/) - used to create flexible levels
+
+### Dependencies Used
+ * [Kotlin](http://kotlinlang.org/) - used for null-safety and language features
+
+## Screenshots
+
+TODO
+
+
+
+

core/src/me/srikavin/fbla/game/FBLAGame.kt

@@ -49,11 +49,11 @@ class FBLAGame : ApplicationAdapter() {
         val generator = FreeTypeFontGenerator(Gdx.files.internal("assets/fonts/Kenney Pixel.ttf"))
         val parameter = FreeTypeFontGenerator.FreeTypeFontParameter()
         parameter.size = 48
-        val font12: BitmapFont = generator.generateFont(parameter) // font size 12 pixels
+        val font12: BitmapFont = generator.generateFont(parameter)
 
         val fontMap = ObjectMap<String, Any>()
         fontMap.put("KenneyPixel", font12)
-        generator.dispose() // don't forget to dispose to avoid memory leaks!
+        generator.dispose()
 
         assetManager.load("assets/skin/skin.json", Skin::class.java, SkinLoader.SkinParameter(fontMap))
         assetManager.finishLoading()

packr-config.win64.json

@@ -0,0 +1,17 @@
+{
+  "platform": "windows64",
+  "jdk": "https://github.com/ojdkbuild/ojdkbuild/releases/download/java-1.8.0-openjdk-1.8.0.232-2.b09/java-1.8.0-openjdk-1.8.0.232-2.b09.ojdkbuild.windows.x86_64.zip",
+  "executable": "quest",
+  "classpath": [
+    "desktop/build/libs/desktop-1.0.jar"
+  ],
+  "removelibs": [
+    "desktop/build/libs/desktop-1.0.jar"
+  ],
+  "mainclass": "me.srikavin.fbla.game.desktop.DesktopLauncher",
+  "vmargs": [
+    "Xmx1G"
+  ],
+  "minimizejre": "hard",
+  "output": "out-win64"
+}

technical_readme.md

@@ -0,0 +1,4 @@
+# The Quest for Success - Technical Description
+
+
+todo