octocar/eden
1
0
Fork 0
forked from eden-emu/eden
Code Pull requests Activity
eden/docs/build/Android.md
crueter e1ffeec212
[docs] refactor: full rewrite, generalization + dedup (#488) 
"docs but awesome"

Combines most of the stuff that was repeated thrice over verbatim into a
single common Build Instructions page, with additional caveats marked
elsewhere. Prettifies some stuff too because why not.

cc: @Lizzie @DraVee @MaranBr @SDK-Chan

Co-authored-by: Caio Oliveira <caiooliveirafarias0@gmail.com>
Reviewed-on: eden-emu/eden#488
Reviewed-by: Lizzie <lizzie@eden-emu.dev>
Reviewed-by: MaranBr <maranbr@eden-emu.dev>
2025-09-18 02:37:02 +02:00

2 KiB
Raw Permalink Blame History

Note: These build instructions are a work-in-progress.

Dependencies

WINDOWS ONLY - Additional Dependencies

  • Visual Studio 2022 Community - 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 - Make sure to select Latest SDK.
    • A convenience script to install the latest SDK is provided in .ci\windows\install-vulkan-sdk.ps1.

Cloning Eden with Git

git clone --recursive https://git.eden-emu.dev/eden-emu/eden.git

Eden by default will be cloned into -

  • C:\Users\<user-name>\eden on Windows
  • ~/eden on Linux and macOS

Building

  1. Start Android Studio, on the startup dialog select Open.
  2. Navigate to the eden/src/android directory and click on OK.
  3. In Build > Select Build Variant, select release or relWithDebInfo as the "Active build variant".
  4. Build the project with Build > Make Project or run it on an Android device with Run > Run 'app'.

Building with Terminal

  1. Download the SDK and NDK from Android Studio.
  2. Navigate to SDK and NDK paths.
  3. Then set ANDROID_SDK_ROOT and ANDROID_NDK_ROOT in terminal via export ANDROID_SDK_ROOT=path/to/sdk export ANDROID_NDK_ROOT=path/to/ndk.
  4. Navigate to eden/src/android.
  5. Then Build with ./gradlew assembleRelWithDebInfo.
  6. To build the optimised build use ./gradlew assembleGenshinSpoofRelWithDebInfo.

Script

A convenience script for building is provided in .ci/android/build.sh. The built APK can be put into an artifacts directory via .ci/android/package.sh. On Windows, these must be done in the Git Bash or MinGW terminal.

Additional Resources

https://developer.android.com/studio/intro