Kiosk Mode: Difference between revisions

From Resonite Wiki
Added stub.
Add example use-case and link to other commands useful in conjunction with this mode
 
Line 4: Line 4:
Kiosk mode is a special mode in [[Resonite]] that hides the [[Userspace]] items such as the logo and world switcher and disables teleporting for guests by default.
Kiosk mode is a special mode in [[Resonite]] that hides the [[Userspace]] items such as the logo and world switcher and disables teleporting for guests by default.


To enter into this mode, you need to launch Resonite with the special parameter "-Kiosk" while using the [[Command Line Arguments|command line]] or steam's launch options.
To enter into this mode, you need to launch Resonite using the "-Kiosk" [[Command Line Arguments|command line argument]].


There is a special node that can check if a user is in Kiosk mode: [[ProtoFlux:Is User In Kiosk Mode|Is User In Kiosk Mode]]
There is a special node that can check if a user is in Kiosk mode: [[ProtoFlux:Is User In Kiosk Mode|Is User In Kiosk Mode]]
Line 10: Line 10:
== Usage ==
== Usage ==


(TODO: Add a reason why this is used and how it should be used.)
This can be used for demo and display content by pairing it with [[Command Line Arguments#Joining sessions / Opening worlds|auto join session / open world]] launch options. These combined can allow setting up a world or 'experience' to be opened up directly from launch without requiring user input and make returning to a fresh state simpler.


== Examples ==
== Examples ==

Latest revision as of 00:34, 19 June 2024

This article or section is a Stub. You can help the Resonite Wiki by expanding it.


Description

Kiosk mode is a special mode in Resonite that hides the Userspace items such as the logo and world switcher and disables teleporting for guests by default.

To enter into this mode, you need to launch Resonite using the "-Kiosk" command line argument.

There is a special node that can check if a user is in Kiosk mode: Is User In Kiosk Mode

Usage

This can be used for demo and display content by pairing it with auto join session / open world launch options. These combined can allow setting up a world or 'experience' to be opened up directly from launch without requiring user input and make returning to a fresh state simpler.

Examples