From 456612d272a7a47ba03ee8cf2242adf421784c22 Mon Sep 17 00:00:00 2001 From: spectranator Date: Fri, 26 Jul 2024 18:21:41 +0200 Subject: [PATCH] Update documentation for Android --- README.md | 4 +--- build-for-android.md | 33 ++++++++++++++++++++++++++++++++- 2 files changed, 33 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 410452bcc..6bf47f6ab 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ SPDX-License-Identifier: GPL-2.0-or-later

torzu is a fork of yuzu, an open-source Nintendo Switch emulator.
-It is written in C++ with portability in mind and runs on Linux and Windows +It is written in C++ with portability in mind and runs on Linux, Windows and Android

## Fake websites @@ -58,8 +58,6 @@ It is very important to me that this project is going to be a good base to fork A secondary goal is the improvement of usability on low-end systems. This includes both improving the performance of the emulator as well as making games more playable below 100% speed whenever possible (the sync CPU to render speed limit option already helps with that in few cases). -Android support is low priority but would be a nice bonus. - ## Development Most of the development happens on [Dark Git](http://vub63vv26q6v27xzv2dtcd25xumubshogm67yrpaz2rculqxs7jlfqad.onion/). It's also where [our central repository](http://vub63vv26q6v27xzv2dtcd25xumubshogm67yrpaz2rculqxs7jlfqad.onion/torzu-emu/torzu) is hosted. diff --git a/build-for-android.md b/build-for-android.md index d1b218db5..c48973e6c 100644 --- a/build-for-android.md +++ b/build-for-android.md @@ -1,11 +1,16 @@ -## Note: These build instructions are a work-in-progress. +## Using Android Studio + +**Note: These build instructions are a work-in-progress.** + ### Dependencies * [Android Studio](https://developer.android.com/studio) * [NDK 25.2.9519653 and CMake 3.22.1](https://developer.android.com/studio/projects/install-ndk#default-version) * [Git](https://git-scm.com/download) + #### WINDOWS ONLY - Additional Dependencies * **[Visual Studio 2022 Community](https://visualstudio.microsoft.com/downloads/)** - **Make sure to select "Desktop development with C++" support in the installer. Make sure to update to the latest version if already installed.** * **[Vulkan SDK](https://vulkan.lunarg.com/sdk/home#windows)** - **Make sure to select Latest SDK.** + ### Cloning yuzu with Git **from Codeberg repo (the `--recursive` option automatically clones the required Git submodules):** ``` @@ -22,6 +27,7 @@ yuzu by default will be cloned into: * `C:\Users\\torzu` on Windows * `~/torzu` on Linux * And wherever on macOS + ### Building 1. Start Android Studio, on the startup dialog select `Open`. 2. Navigate to the `torzu/src/android` directory and click on `OK`. @@ -30,3 +36,28 @@ yuzu by default will be cloned into: ### Additional Resources https://developer.android.com/studio/intro + +## Using CLI + +**Note: These build instructions are for building on Debian Bookworm or newer** + +### Dependencies +``` +sudo apt-get update +sudo apt-get install -y sdkmanager openjdk-17-jdk build-essential curl git pkg-config glslang-tools zip +sudo sdkmanager "ndk;26.1.10909125" "platforms;android-34" "build-tools;33.0.1" "cmake;3.22.1" "platform-tools" +sudo update-alternatives --config java # Select Java 17 here if possible +``` + +### Cloning Yuzu with Git +Follow clone instructions for Android Studio above + +### Build +``` +./externals/vcpkg/bootstrap-vcpkg.sh -disableMetrics +export ANDROID_HOME=/opt/android-sdk +cd src/android +./gradlew assembleRelease +``` + +The APK will be at `src/android/app/build/outputs/apk/mainline/release/app-mainline-release.apk`