banner-by-MysticG

super mario bros. remastered android

this is an android port of the Super Mario Bros. Remaster by JoeMama and their team. as of release, this port is nearly feature complete. support me by clicking the dumb dog below!🤎

features

all levels, menus and settings work as they do on pc
online level browser works as expected
android native file picker for rom selection
controller support
on screen/touch controls, which star haptic feedback and a run lock button, and are hidden automatically, once a controller is connected
skip transition screens by tapping on the screen
optimized mobile renderer
pre-baked shader cache within the apk

limitations

the level editor is still completely unimplemented. tracked here
installing resource packs and custom characters can currently only be done manually, via accessing /data/data/net.yrkl.smb1r/files. tracked here

download

get the latest universal release here!

how to contribute

im happy you want to help!! below are the steps to get a development environment, just like my own.

how to fork

log in to your GitHub account
press the fork button on the top right of this page
keep the default name

how to clone

open a powershell, i recommend terminal
install git, if you havent yet
navigate to your projects folder using cd
run git clone https://github.com/YOUR_NAME/super-mario-bros.-remastered-android.git
run cd super-mario-bros.-remastered-android; mkdir .\android\build\libs\release; curl https://github.com/mircey/Godot-Android-Export-Template-libs/releases/download/4.5b3/godot-lib.template_release.aar -OutFile .\android\build\libs\release\godot-lib.template_release.aar; mkdir .\android\build\libs\debug; curl https://github.com/mircey/Godot-Android-Export-Template-libs/releases/download/4.5b3/godot-lib.template_debug.aar -OutFile .\android\build\libs\debug\godot-lib.template_debug.aar
install Godot 4.5 beta 3, if you havent yet
launch Godot
import .\project.godot

how to debug

install the android-sdk by launching android studio for the first time or via sdkmanager
open Godot
Editor -> Editor Settings -> Export -> Android
enter your java sdk and android sdk paths. see the detailed official guide by Godot if you need help.
plug an android device into your pc via usb
enable developer mode on the android device. this depends on the manufacturer, but generally:
1. open settings
2. select Info, About this phone or Device
3. hit the android version number a couple of times. on Xiaomi devices, hit the MIUI or HyperOS version number instead
enable usb debugging and installation via usb on the android device
1. open settings
2. scroll down to Additional settings
3. scroll down to Developer options
4. find USB Debugging and toggle it on
5. find Install via USB and toggle it on
open the project in Godot
find the Remote Deploy button around the top right corner of the window and press it
the game should build and finally launch on your android device, while showing real-time logs in the Godot console

how to build an apk

open the project in Godot
Project -> Export -> Android -> Export Project
choose a target location and give it some time

how to commit and push

cd super-mario-bros.-remastered-android
add all files, that are relevant to your changes, to git via git add .\path\to\file.gd
git commit -a -m "describe your changes here"
check your changes via console output. it should say something like 3 files changed, 21 insertions(+), 4 deletions(-). to check the exact changes, enter git show, use arrow keys to navigate and press q to exit.
push your locally committed changes to your forked repository via git push

how to open a pull request

make sure your have thoroughly tested all of your changes and that they are ready to be merged into the main repository!!
navigate to your forked repository on GitHub
hit the contribute button above source
hit the open pull request button
follow the prompts

credits

thanks to JoeMama, all their contributors on github and everyone else who helped bring the original Windows/Linux version of the game to life.

thanks to Caz Wolf for their amazing work on the on screen/touch control sprites!

thanks to WisconsiKnight, Brackeys and Gwizz for providing Godot tutorials

thanks to Milana for pushing me towards publishing my android port, instead of working on it exclusively privately

thanks to Ömer and Danny for alpha testing and thanks to Kenny for lending me various android devices

thanks to Celizte for researching and implementing a robust fix for missing on screen/touch controls

thanks to MysticG for their amazing work on the banner artwork at the top of the page🤎