feat(Android): Scripting support (#11438) 9112280455

Adds the build flags required to enable scripting. Adds two samples, one for legacy, one for Compose, using the Blinko example.

Also patches the command server to accept script assets and not crash for unrecognized assets.

Co-authored-by: Erik <erik@rive.app>

Author: ErikUggeldahl

.rive_head

@@ -1 +1 @@
-e7142dcfedf6710265bd49fe031c26e663b37f99
+9112280455e25db4649d446601f443c763151649

app/src/main/AndroidManifest.xml

@@ -59,6 +59,12 @@
         <activity
             android:name=".ComposeListActivity"
             android:exported="true" />
+        <activity
+            android:name=".ScriptingActivity"
+            android:exported="true" />
+        <activity
+            android:name=".LegacyScriptingActivity"
+            android:exported="true" />
         <activity
             android:name=".RiveViewActivity"
             android:exported="true" />

app/src/main/java/app/rive/runtime/example/LegacyScriptingActivity.kt

@@ -0,0 +1,23 @@
+package app.rive.runtime.example
+
+import android.os.Bundle
+import androidx.activity.ComponentActivity
+import androidx.activity.SystemBarStyle
+import androidx.activity.enableEdgeToEdge
+import app.rive.runtime.kotlin.RiveAnimationView
+import android.graphics.Color as AndroidColor
+
+class LegacyScriptingActivity : ComponentActivity() {
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        enableEdgeToEdge(
+            statusBarStyle = SystemBarStyle.dark(AndroidColor.BLACK),
+            navigationBarStyle = SystemBarStyle.dark(AndroidColor.BLACK)
+        )
+        val riveView = RiveAnimationView.Builder(this)
+            .setResource(R.raw.blinko)
+            .setAutoBind(true)
+            .build()
+        setContentView(riveView)
+    }
+}

app/src/main/java/app/rive/runtime/example/ScriptingActivity.kt

@@ -0,0 +1,54 @@
+package app.rive.runtime.example
+
+import android.os.Bundle
+import androidx.activity.ComponentActivity
+import androidx.activity.SystemBarStyle
+import androidx.activity.compose.setContent
+import androidx.activity.enableEdgeToEdge
+import androidx.compose.foundation.layout.padding
+import androidx.compose.material3.Scaffold
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.graphics.Color
+import app.rive.Result
+import app.rive.Rive
+import app.rive.RiveFileSource
+import app.rive.RiveLog
+import app.rive.rememberRiveFile
+import app.rive.rememberRiveWorker
+import app.rive.rememberViewModelInstance
+import android.graphics.Color as AndroidColor
+
+class ScriptingActivity : ComponentActivity() {
+    override fun onCreate(savedInstanceState: Bundle?) {
+        super.onCreate(savedInstanceState)
+        enableEdgeToEdge(
+            statusBarStyle = SystemBarStyle.dark(AndroidColor.BLACK),
+            navigationBarStyle = SystemBarStyle.dark(AndroidColor.BLACK)
+        )
+        RiveLog.logger = RiveLog.LogcatLogger()
+
+        setContent {
+            val riveWorker = rememberRiveWorker()
+            val riveFile = rememberRiveFile(
+                RiveFileSource.RawRes.from(R.raw.blinko),
+                riveWorker
+            )
+
+            Scaffold(containerColor = Color(0xFF0C1935)) { innerPadding ->
+                when (riveFile) {
+                    is Result.Loading -> LoadingIndicator()
+                    is Result.Error -> ErrorMessage(riveFile.throwable)
+                    is Result.Success -> {
+                        val file = riveFile.value
+                        val vmi = rememberViewModelInstance(file)
+                        Rive(
+                            riveFile.value,
+                            Modifier.padding(innerPadding),
+                            viewModelInstance = vmi
+                        )
+                    }
+                }
+            }
+        }
+    }
+}

app/src/main/res/raw/blinko.riv

@@ -37,6 +37,8 @@ android {
 
     // Enable removing miniaudio to reduce binary size
     def audioEnabled = !project.hasProperty("noAudio")
+    // Enable removing scripting to reduce binary size
+    def scriptingEnabled = !project.hasProperty("noScripting")
     // Enable ASAN support when debugging
     def asanEnabled = project.hasProperty("asan")
 
@@ -68,6 +70,8 @@ android {
                         "-DANDROID_SUPPORT_FLEXIBLE_PAGE_SIZES=ON",
                         // Toggle miniaudio
                         "-DWITH_RIVE_AUDIO=${audioEnabled ? 'ON' : 'OFF'}",
+                        // Toggle scripting
+                        "-DWITH_SCRIPTING=${scriptingEnabled ? 'ON' : 'OFF'}",
                         // Needed for ASAN support (if enabled)
                         // See https://developer.android.com/ndk/guides/asan#building
                         // and https://developer.android.com/ndk/guides/cmake#android_arm_mode

kotlin/build.gradle

@@ -67,6 +67,16 @@ else ()
     set(RIVE_AUDIO_ARG "disabled")
 endif ()
 
+# Add an option to remove scripting
+# Passed from Gradle with -DWITH_SCRIPTING=ON|OFF
+option(WITH_SCRIPTING "Enable Rive scripting support" ON)
+if (WITH_SCRIPTING)
+    # Flag for Premake
+    set(RIVE_SCRIPTING_ARG "--with_rive_scripting")
+    # Add to the list of static libraries
+    list(APPEND static_libs luau_vm)
+endif ()
+
 # Add an option to enable ASAN
 # Passed from Gradle with -DENABLE_ASAN=ON|OFF
 option(ENABLE_ASAN "Enable Address Sanitizer" OFF)
@@ -113,12 +123,12 @@ else ()
     message(FATAL_ERROR "Unsupported ABI: ${CMAKE_ANDROID_ARCH_ABI}")
 endif ()
 
-# Promote our ${ANDROID_NDK} to an environment var so premake uses the same one.
+# Promote our ${ANDROID_NDK} to an environment var so Premake uses the same one.
 set(ENV{ANDROID_NDK} "${ANDROID_NDK}")
 
 # Build the Rive C++ runtime and its dependencies as static .a libs
 execute_process(
-        COMMAND bash ${RIVE_RUNTIME_DIR}/build/build_rive.sh --file=premake5_cpp_runtime.lua android ninja ${CONFIG} ${RIVE_ARCH} --no-rive-decoders --with_rive_audio=${RIVE_AUDIO_ARG} ${RIVE_ASAN_FLAG} -- rive_cpp_runtime
+        COMMAND bash ${RIVE_RUNTIME_DIR}/build/build_rive.sh --file=premake5_cpp_runtime.lua android ninja ${CONFIG} ${RIVE_ARCH} --no-rive-decoders --with_rive_audio=${RIVE_AUDIO_ARG} ${RIVE_SCRIPTING_ARG} ${RIVE_ASAN_FLAG} -- rive_cpp_runtime
         WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}
         RESULT_VARIABLE SCRIPT_RESULT
         OUTPUT_VARIABLE SCRIPT_OUTPUT

kotlin/src/main/cpp/CMakeLists.txt

@@ -23,5 +23,6 @@ do
         'rive_sheenbidi',
         'rive_yoga',
         'miniaudio',
+        'luau_vm',
     })
 end