Super Mario Runner

A fusion of two gaming classics with Super Mario Runner! This Java-based recreation seamlessly blends the timeless charm of the Chrome Dino game with the vibrant world of Super Mario Bros.

Table of Contents

• Features
• Getting Started
• System Requirements
• Contribution
• Folder Structure
• Dependency Management
• License

Features

• A Super Mario-style environment
• Score tracking
• Pause/Resume
• Key bindings for all actions
• Randomized obstacle spawning
• Collision detection & death/game-over
• Audio & background music
• Toggle microphone (for audio feedback)
• Debug mode for easier testing

• Power-ups
• Flying obstacles
• Gamepad support
• 3D modeling & vector graphics
• Mobile device & touch screen support
• And more...

Getting Started

To start the game, simply run the App class.

System Requirements

OS: Windows 10 (64-bit) or later
CPU: Intel® 6th Generation or newer or AMD Ryzen™ 1000 Series or newer
GPU: Interegrated Graphics (IGPU, APU) with a minimum of 128MB VRAM
Memory: *Unspecified
Storage: 100MB of free space for Development, or *35MB of free space for Production/Release/Playing-condition
Display: Dedicated display with a refresh rate of 60Hz or better
JDK/JVM: OpenJDK 20 or later
<sub>* Memory requirements depend on JVM and other system configurations.
* Additional 25MB required for git clone.</sub>

Contribution

• Clone the repository by running:

git@github.com:siMobin/superMarioRunner.git

Note

If you don't have an SSH key set up, you can also run:

https://github.com/siMobin/superMarioRunner.git

Or, you can use GitHub CLI:

gh repo clone siMobin/superMarioRunner

• Install the recommended extensions on VS Code:

  Extension Pack for Java

• Compile the source code:

  You can compile it through the Extension Pack for Java, or run the following commands:

  javac App.java
  java App.class
  

  or Simply run the following scripts:

  compiler.ps1
  run.ps1

Download the full documentation

Folder Structure

The workspace contains three folders by default, where:

• src: the folder to maintain sources
• lib: the folder to maintain dependencies & assets
• bin: the folder to store all binary/class file

The compiled output files will be generated in the bin folder by default.

Note

If you want to customize the folder structure, open .vscode/settings.json and update the related settings there.

Dependency Management

Important

External dependencies should be placed directly into the lib folder.

The JAVA PROJECTS view allows you to manage your dependencies. More details can be found here.

License

This project is licensed under the BSD 3-Clause License. See LICENSE for details.