Arguments de lancement

From Resonite Wiki
Revision as of 07:15, 6 February 2024 by J4 (talk | contribs) (Created page with "Maison et Userspace seront disponible sur le réseau local par défaut")

La version bureau de Resonite supporte des options de lancement. La pour la plupart de ces options, vous pouvez utiliser le lanceur de Resonite (pas encore publié) pour les configurer dans une version plus visuelle et les sauvegarder entre les lancements.

Ces options de lancement peuvent être utiles pour créer des expériences autonomes.

Forcer du matériel spécifique

  • rien - auto détection
  • -SteamVR - SteamVR
  • -RiftTouch - Oculus Rift + manettes Touch
  • -Screen - Mode écran (aussi appelé Desktop Mode)
  • -Screen360 - Mode écran (avec projection 360)
  • -StaticCamera - Mode caméra non-interactif
  • -StaticCamera360 - Mode caméra non-interactif utilisant le rendu 360 equirectangle
  • -MixedRealityCamera - Mode caméra non-interactif utilisant le rendu réalité mixte
  • -LegacySteamVRInput - Forcer l'utilisation de l'ancienne manière d'entrée de SteamVR. Est utilisé comme correctif pour le matériel SteamVR qui manquent ou ont un mauvais squelette comme Virtual Desktop, utilisé par Oculus Quest.
  • -ForceSRAnipal - Force le SDK SRAnipal a s'initialiser pour le traqueur HTC pour les yeux et le visage, même si le Vive Pro Eye n'est pas présent.
  • -LegacyScreen - Forcer Resonite a lancer l'ancien mode écran en mode debug.
  • -EnableOWO Insert_ip_address_here - Active la vest haptique OWO, demande l'adresse IP de votre veste. Ne fonctionne pas pour le moment, voir 186.

Rejoindre des sessions / Ouvrir des mondes

  • -Join Auto - Automatiquement rejoint et suit les sessions active sur le réseau local (va dans le monde ayant le plus d'utilisateurs)
  • -Join Insérer_URL_ou_IP:Port_Ici - Rejoint une session avec une URI donnée (Resonite-session | lnl)
  • -Open Insérer_URL_ici - Ouvre un monde depuis une URL au lancement (resrec)
  • -Scratchspace Insérer_port_ici - Démarre un scratchspace sur un port donné (vieux, va probablement être retiré)
  • -AnnounceHomeOnLAN - Maison et Userspace seront disponible sur le réseau local par défaut
  • -Bootstrap Insérer_classe_de_démarrage_ici - Run a custom 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
  • -ForceRelay - Skips the NAT Punchthrough process when connecting to a session, effectively forcing the use of the Relay Server
  • -UseLocalCloud - Uses local cloud API servers - used mostly for debugging
  • -UseStagingCloud - Uses Staging API servers - used mostly for debugging

== Drone Camera presets ==

These initialize the static camera with a drone script, using a specific movement preset.

  • -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 Data Folders, these have various command line arguments to control:

== 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 (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 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) ==

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.

  • 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:

Dashboard on the "Session" tab and the "Settings" selected with the button "Copy Record URL" highlighted

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.

When linking to a world on a platform that restricts the clickability protocol handlers, you can use the redirect junction located at https://api.resonite.com/open/ instead. They will redirect to use the above Resonite: protocol handler.

== Unity Standalone Player command line arguments ==

The 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 -screen-fullscreen 0 -screen-width 1280 -screen-height 720 Resonite will launch in a 1280x720 window.

== How to use command line arguments ==

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 D:\Temporary files\ResoniteCache\. 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.

=== Launching from Steam ===

  1. Open Steam
  2. Right click on Resonite in your library
  3. Select "Properties" and then "Set Launch Options".
  4. Enter the command you need to use, exactly as it appears above and Run Resonite.

Setting custom launch options via Steam

Now, if Resonite is launched via Steam, the custom command line arguments will take effect.

Commands entered via this method will not take effect if Resonite is launched any other way, such as directly launching the Resonite.exe.

=== For the Standalone build ===

Use a shortcut

It is possible to use launch commands via a custom shortcut targeting the Resonite.exe file.

To create a shortcut:

  1. Find the Resonite install folder and right-click on the Resonite.exe.
  2. In the context menu click 'Create Shortcut'
  3. Move the 'Resonite.exe - Shortcut' file to somewhere more convenient (such as the Desktop).
  4. Right-click on the shortcut file and click 'Properties' in the context menu.
  5. This opens a dialog window. Select the 'Shortcut' tab.
  6. In the 'Target' text box add a space after the Resonite.exe filepath and then add your command line arguments.
  7. Click 'Apply' and 'OK'.

Now, if Resonite is launched by double clicking on the shortcut it will launch using the custom options. These will not be applied if a different method is used to start Resonite.

Setting custom launch options for a Shortcut