Building for Android

Note: These build steps are still under development and may change as the project evolves.

Prerequisites

General Requirements:

• Android Studio
• NDK Version: 25.2.9519653
• CMake Version: 3.22.1
• Git

For Windows Users Only:

• Visual Studio 2022 Community Edition
  • During installation, ensure the “Desktop development with C++” workload is selected.
  • If already installed, confirm it’s updated to the latest version.
• Vulkan SDK
  • Install the latest available version during setup.

Cloning the Repository

To get the source code for suyu, use the following Git command:

git clone --recursive https://git.suyu.dev/suyu/suyu.git

The project will be saved in the following default directories:

• Windows: C:\Users\<your-username>\suyu
• Linux: ~/suyu
• macOS: Chosen by user during cloning

Build Instructions

1. Launch Android Studio.
2. On the welcome screen, select Open.
3. Navigate to the suyu/src/android folder and click OK.
4. Go to Build > Select Build Variant, then choose either release or relWithDebInfo as the active build variant.
5. Compile the app via Build > Make Project, or run it directly on an Android device using Run > Run ‘app’.

Additional Resources

• Get Started with Android Studio