Documentation Update

.github/workflows/build.yml

@@ -0,0 +1,20 @@
+name: Build
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  sonarcloud:
+    name: SonarCloud
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

README.md

@@ -1,14 +1,36 @@
-# Unity MegaMan 8 Bit Engine
+# MegaMan 8-Bit Engine for Windows and Mac (Playable Without Unity)
 
 
 ## Info
-As the Blue Bomber doesn't get much love in Unity projects, I thought I would make a simple MegaMan project in Unity 2D and release it for everyone to use.
+Playable MegaMan project made by MegaChibisX, based on the classic 2d games developed by Capcom. This is the beta version of the game for Windows and Mac that does not require Unity to be installed in order to run. If you want to access the game engine itself (open source) or check out the game with Unity, here's the link: https://github.com/MegaChibisX/MegaMan-Unity-8Bit-Engine
 
-In this repository you can find the playable files by themselves, so you don't have to use or have Unity. Windows and Mac versions included.
+## Features
+Intro Cutscene <br />
+6 Playable Characters <br />
+8 Robot Master Levels <br />
+Fortress Stages <br />
+Multiple Weapons, Abilities, and Collectables <br />
+Keyboard and Controller Support <br />
++More
 
+## How to Play
+Simply open the MegaMan-Unity-8Bit-Engine-ButOnlyTheGame folder, and navigate through the Windows or Mac folder until you find the MegaMan Engine file and run it
 
-Beta version out! Let me know what you think, and inform me of any bugs!
+## Controls
+To remap controls, on launch select Input and double click the control(s) you want to change
+
+Defaults <br />
+Left/Right: Left/Right arrow <br />
+Jump: Z <br />
+Shoot: X <br />
+Charge Shot: Hold X <br />
+Slide: V <br />
+Switch Weapon: A or S <br />
+Switch Gear: Q or W <br />
+Menu/Select: Return
 
+## Bugs
+Please feel free to report any bugs found
 
 ## Contact
 Twitter: https://twitter.com/MegaChibisX
@@ -17,19 +39,13 @@ DeviantArt: https://www.deviantart.com/megachibisx
 
 Discord: MegaChibisX #0577
 
+## Copyright
+The MegaMan franchise is owned by Capcom.
 
-## Open source
+Sprites from: https://www.sprites-inc.co.uk/
 
-You can find the actual engine, completely open source, over here: https://github.com/MegaChibisX/MegaMan-Unity-8Bit-Engine
+2d extras from: https://github.com/Unity-Technologies/2d-extras
 
 
-## Controls
-
-Keyboard and Controller controls are supported. Controllers might be a bit clunky though. Remapping from inside the game is not supported yet.
 
-# Keyboard:
-Jump: Z
-Shoot: X
-Weapon Switch: A or S
-Gears: Q or W
 

sonar-project.properties

@@ -0,0 +1,13 @@
+sonar.projectKey=ADean03_MegaMan-Unity-8Bit-Engine-ButOnlyTheGame
+sonar.organization=adean03
+
+# This is the name and version displayed in the SonarCloud UI.
+#sonar.projectName=MegaMan-Unity-8Bit-Engine-ButOnlyTheGame
+#sonar.projectVersion=1.0
+
+
+# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows.
+#sonar.sources=.
+
+# Encoding of the source code. Default is default system encoding
+#sonar.sourceEncoding=UTF-8