A template project that aims to make it as easy as possible to get started with the development of cross-platform games/apps made in SDL3.
Based on the SDL_helloworld example project.
- GNU Make
- CMake
- Android SDK Command-Line Tools (Android only)
- OpenJDK 17 (Android only)
- Inkscape (Android only)
- Emscripten SDK (Web only)
SDL itself is not required to be installed on your system. It will be automatically downloaded as needed when building the app.
Building the Android app requires installing the command-line tools and accepting the relevant license terms.
On Arch Linux, this can be achieved with:
sudo pacman -S --needed android-tools jdk17-openjdk
yay -S --needed android-sdk-cmdline-tools-latest
sudo sdkmanager --licensesAfterwards, run make android,
which will generate the .apk binaries in
android/app/build/outputs/apk.
Or, to install the app directly onto a mobile device for debugging,
run make android-dev
(requires a USB-connected Android device).
Run make desktop or make web accordingly,
which will generate the executable in build/sdl-helloworld once completed.
If you want to build the app using the system-installed version of SDL instead,
append DOWNLOAD_DEPENDENCIES=OFF to the appropriate command.
Customizing the template for your app just requires opening the .env file
and changing the template values to your liking.
You should also create your own icons for the Android app
(we recommend Inkscape for creating scalable vector images).
Save the finished icons in the assets/ directory,
overwriting the template icons.
Then,
you can run make android to apply the changes to the Android project files
and build your custom Android app.
Commit the changes to the repository afterwards.
The makefile itself contains scripts for performing common operations
including building and installing the app for all supported platforms.
Run make to see the list of available options.
This project uses Cppcheck and Uncrustify for static code analysis and formatting, respectively.
The uncrustify.cfg file documents the currently enforced code style,
but feel free to change the style however you like.
A make lint command is provided to check that the code conforms to both tools,
as well as a make lint-fix command to fix any errors found.
You can also add the make lint command as a pre-commit hook:
echo 'make -s lint' >> .git/hooks/pre-commit