Universes: Difference between revisions

From Resonite Wiki
add universes page
 
No edit summary
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
: '''''Help needed: this page needs more information and corrections!'''''
<languages/>
{{Note|<translate><!--T:1--> Universes are primarily a Business/Commercial feature. Regular users usually won't be able to use it.</translate>|information}}


'''Universes''' is a way to separate session into their own namespace. <!-- This is from some information I saw on Discord; I've never seen it properly documented anywhere - j4 -->
<translate><!--T:2--> Universes, provide a way to separate your Resonite sessions from the regular population of Resonite.</translate>  


The only reference to that system is present in the [[Headless_Client/Configuration_File | headless client configuration file]].
<translate><!--T:3--> When using a universe:</translate>
* <translate><!--T:4--> Users not in your universe will not be able to see your Sessions</translate>
* <translate><!--T:5--> Users in your universe will not be able to see Sessions from other universes or the regular Resonite session list.</translate>
 
== <translate><!--T:6--> Use Cases</translate> ==
<translate><!--T:7--> Resonite Universes are suitable for the following use cases:</translate>
* <translate><!--T:8--> Education</translate>
* <translate><!--T:9--> Business & Government uses</translate>
* <translate><!--T:10--> Research</translate>
 
== <translate><!--T:11--> Creating a Universe</translate> ==
<translate><!--T:12--> If you're interested in Universes, please use our [https://yellowdogman.com/contact.html Contact Form].</translate>
 
== <translate><!--T:13--> Properties</translate> ==
<translate><!--T:14--> Universes have two important properties:</translate>
* <translate><!--T:15--> Name - The Name of the universe</translate>
* <translate><!--T:16--> ID - The ID of the universe</translate>
* <translate> Primary Group - A Universe can have a primary Resonite [[Groups|Group]].</translate>
 
== <translate><!--T:17--> Known Universes</translate> ==
<translate><!--T:18--> The majority of Universes are private for Resonite's Business customers. Therefore they are not listed here. If any public ones are created we'll list them here.</translate>
 
== <translate><!--T:19--> Switching to a Universe</translate> ==
<translate><!--T:20--> To run Resonite from a specific Universe, you'll need to utilize a [[Startup_Config_File|Startup Config File]]. Inside the configuration file, the <code>universeId</code> property must be set to the ID of the universe you would like to be in.</translate>
 
=== <translate><!--T:21--> Example</translate> ===
<translate><!--T:22--> Below is a sample configuration file that will enter a user into the Universe with the ID "123-456":</translate>
<pre>
{
  "universeId": "123-456"
}
</pre>
 
== <translate><!--T:23--> Recommendations</translate> ==
<translate><!--T:24--> When using universes, it is recommended to use [[Command Line Arguments#Misc]] to allow you to selectively choose if a Resonite session is in a particular universe. Of particular note the "-EngineConfig" allows you to specify a path to a config file.</translate>
 
<translate><!--T:25--> Using this argument, you can create several configuration files for specific  use cases, for example:</translate>
* UniversityConfig.json - <translate><!--T:26--> Starts you in a Universe for a University.</translate>
* GovernmentConfig.json - <translate><!--T:27--> starts you in a Universe for a Government.</translate>
 
<translate><!--T:28--> You can then use [[Command_Line_Arguments#Use_a_shortcut|shortcuts]] that can be placed on your desktop that run Resonite using those configuration files.</translate>
 
<translate><!--T:29--> Once this is setup, you'll be able to launch into various universes and the regular Resonite population through selecting which shortcut to run Resonite with.</translate>
 
[[Category:Features]]

Latest revision as of 07:20, 27 July 2024

Universes are primarily a Business/Commercial feature. Regular users usually won't be able to use it.

Universes, provide a way to separate your Resonite sessions from the regular population of Resonite.

When using a universe:

  • Users not in your universe will not be able to see your Sessions
  • Users in your universe will not be able to see Sessions from other universes or the regular Resonite session list.

Use Cases

Resonite Universes are suitable for the following use cases:

  • Education
  • Business & Government uses
  • Research

Creating a Universe

If you're interested in Universes, please use our Contact Form.

Properties

Universes have two important properties:

  • Name - The Name of the universe
  • ID - The ID of the universe
  • Primary Group - A Universe can have a primary Resonite Group.

Known Universes

The majority of Universes are private for Resonite's Business customers. Therefore they are not listed here. If any public ones are created we'll list them here.

Switching to a Universe

To run Resonite from a specific Universe, you'll need to utilize a Startup Config File. Inside the configuration file, the universeId property must be set to the ID of the universe you would like to be in.

Example

Below is a sample configuration file that will enter a user into the Universe with the ID "123-456":

{
  "universeId": "123-456"
}

Recommendations

When using universes, it is recommended to use Command Line Arguments#Misc to allow you to selectively choose if a Resonite session is in a particular universe. Of particular note the "-EngineConfig" allows you to specify a path to a config file.

Using this argument, you can create several configuration files for specific use cases, for example:

  • UniversityConfig.json - Starts you in a Universe for a University.
  • GovernmentConfig.json - starts you in a Universe for a Government.

You can then use shortcuts that can be placed on your desktop that run Resonite using those configuration files.

Once this is setup, you'll be able to launch into various universes and the regular Resonite population through selecting which shortcut to run Resonite with.