Custom protocol handler

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:

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.

• https://api.resonite.com/open/world/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

• https://api.resonite.com/open/session/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

Re-register the Protocol Handler

If you have moved your game install or if the protocol handler is no longer registered, you can manually trigger the setup process.

1. Open a terminal window
2. Navigate to your game install folder, then into Tools\ResoniteProtocolHandler
3. Run ResoniteProtocolHandler.exe setup
4. You will see "Registration successful!" if everything worked correctly

Register the Protocol Handler on Linux

The automated handler setup mechanism described above only works on Windows computers. On Linux systems, the Resonite bootstrap process is not yet capable of setting up the URL handling system-wide. Until this is updated, a manual operation is required to setup the Resonite protocol handler, which is necessary to make the buttons and links on go.resonite.com function. The procedure to set this up is described on the Linux notes page.