From b3058f76f61f60638f5ba7e698b1120ccccfb274 Mon Sep 17 00:00:00 2001 From: Madison Date: Sun, 4 Oct 2026 18:36:18 +0900 Subject: [PATCH] Add a Steam Frame build type with the Khronos OpenXR loader The Frame runs Android apps in a container (Lepton) that has no OpenXR loader broker, so the APK needs its own loader. This adds a "frame" build type: ./gradlew assembleFrame. It's release plus: - applicationId .frame, minSdk 30 (the container is Android 11) - a manifest overlay that drops the headtracking requirement and the Quest/Pico metadata, since the install fails with it - the Khronos loader 1.1.63, fetched from Maven Central at build time, checked against a SHA-256 and unpacked into build/ (not committed) - L1VR_STEAM_FRAME for the native code, BuildConfig.STEAM_FRAME for Java Quest builds don't see any of this. I also added the gradle wrapper script to Projects/Android, since the wrapper jar and properties were already there, and -Wall for the VR sources. Haven't run it on the headset yet. --- .gitignore | 3 + Projects/Android/build.gradle | 75 +++++++ Projects/Android/gradlew | 185 ++++++++++++++++++ Projects/Android/gradlew.bat | 89 +++++++++ .../jni/src/Xash3D/xash3d/engine/Android.mk | 8 + .../Android/src/frame/AndroidManifest.xml | 20 ++ Projects/AndroidPrebuilt/jni/Android.mk | 9 +- .../drbeef/lambda1vr/GLES3JNIActivity.java | 25 ++- 8 files changed, 407 insertions(+), 7 deletions(-) create mode 100755 Projects/Android/gradlew create mode 100644 Projects/Android/gradlew.bat create mode 100644 Projects/Android/src/frame/AndroidManifest.xml diff --git a/.gitignore b/.gitignore index 6cca4ff..3badb58 100644 --- a/.gitignore +++ b/.gitignore @@ -69,3 +69,6 @@ build/intermediates/lint-cache/maven.google/master-index.xml build/intermediates/lint-cache/sdk-registry.xml/sdk-registry.xml assets/AoMDC/models/gmgeneral_display.aomdc /assets/background + +# Steam Frame build: the Khronos OpenXR loader gets fetched here +Projects/Android/build/ diff --git a/Projects/Android/build.gradle b/Projects/Android/build.gradle index 5a6b088..9aaf5ac 100644 --- a/Projects/Android/build.gradle +++ b/Projects/Android/build.gradle @@ -11,6 +11,42 @@ buildscript { apply plugin: 'com.android.application' +// Steam Frame build (./gradlew assembleFrame, see docs/STEAM_FRAME_VR.md). +// The Frame's Android container has no OpenXR loader broker, so the Khronos +// loader goes into the APK. It comes from Maven Central, gets checked against +// this hash and is unpacked into build/ (never committed). Quest builds don't +// touch any of this. +def khronosLoaderVersion = '1.1.63' +def khronosLoaderSha256 = '622419d2f6741c3443a3beb4779af0764318edd01830de967f24c741ebcded73' +def khronosLoaderDir = file("build/openxr-loader/${khronosLoaderVersion}") +def khronosLoaderSo = new File(khronosLoaderDir, 'libopenxr_loader.so') + +def fetchKhronosLoader = tasks.register('fetchKhronosLoader') { + outputs.file khronosLoaderSo + doLast { + def url = "https://repo1.maven.org/maven2/org/khronos/openxr/openxr_loader_for_android/${khronosLoaderVersion}/openxr_loader_for_android-${khronosLoaderVersion}.aar" + def aar = new File(khronosLoaderDir, 'openxr_loader_for_android.aar') + khronosLoaderDir.mkdirs() + new URL(url).withInputStream { input -> aar.withOutputStream { it << input } } + def digest = java.security.MessageDigest.getInstance('SHA-256') + aar.eachByte(8192) { buf, len -> digest.update(buf, 0, len) } + def sha = digest.digest().collect { String.format('%02x', it) }.join() + if (sha != khronosLoaderSha256) { + aar.delete() + throw new GradleException("OpenXR loader AAR has the wrong SHA-256 (${sha}), expected ${khronosLoaderSha256}") + } + def zip = new java.util.zip.ZipFile(aar) + try { + def entry = zip.getEntry('jni/arm64-v8a/libopenxr_loader.so') + if (entry == null) throw new GradleException('libopenxr_loader.so (arm64-v8a) is not in the loader AAR') + zip.getInputStream(entry).withStream { input -> khronosLoaderSo.withOutputStream { it << input } } + } finally { + zip.close() + } + aar.delete() + } +} + android { namespace = "com.drbeef.lambda1vr" @@ -40,6 +76,13 @@ android { minSdkVersion 32 targetSdkVersion 32 + + // True only in the frame build type + buildConfigField 'boolean', 'STEAM_FRAME', 'false' + } + + buildFeatures { + buildConfig true } externalNativeBuild { @@ -103,6 +146,24 @@ android { } } } + + // Valve Steam Frame (Lepton, Android 11). Same as release, plus the + // Khronos OpenXR loader, a manifest overlay (src/frame) and L1VR_STEAM_FRAME + // for the native code. Signed with the debug key, it's only sideloaded. + frame { + initWith release + matchingFallbacks = ['release'] + applicationIdSuffix ".frame" + versionNameSuffix "-frame" + signingConfig signingConfigs.debug + buildConfigField 'boolean', 'STEAM_FRAME', 'true' + + externalNativeBuild { + ndkBuild { + arguments "L1VR_STEAM_FRAME=1", "L1VR_OPENXR_LOADER=${khronosLoaderSo.absolutePath}", "APP_PLATFORM=android-30" + } + } + } } sourceSets.main { @@ -133,6 +194,20 @@ android { ndkVersion '25.1.8937393' } +// Lepton runs Android 11, the Quest build needs 12L (API 32) +androidComponents { + beforeVariants(selector().withBuildType('frame')) { variantBuilder -> + variantBuilder.minSdk = 30 + } +} + +// The loader has to be there before ndk-build links against it +tasks.configureEach { task -> + if (task.name == 'preFrameBuild') { + task.dependsOn fetchKhronosLoader + } +} + dependencies { implementation "com.android.support:support-compat:28.0.0" implementation "com.android.support:support-core-utils:28.0.0" diff --git a/Projects/Android/gradlew b/Projects/Android/gradlew new file mode 100755 index 0000000..744e882 --- /dev/null +++ b/Projects/Android/gradlew @@ -0,0 +1,185 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MSYS* | MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=`expr $i + 1` + done + case $i in + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=`save "$@"` + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +exec "$JAVACMD" "$@" diff --git a/Projects/Android/gradlew.bat b/Projects/Android/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/Projects/Android/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/Projects/Android/jni/src/Xash3D/xash3d/engine/Android.mk b/Projects/Android/jni/src/Xash3D/xash3d/engine/Android.mk index fe1a87b..8d6e2ae 100644 --- a/Projects/Android/jni/src/Xash3D/xash3d/engine/Android.mk +++ b/Projects/Android/jni/src/Xash3D/xash3d/engine/Android.mk @@ -14,6 +14,11 @@ LOCAL_CFLAGS += -D__MULTITEXTURE_SUPPORT__ -DXASH_GLES -DXASH_GL4ES -DUSE_EVDEV #enable VR compatibility LOCAL_CFLAGS += -DVR +# Valve Steam Frame build (gradle assembleFrame, docs/STEAM_FRAME_VR.md) +ifeq ($(L1VR_STEAM_FRAME),1) +LOCAL_CFLAGS += -DL1VR_STEAM_FRAME +endif + LOCAL_CONLYFLAGS += -std=c99 LOCAL_C_INCLUDES := \ @@ -180,6 +185,9 @@ LOCAL_SRC_FILES := \ platform/android/android_nosdl.c \ platform/android/dlsym-weak.cpp +# warnings for the VR layer (argtable3 isn't ours) +$(call add-src-files-target-cflags,$(filter-out %/argtable3.c,$(LAMBDA1VR_SRC_FILES)),-Wall) + LOCAL_LDLIBS := -ldl -llog -landroid -lGLESv3 -lEGL # include default libraries LOCAL_SHARED_LIBRARIES := openxr_loader gl4es diff --git a/Projects/Android/src/frame/AndroidManifest.xml b/Projects/Android/src/frame/AndroidManifest.xml new file mode 100644 index 0000000..9ef52b5 --- /dev/null +++ b/Projects/Android/src/frame/AndroidManifest.xml @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + diff --git a/Projects/AndroidPrebuilt/jni/Android.mk b/Projects/AndroidPrebuilt/jni/Android.mk index 49319aa..7391ffe 100644 --- a/Projects/AndroidPrebuilt/jni/Android.mk +++ b/Projects/AndroidPrebuilt/jni/Android.mk @@ -4,10 +4,17 @@ include $(CLEAR_VARS) LOCAL_MODULE := openxr_loader +# The Steam Frame build passes the Khronos loader it fetched +ifneq ($(L1VR_OPENXR_LOADER),) +LOCAL_SRC_FILES := $(L1VR_OPENXR_LOADER) +LOADER_FILE := $(L1VR_OPENXR_LOADER) +else LOCAL_SRC_FILES := lib$(LOCAL_MODULE).so +LOADER_FILE := $(LOCAL_PATH)/$(LOCAL_SRC_FILES) +endif # NOTE: This check is added to prevent the following error when running a "make clean" where # the prebuilt lib may have been deleted: "LOCAL_SRC_FILES points to a missing file" -ifneq (,$(wildcard $(LOCAL_PATH)/$(LOCAL_SRC_FILES))) +ifneq (,$(wildcard $(LOADER_FILE))) include $(PREBUILT_SHARED_LIBRARY) endif diff --git a/java/com/drbeef/lambda1vr/GLES3JNIActivity.java b/java/com/drbeef/lambda1vr/GLES3JNIActivity.java index 74c8998..c88000e 100644 --- a/java/com/drbeef/lambda1vr/GLES3JNIActivity.java +++ b/java/com/drbeef/lambda1vr/GLES3JNIActivity.java @@ -49,13 +49,26 @@ import static android.system.Os.setenv; manufacturer = "meta"; } - try + if (BuildConfig.STEAM_FRAME) { - //Load manufacturer specific loader - System.loadLibrary("openxr_loader_" + manufacturer); - setenv("OPENXR_HMD", manufacturer, true); - } catch (Exception e) - {} + //The Frame has no loader broker, so the Khronos loader is in the APK + System.loadLibrary("openxr_loader"); + try + { + setenv("OPENXR_HMD", "steamframe", true); + } catch (Exception e) + {} + } + else + { + try + { + //Load manufacturer specific loader + System.loadLibrary("openxr_loader_" + manufacturer); + setenv("OPENXR_HMD", manufacturer, true); + } catch (Exception e) + {} + } System.loadLibrary( "xash" ); }