-
Notifications
You must be signed in to change notification settings - Fork 14
App arguments
This document describes all available application argument flags (AppArgsFlags) that can be passed to the Decentraland Unity Explorer. These flags control various features, behaviors, and configurations during application startup.
Flags can be passed via command line arguments using the format:
--flag-name
--flag-name value
Or embedded in deep links:
decentraland://?flag-name=value&other-flag=true
Description: Enables debug mode. When set, the application runs in debug mode. This flag is automatically added when running in Unity Editor. When enabled, many debug features and development tools become available.
Usage:
--debug
Description: Indicates that the application is running from the DCL Editor (Creator Hub). Used for analytics tracking to distinguish between Unity Editor, DCL Editor, debug builds, and release builds.
Usage:
--hub
Description: Skips the version check that normally runs on startup. Useful for development and testing scenarios where version validation should be bypassed.
Usage:
--skip-version-check
Type: String
Description: Simulates a specific version number for testing purposes. Overrides the actual version detection.
Usage:
--simulateVersion 1.0.0
Description: Forces the minimum system specifications screen to be displayed, regardless of the actual system capabilities. Useful for testing the minimum specs screen UI.
Usage:
--forceMinimumSpecsScreen
Description: Enables the scene console for debugging and development. Only available in debug mode or when running local scenes.
Usage:
--scene-console
Type: String
Description: Sets the Decentraland environment (e.g., org, zone, today). Determines which API endpoints and services the application connects to.
Usage:
--dclenv org
Type: String (URL)
Description: Specifies a custom realm server URL to connect to. Used for connecting to local or custom Decentraland servers. The URL should include the protocol (http:// or https://).
Usage:
--realm=http://127.0.0.1:8000
--realm=https://peer-ap1.decentraland.zone/
Type: Bool
Description: Enables local scene development mode.
Usage:
--local-scene=true
Type: String (coordinates)
Description: Sets the initial spawn position in the world. Format is typically x,y coordinates.
Usage:
--position 100,100
Description: Skips the authentication screen on startup. When set, the user bypasses the login/auth flow.
Usage:
--skip-auth-screen
Type: String
Description: Forces specific emotes to be available for preview. Accepts a comma-separated list of emote URNs (i.e. urn:decentraland:matic:collections-v2:0xa80aea22d0fe9d34ca72ce304ef427bbefee1f11:2 ).
The elements previewed are not visible for others, only for the tester.
Only works for PUBLISHED elements (thus having a URN that identifies them).
Usage:
--self-force-emotes emote1,emote2,emote3
Type: String
Description: Enables preview mode for specific emotes. Accepts a comma-separated list of emote URNs (i.e. urn:decentraland:matic:collections-v2:0xa80aea22d0fe9d34ca72ce304ef427bbefee1f11:2 ) that will be available for preview.
The elements previewed are not visible for others, only for the tester.
Only works for PUBLISHED elements (thus having a URN that identifies them).
Usage:
--self-preview-emotes emote1,emote2
Type: String
Description: Enables preview mode for specific wearables. Accepts a comma-separated list of wearable URNs (i.e. urn:decentraland:matic:collections-v2:0xc11b9d892e12cfaca551551345266d60e9abff6e:3 )
The elements previewed are not visible for others, only for the tester.
Only works for PUBLISHED elements (thus having a URN that identifies them).
Usage:
--self-preview-wearables wearable1,wearable2
Type: String
Description: Enables preview mode for builder collections. Accepts a comma-separated list of collection IDs (e.g. 3062136a-065d-4d94-b28c-f57d6ef04860).
The elements previewed are not visible for others, only for the tester.
Only works for UNRELEASED elements, the tester has to either be the owner of the collection or be whitelisted to test it (e.g. Curators).
Make sure to use the COLLECTION ID (from the collection URL) and not the ITEM ID (from each item URL).
More detailed instructions on how to test can be found in the description of releveant PRs that have worked on the usage of this flag, for example https://github.com/decentraland/unity-explorer/pull/5309
Usage:
--self-preview-builder-collections=collection1,collection2
Description: Disables the disk cache system. All cached assets will be loaded from network or memory instead. Useful for testing cache-related issues or ensuring fresh data loads.
Usage:
--disable-disk-cache
Description: Disables automatic cleanup of the disk cache. Prevents the cache from being automatically cleared or managed.
Usage:
--disable-disk-cache-cleanup
Type: String (integer)
Description: Simulates a specific amount of system memory (in MB). Overrides the actual system memory detection. Useful for testing memory-related features and constraints.
Usage:
--simulateMemory 4096
Type: String (integer, seconds)
Description: Sets the duration (in seconds) before user identity expires. Overrides the default identity expiration time.
Usage:
--identity-expiration-duration 3600
Type: Boolean Description: Launches the Chrome DevTools Protocol (CDP) monitor on application start. Enables remote debugging capabilities.
Usage:
--launch-cdp-monitor-on-start
Type: String (file path)
Description: Specifies a custom path to the Creator Hub binary. Used when the Creator Hub needs to be launched from a non-standard location.
Usage:
--creator-hub-bin-path=/path/to/creator-hub
Type: String (file path)
Description: Enables logging to a matrix file. The value should be the path to the log matrix file.
Usage:
--use-log-matrix=/path/to/log-matrix.txt
Type: Boolean Description: Forces the application to run in windowed mode instead of fullscreen.
Usage:
--windowed-mode
Type: String (URL)
Description: Overrides the default feature flags service URL. Used to connect to a custom feature flags server.
Usage:
--feature-flags-url https://custom-feature-flags.example.com
Type: String
Description: Overrides the hostname used for feature flags requests. Used for custom feature flag configurations.
Usage:
--feature-flags-hostname my-custom-hostname
Type: String
Description: Sets a custom session ID for analytics tracking. Overrides the automatically generated session ID.
Usage:
--session_id=abc123xyz
Type: String
Description: Sets the launcher anonymous ID for analytics tracking. Used to link analytics data between the launcher and the explorer.
Usage:
--launcher_anonymous_id=user123
- Most boolean flags are presence flags (they don't require a value). Simply including
--flag-nameenables the feature. - Some flags accept string values that can be boolean-like (
"true"or"false"). - Flags can be combined in a single command line invocation.
- Deep links can embed multiple flags:
decentraland://?realm=http://127.0.0.1:8000&local-scene=true&skip-auth-screen=true - The
debugflag is automatically added when running in Unity Editor. - Some flags are only effective when combined with the
debugflag or when running in Unity Editor.
--local-scene --skip-auth-screen true --position 100,100 --debug
--realm=http://127.0.0.1:8000 --debug --scene-console --windowed-mode
--simulateMemory 2048 --disable-disk-cache --debug
--self-preview-wearables wearable1,wearable2,wearable3 --debug