Export translations

Settings

Group

Language

Format

Export for off-line translation

Export in native format

Export in CSV format

<languages />
<div lang="en" dir="ltr" class="mw-content-ltr">
Desktop builds of Resonite support several command line arguments. For most of these arguments you can use the Resonite Launcher to configure them in a more visual way and save them across launches.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
These command line arguments, can be useful in setting up [[Standalone Experiences]].
</div>

== Forcing specific hardware ==

* ''none'' - autodetect 
* '''-SteamVR''' - SteamVR
* '''-RiftTouch''' - Oculus Rift + Touch controllers
* '''-Screen''' - Screen mode (also called Desktop mode)
* '''-Screen360''' - Screen mode (with 360 projection)
* '''-StaticCamera''' - non-interactive Camera Mode
* '''-StaticCamera360''' - non-interactive Camera Mode using 360 equirectangular rendering
* '''-MixedRealityCamera''' - non-interactive Camera Mode using Mixed Reality rendering
* '''-LegacySteamVRInput''' - Force Legacy Steam VR Input Handling. Used as a work-around for some Steam VR devices that have a missing or bad hand skeletal model, such as Virtual Desktop used with the Oculus Quest.
* '''-ForceSRAnipal''' - Force the SR Anipal SDK to initialize for HTC eye and lip tracking, even if Vive Pro Eye is not present.
* '''-LegacyScreen''' - Force Resonite to run in the old Desktop "debugging" mode.
* '''-EnableOWO ''Insert_ip_address_here''''' - Enables the [https://owogame.com/ OWO Game haptic vest] integration, requires you pass in the vest's ip address. Currently not functional, see related [https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/186 Github issue.]

== Joining sessions / Opening worlds ==

* '''-Join Auto''' - Automatically join and follow active sessions on LAN (will switch to world with most present users)
* '''-Join ''Insert_URL_or_IP:Port_here''''' - Join a session at given URi (Resonite-session | lnl)
* '''-Open ''Insert_URL_here''''' - Open world at given URL on start (resrec)
* '''-Scratchspace ''Insert_port_here''''' - Starts a new scratchspace world on a given port (legacy, will be likely removed)
* '''-AnnounceHomeOnLAN''' - Home and [[Userspace]] will be accessible from LAN by default
* '''-Bootstrap ''Insert_bootstrap_class_here''''' - Run a custom [[Bootstrapping|bootstrap]] function in a class of given name

== Networking ==

* '''-ForceLANOnly''' - All worlds will be forced to announce only on the LAN network by default and won't be accessible from the internet
* '''-UseLocalCloud''' - Uses local cloud API servers - used mostly for debugging
* '''-UseStagingCloud''' - Uses Staging API servers - used mostly for debugging

== Drone Camera presets ==

<div lang="en" dir="ltr" class="mw-content-ltr">
These initialize the static camera with a drone script, using a specific movement preset.
</div>

* '''-CameraBiggestGroup'''
* '''-CameraTimelapse'''
* '''-CameraStayBehind'''
* '''-CameraStayInFront'''

And also these args usable for Drone Camera.
* '''-UseResoniteCamera''' - Will spawn Static Camera as the Resonite Camera with zoom controls, preview and other functions

== Common Avatar Builder ==
* '''-ForceNoVoice''' - CommonAvatarBuilder won't setup any avatars with voice (useful for local presentations)

== Data Folders ==
Resonite has multiple [[Resonite Data Folders|Data Folders]], these have various command line arguments to control:

* You can use [[Relocate Resonite Folders | command line arguments to move]] your data folders to other locations.

== Logs Folder ==

* '''-LogsPath''' ''C:\specified\directory'' - Redirect log files to be saved in a custom specified directory.

== Synchronization Issues ==
* If you're having synchronization issues then see [[Sync Errors]] which has various guides on how to use command line arguments to resolve sync issues.

== Database Repair ==
* If you're having database issues then [[Database repair]] is a guide on how to use a Command Line Argument to resolve the issue.

== Post Processing ==
* '''-ctaa''' - Enables ctaa (Cinematic Temporal Anti-Aliasing)
* '''-ctaaTemporalEdgePower ''Insert_Number_here''''' - Sets ctaa's TemporalEdgePower
* '''-ctaaSharpnessEnabled ''Insert_True_or_False_here''''' - Sets whether ctaa's Sharpness is Enabled
* '''-ctaaAptiveSharpness ''Insert_Number_here''''' - Sets ctaa's ctaaAptiveSharpness amount

== Misc ==
* '''-Watchdog ''Insert_filepath_here''''' - Resonite will periodically write current time into given file. This can be used to restart the process when it freezes
* '''-LoadAssembly ''Insert_path_here''''' - Loads extra CLR assembly into the Resonite process
* '''-Kiosk''' - Will run Resonite in [[Kiosk Mode|Kiosk mode]] (hides the [[Userspace]] items such as logo and world switcher and disables teleporting for guests by default)
* '''-NoUI''' - Hides the [[Userspace]] UI
* '''-CubemapResolution ''Insert_resolution_here''''' - Force the 360 equirectangular rendering to use this resolution for the cubemap
* '''-DoNotAutoLoadHome''' - Wont' automatically load your cloud home on start (can still load manually)
* '''-ResetDash''' - Resets the layout of the dash to the default configuration.
* '''-SkipIntroTutorial''' - Prevents the intro tutorial from starting
* '''-Forceintrotutorial''' - Forces the intro tutorial to run
* '''-Invisible''' - Force your online status to be invisible on login.
* '''-EngineConfig ''Insert_filepath_here''''' - Specifies a custom [[Startup Config File|config file]].
* '''-BackgroundWorkers ''Insert_number_here''''' - overrides the number of background worker processes. '''WARNING:''' Don't use this unless you really need to, things could break!
* '''-PriorityWorkers ''Insert_number_here''''' - overrides the number of priority worker processes. '''WARNING:''' Don't use this unless you really need to, things could break!
* '''-ForceReticleAboveHorizon''' - Disallows looking below the Horizon for desktop when in first person by default.

== Resonite Custom Protocol Handler (Steam only) ==

<div lang="en" dir="ltr" class="mw-content-ltr">
Resonite registers a custom protocol handler with your computer on installation. You can use this to create links which will open Resonite to a set location or world when they are clicked. These arguments are given to the Resonite launcher, which will make sure Resonite is launched and running and forward them to the running instance.
</div>

* '''Resonite:?world=''Insert_URL_here''''' - Open a world or session at given URL
** For example '''Resonite:?world=resrec:///U-ProbablePrime/R-9ce872e1-ffb8-4194-bb91-3d3ab5f157a1''' - Will Open "The Directory" by ProbablePrime
** And for Sessions '''Resonite:?world=Resonite-session://eea1442e-0ff2-4d6a-ad16-2dac9ea786fc''' will join session eea1442e-0ff2-4d6a-ad16-2dac9ea786fc
The URL of a world can be accessed by opening the inspector for a world orb and navigating to the WorldOrb component or by using the Session menu's "Copy Record URL" button:

<div lang="en" dir="ltr" class="mw-content-ltr">
[[File:CopyRecordUrlButton.png|600px|Dashboard on the "Session" tab and the "Settings" selected with the button "Copy Record URL" highlighted]]
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
The URL field can be selected by double clicking into the field. The URL text can be copied to the Windows clipboard via Ctrl+C.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
When linking to a world on a platform that restricts the clickability protocol handlers, you can use the redirect junction located at '''<nowiki>https://api.resonite.com/open/</nowiki>''' instead. They will redirect to use the above Resonite: protocol handler.
</div>

* '''<nowiki>https://api.resonite.com/open/world/</nowiki>''Insert_ID_here''''' - Open a world at given URL
** For example '''https://api.resonite.com/open/world/U-ProbablePrime/R-9ce872e1-ffb8-4194-bb91-3d3ab5f157a1''' - Will Open "The Directory" by ProbablePrime

* '''<nowiki>https://api.resonite.com/open/session/</nowiki>''Insert_ID_here''''' - Open a session at given URL
** For example '''https://api.resonite.com/open/session/S-eea1442e-0ff2-4d6a-ad16-2dac9ea786fc''' will join session S-eea1442e-0ff2-4d6a-ad16-2dac9ea786fc

== Unity Standalone Player command line arguments ==

The [https://docs.unity3d.com/Manual/CommandLineArguments.html Unity Standalone Player command line arguments] can be useful for setting a specific resolution, or the windowed mode.
* '''-screen-fullscreen 0''' - Launch Resonite in a window.
* '''-screen-fullscreen 1''' - Launch Resonite in full-screen.
* '''-screen-width''' - Sets the horizontal resolution.
* '''-screen-height''' - Sets the vertical resolution.
Example: If you use <code>-screen-fullscreen 0 -screen-width 1280 -screen-height 720</code> Resonite will launch in a 1280x720 window.

== How to use command line arguments ==

<div lang="en" dir="ltr" class="mw-content-ltr">
Below are three methods for launching Resonite using non-default command line arguments. Each example explains how to combine the '''-Invisible''' and '''-CachePath ''Insert_path_here''''' commands. Here the examples show how to specify a non-default cache location at <code>D:\Temporary files\ResoniteCache\</code>. '''DO NOT COPY THIS EXAMPLE IF YOU DO NOT NEED TO DO THIS!''' Choosing the best method to use depends on how you normally launch Resonite. For most users, the setup described in [[#Launching from Steam]] is likely the best choice.
</div>

=== Launching from Steam ===
{{SteamCommandLineArguments}}

=== For the Standalone build ===
{{StandaloneCommandLineArguments}}