Suduxu
Reference

Config

Reference for the suduxu.json configuration file.

Configuration

Suduxu is configured through a suduxu.json file located next to the native runtime. Suduxu provides a service for creating suduxu.json files with custom configurations under Suduxu Configurator.

Example Configuration

{
  "server": {
    "address": "0.0.0.0",
    "port": 9000,
    "tcp_port": null,
    "udp_port": null,
    "file_port": null,
    "connection_strategy": "Open",
    "list": null,
    "rate_limit": {
      "enabled": false,
      "max_tcp_requests_per_minute": null
    }
  },
  "logging": {
    "debug_level": "Debug",
    "log_file": null,
    "max_log_size": null,
    "log_to_console": true
  },
  "security": {
    "enabled": false,
    "password": null
  },
  "file_sharing": {
    "enabled": false,
    "shared_directory": null,
    "files": null,
    "initially_loaded": null
  },
  "devices": {
    "initially_send_sensor_data": false,
    "max_devices": 4,
    "allowed_device_types": [
      "Android",
      "iOS",
      "Windows",
      "Linux",
      "macOS",
      "Other"
    ],
    "initial_frame_rate": 60
  },
  "screen_capture": {
    "enabled": false,
    "capture_on_server": false,
    "capture_directory": null
  },
  "sensors": {
    "accelerometer": true,
    "gyroscope": true,
    "magnetometer": true,
    "temperature": false,
    "humidity": false,
    "pressure": false,
    "light": false
  },
  "developer": {
    "prefer_cli": false,
    "allow_mocked_sensors": false,
    "allow_mocked_buttons": false
  },
  "health_check": {
    "server": {
      "enabled": false,
      "interval_ms": null,
      "timeout_ms": null
    },
    "client": {
      "enabled": false,
      "interval_ms": null,
      "timeout_ms": null
    }
  }
}

server

Controls networking and client connections.

Prop

Type

server.rate_limit

TCP request rate limiting configuration.

Prop

Type

{
  "rate_limit": {
    "enabled": true,
    "max_tcp_requests_per_minute": 1000
  }
}

logging

Controls runtime logging.

Prop

Type


security

Controls password protection.

Prop

Type

If security is enabled and no password is provided, Suduxu automatically generates a six-digit integer.


file_sharing

Controls file and theme distribution.

Prop

Type

SharedFile

Prop

Type

{
  "name": "Default Theme",
  "path": "themes/default.xml",
  "type": "XML-Theme"
}

ThemeConstraints

Prop

Type

{
  "max_width": 1200,
  "min_width": 320
}

devices

Controls connected devices.

Prop

Type


screen_capture

Controls screenshot support.

Prop

Type


sensors

Controls available sensor streams.

Prop

Type


developer

Developer-only features.

Prop

Type

Developer options should be disabled for production deployments.


health_check

Connection health monitoring, configured separately for server and client.

health_check.server / health_check.client

Prop

Type

{
  "client": {
    "enabled": true,
    "interval_ms": 1000,
    "timeout_ms": 5000
  },
  "server": {
    "enabled": true,
    "interval_ms": 1000,
    "timeout_ms": 5000
  }
}

On this page