mirror of
https://notabug.org/litucks/torzu.git
synced 2024-11-23 06:49:42 +00:00
Update documentation for Android
This commit is contained in:
parent
f38060714a
commit
456612d272
@ -13,7 +13,7 @@ SPDX-License-Identifier: GPL-2.0-or-later
|
||||
|
||||
<h4 align="center"><b>torzu</b> is a fork of yuzu, an open-source Nintendo Switch emulator.
|
||||
<br>
|
||||
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
|
||||
</h4>
|
||||
|
||||
## 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.
|
||||
|
@ -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\<user-name>\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`
|
||||
|
Loading…
Reference in New Issue
Block a user