-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
59 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
|  | ||
|
|
||
| --- | ||
|
|
||
| # Tate Runner | ||
|
|
||
| Hey! Welcome to the official repository of my **2D-Scroller Game** called TateRunner. During my first year of Software Engineering, I had 8 weeks to work on a game. I chose to almost completely write it from scratch, and ended up with a pretty awesome game, if I may say so myself! | ||
|
|
||
| | ||
|
|
||
| ### 💻 Software | ||
|
|
||
| I wrote this project in C++ using the Arduino framework, which I learned by following multiple classes at my university | ||
| and doing a lot of research online. By combining a very intelligent IDE like Clion by Jetbrains, and Platformio, I was | ||
| able to write and test my code very efficiently. | ||
|
|
||
| #### Launching the Game (!! **Java17 REQUIRED** !!) | ||
|
|
||
| ```java | ||
| public final class TateRunnerBootstrap { | ||
|
|
||
| public static void main(String[] args) { | ||
| try { | ||
| // Initialize the game and call the start game function | ||
| final TateRunnerGame tateRunner = new TateRunnerGame(); | ||
| tateRunner.startGame(args); | ||
|
|
||
| // Add a shutdown hook to the runtime | ||
| Runtime.getRuntime().addShutdownHook(new Thread(tateRunner::stopGame)); | ||
| } catch (Throwable throwable) { | ||
| throwable.printStackTrace(); | ||
| System.exit(throwable.hashCode()); | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| You can start the game by running the TateRunnerBootstrap. This will initialize the game and call the startGame function. It will also add a shutdown hook to the runtime, which will call the stopGame function when the game is closed. | ||
| _Java 17 is required to run the game._ | ||
|
|
||
| | ||
|
|
||
| ### 🔧 UML Diagram | ||
|
|
||
| Open the image in a new tab to see it in full size, and have the ability to zoom in and out. | ||
|
|
||
|  | ||
|
|
||
| | ||
|
|
||
| ### 📹 Preview Images | ||
|
|
||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  | ||
|  |