web: Add BaseLoadOptions.customPlayerVersionString

Author: Dinnerbone

web/packages/core/src/internal/builder.ts

@@ -88,6 +88,9 @@ export function configureBuilder(
     if (isExplicit(config.playerVersion)) {
         builder.setPlayerVersion(config.playerVersion);
     }
+    if (isExplicit(config.customPlayerVersionString)) {
+        builder.setCustomPlayerVersionString(config.customPlayerVersionString);
+    }
     if (isExplicit(config.preferredRenderer)) {
         builder.setPreferredRenderer(config.preferredRenderer);
     }

web/packages/core/src/public/config/default.ts

@@ -44,6 +44,7 @@ export const DEFAULT_CONFIG: Required<BaseLoadOptions> = {
     publicPath: null,
     polyfills: true,
     playerVersion: null,
+    customPlayerVersionString: null,
     preferredRenderer: null,
     openUrlMode: OpenURLMode.Allow,
     allowNetworking: NetworkingAccessMode.All,

web/packages/core/src/public/config/load-options.ts

@@ -602,6 +602,20 @@ export interface BaseLoadOptions {
      */
     playerVersion?: number | null;
 
+    /**
+     * A custom version string to be reported through `Capabilities.version`/`$version`.
+     *
+     * By default, this will be something similar to `32,0,0,0` (depending on {@link playerVersion}).
+     *
+     * This does not change any player behavior, only changing the actual {@link playerVersion} will do that.
+     *
+     * Ordinarily SWFs expect to see four digits separated by a comma - e.g. `32,0,0,465`.
+     * You are not required to stick to this format, but you may break content that expects it.
+     *
+     * @default null
+     */
+    customPlayerVersionString?: string | null;
+
     /**
      * The preferred render backend of the Ruffle player.
      *

web/src/builder.rs

@@ -54,6 +54,7 @@ pub struct RuffleInstanceBuilder {
     pub(crate) log_level: tracing::Level,
     pub(crate) max_execution_duration: Duration,
     pub(crate) player_version: Option<u8>,
+    pub(crate) custom_player_version_string: Option<String>,
     pub(crate) preferred_renderer: Option<String>, // TODO: Enumify?
     pub(crate) open_url_mode: OpenUrlMode,
     pub(crate) allow_networking: NetworkingAccessMode,
@@ -93,6 +94,7 @@ impl Default for RuffleInstanceBuilder {
             log_level: tracing::Level::ERROR,
             max_execution_duration: Duration::from_secs_f64(15.0),
             player_version: None,
+            custom_player_version_string: None,
             preferred_renderer: None,
             open_url_mode: OpenUrlMode::Allow,
             allow_networking: NetworkingAccessMode::All,
@@ -247,6 +249,11 @@ impl RuffleInstanceBuilder {
         self.player_version = value;
     }
 
+    #[wasm_bindgen(js_name = "setCustomPlayerVersionString")]
+    pub fn set_custom_player_version_string(&mut self, value: Option<String>) {
+        self.custom_player_version_string = value;
+    }
+
     #[wasm_bindgen(js_name = "setPreferredRenderer")]
     pub fn set_preferred_renderer(&mut self, value: Option<String>) {
         self.preferred_renderer = value;
@@ -690,6 +697,7 @@ impl RuffleInstanceBuilder {
             .with_letterbox(self.letterbox)
             .with_max_execution_duration(self.max_execution_duration)
             .with_player_version(self.player_version)
+            .with_custom_version_string(self.custom_player_version_string.clone())
             .with_player_runtime(self.player_runtime)
             .with_compatibility_rules(self.compatibility_rules.clone())
             .with_quality(self.quality)