inix/eden

[docs] add into docs/ and make links local (#93 )

Co-authored-by: crueter <crueter@eden-emu.dev>
Reviewed-on: eden-emu/eden#93
Co-authored-by: lizzie <lizzie@eden-emu.dev>
Co-committed-by: lizzie <lizzie@eden-emu.dev>

2025-07-23 09:53:45 +02:00

2.1 KiB

Raw 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 wherever on macOS

Building

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

Building with Terminal

Download the SDK and NDK from Android Studio.
Navigate to SDK and NDK paths.
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.
Navigate to eden/src/android.
Then Build with ./gradlew assemblerelWithDebInfo.
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

2.1 KiB Raw Blame History