android-vulkan

Welcome to android-vulkan source code repository. This project was started as personal hobby. Main purpose of the project is learning and implementing the most recent programming techniques for robust 3D game engines on the Android mobile devices. Two years later the project goals were extended to 3D physics engine development, Lua embedded scripting language integration, spatial sound rendering and HTML5 + CSS rendering system for UI.

Introduction

android-vulkan is 3D engine framework. android-vulkan is dedicated to Vulkan API learning, 3D physics engine development, Lua embedded scripting language integration, spatial sound rendering and HTML5 + CSS rendering system for UI.

Documentation

Useful documentation is located here.

Quick start instructions

Requirements

• Windows Vista+ or Monjaro KDE
• Android Studio Koala | 2024.1.1 Patch 1
• Android Studio Gradle Plugin 8.5.1
• Android NDK 27.0.12077973 (side by side)
• _Minimum Android SDK version: Android 11 (API level 30)_
• _Compile Android SDK version: Android 13 (API level 34)_
• Android SDK Build-Tools 35.0.0
• Android SDK Platform-Tools 35.0.1
• Kotlin 2.0.0
• Kotlin Gradle plugin 2.0.0
• CMake 3.22.1
• Gradle 8.9-bin
• DirectX Shader Compiler 1.8.2407.10013 a2a220bc616ca28848ec0af77ad33a09f92fa43a
• libfreetype 2.13.2 37cefe33b284d0bad4ec52bcccc1a8c2d8704340
• libogg 1.3.5 7cf42ea17aef7bc1b7b21af70724840a96c2e7d0
• libvorbis 1.3.7 bb4047de4c05712bf1fd49b9584c360b8e4e0adf
• libvorbisfile 1.3.7 bb4047de4c05712bf1fd49b9584c360b8e4e0adf
• _stbimage 2.30 f7f20f39fe4f206c6f19e26ebfef7b261ee59ee4
• Vulkan Validation Layers 1.3.290 58428b0c0e9cb818ee240857c5b4725df8c5183e
• Lua 5.5.0 c1dc08e8e8e22af9902a6341b4a9a9a7811954cc
• Real Android 11 device with Vulkan 1.1.131 support
• ARM Neon A64 native support

To begin, clone this repository onto your local drive.

Optional: Recompile project shaders to SPIR-V representation via DirectX Shader Compiler. See manual here.

Create and setup Android certificate. See manual here.

Next step is to compile project via Android Studio IDE as usual.

Controller support

XBOX ONE S controller is supported via Bluetooth connection. Other controllers are not tested.