World Orb: Difference between revisions

From Resonite Wiki
Fixed typo. small corrections. Added meta data information. Added another image link (preparing it).
Clarified wording on cloned world orb not being saved to inventory despite the world itself being added in your 'worlds'
 
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
[[File:WorldOrb.png|alt=A world orb|thumb|A world orb]]
[[File:WorldOrb.png|alt=A world orb|thumb|A world orb]]


A '''World Orb''' is a item that represents a world as a reference (not the world itself). It shows the name on top, a preview of the world inside the orb, and who created the world on the bottom (whether as a [[User]] or [[Group]]).
A '''World Orb''' is a item that represents a [[World|world]] as a reference (not the world itself). It shows the name on top, a preview of the world inside the orb, and who created the world on the bottom (whether as a [[User]] or [[Group]]). These are normally created after [[Create New World|creating a new world]] and getting the world orb afterwards. These world orbs are synonymous to session orbs, as both represent a world, but with restrictions to who can access and join one.


This can be saved as an item and can have its own resrec link due to that.
This can be saved as an item and can have its own resrec link due to that.
Line 17: Line 17:
| Orange || The world is open and you are not focused in it.
| Orange || The world is open and you are not focused in it.
|-
|-
| Purple || ...
| Purple || An open world hosted by a user.
|-
|-
| Pink || ...
| Pink || A session orb hosting an instance of a world.
|-
|-
|}
|}
Line 29: Line 29:
=== Opening And Joining Sessions ===
=== Opening And Joining Sessions ===
[[File:WorldOrbContextMenu.png|alt=World Orb Context Menu|thumb|World Orb Context Menu]]
[[File:WorldOrbContextMenu.png|alt=World Orb Context Menu|thumb|World Orb Context Menu]]
[[File:StartCustomSessionMenu.png|alt=Start custom Session dialog|thumb|Start custom Session dialog]]
[[File:StartCustomSessionMenu.png|alt=Start custom Session Menu|thumb|Start custom Session Menu]]


A world orb allows users to join sessions or to create and host one.
A world orb allows users to join sessions or to create and host one.
Line 38: Line 38:


=== Cloning Worlds ===
=== Cloning Worlds ===
To clone a world orb, click on it with your laser and a context menu will pop up. Select the option "Clone World". This will split the world orb into two, the original world orb, and another world orb of the same name but with "(Copy)" at the end of it.
What this will do:
* This '''will''' take up space in your storage.
* This '''will''' take another spot in the "My Worlds" tab in the [[Dash]].
What this will not do:
* This does '''NOT''' duplicate the instance(s) itself (it is a copy of the world with everything in it, matching the original).
* This will '''NOT''' make a copy of the world orb in your [[Inventory]]. You may want to save the new orb to your inventory.


=== World Deletion ===
=== World Deletion ===
Line 46: Line 55:
=== Overwriting Worlds ===
=== Overwriting Worlds ===
[[File:OverwriteWorldContextMenu.png|alt=Overwrite World Context Menu|thumb|Overwrite World Context Menu]]
[[File:OverwriteWorldContextMenu.png|alt=Overwrite World Context Menu|thumb|Overwrite World Context Menu]]
To overwrite a world, prepare 2 world orbs, one to overwrite, and another to overwrite with. Then use your laser and grab the world orb and drag it to the other one, then open your context menu. You should see the option "Overwrite with (World Name)".
To overwrite a world, prepare 2 world orbs, one to overwrite, and another to overwrite with. Then use your laser and grab the world orb and drag it to the other one, then click with your laser to open your context menu. You should see the option "Overwrite with (World Name)". You must let go of your grip of the world orb and select the overwrite button, then it will ask you if you really want to overwrite the world. Once you confirm, the world orb will show "Overwriting..." on the top, then a few moments later the world orb is ready to be interacted with once more.


Overwriting a world preserves the world record.
Overwriting a world preserves the world record.
Line 54: Line 63:


When you need to edit some metadata information, such as the world name, description, tags, and who can open the world, you can click on the world orb and select "Edit Metadata". A menu should pop up giving you the option to edit and update that information. After saving the change, give it a few minutes to update on the server side of [[Resonite]] for the changes to take effect.
When you need to edit some metadata information, such as the world name, description, tags, and who can open the world, you can click on the world orb and select "Edit Metadata". A menu should pop up giving you the option to edit and update that information. After saving the change, give it a few minutes to update on the server side of [[Resonite]] for the changes to take effect.
=== Publishing a world ===
Publishing a world requires the world publisher from the Resonite Essentials folder. Placing a world orb inside the publisher and pressing the submit button will send the world (and other important information) to the [[Resonite]] servers.
More information can be found in the [[Submitting Worlds]] page.
{{Note|There is currently no way to "Unpublish" a world. But the alternatives to doing something similar is either going to the [[World#Editing World Metadata|world metadata]] and setting the "Who can open this world?" to "Only Me" (effectively hiding it), or just deleting the world.|warning}}

Latest revision as of 06:42, 22 August 2024

A world orb
A world orb

A World Orb is a item that represents a world as a reference (not the world itself). It shows the name on top, a preview of the world inside the orb, and who created the world on the bottom (whether as a User or Group). These are normally created after creating a new world and getting the world orb afterwards. These world orbs are synonymous to session orbs, as both represent a world, but with restrictions to who can access and join one.

This can be saved as an item and can have its own resrec link due to that.

The world orb has different rim colors to represent what the world is and what it is doing:

Color What it means
Clear or Nothing The world is not new and was opened before (and not focused in the world)
Yellow A newly created world.
Orange The world is open and you are not focused in it.
Purple An open world hosted by a user.
Pink A session orb hosting an instance of a world.

Features

The world orb allows the user to interact with it, enacting different options based on the actions or selection in the context menu from it.

Opening And Joining Sessions

World Orb Context Menu
World Orb Context Menu
Start custom Session Menu
Start custom Session Menu

A world orb allows users to join sessions or to create and host one.

Click or use primary while aiming your laser on the world orb, this will open a context menu with options. Select "Start Session" or "Start Custom Session". Starting a session will open the world in the last known access level. Starting a custom session will give you different options and settings before opening the world.

You can also double click with your laser (or physically touch it twice quickly) at the world orb and it will start a session.

Cloning Worlds

To clone a world orb, click on it with your laser and a context menu will pop up. Select the option "Clone World". This will split the world orb into two, the original world orb, and another world orb of the same name but with "(Copy)" at the end of it.

What this will do:

  • This will take up space in your storage.
  • This will take another spot in the "My Worlds" tab in the Dash.

What this will not do:

  • This does NOT duplicate the instance(s) itself (it is a copy of the world with everything in it, matching the original).
  • This will NOT make a copy of the world orb in your Inventory. You may want to save the new orb to your inventory.

World Deletion

World Delete Context Menu
World Delete Context Menu

To delete a world, you must click or aim your laser on it and press primary, then select the "Delete World" option. This will open the context menu again asking if you really want to delete the world, and selecting delete from here will open one last menu (one that is more private and in your local user space) asking you if you really want to permanently delete this world. Pressing delete one last time will remove the world from your inventory and storage (and the world orb from the world your in).

Overwriting Worlds

Overwrite World Context Menu
Overwrite World Context Menu

To overwrite a world, prepare 2 world orbs, one to overwrite, and another to overwrite with. Then use your laser and grab the world orb and drag it to the other one, then click with your laser to open your context menu. You should see the option "Overwrite with (World Name)". You must let go of your grip of the world orb and select the overwrite button, then it will ask you if you really want to overwrite the world. Once you confirm, the world orb will show "Overwriting..." on the top, then a few moments later the world orb is ready to be interacted with once more.

Overwriting a world preserves the world record.

Editing World Metadata

World Metadata Menu
World Metadata Menu

When you need to edit some metadata information, such as the world name, description, tags, and who can open the world, you can click on the world orb and select "Edit Metadata". A menu should pop up giving you the option to edit and update that information. After saving the change, give it a few minutes to update on the server side of Resonite for the changes to take effect.

Publishing a world

Publishing a world requires the world publisher from the Resonite Essentials folder. Placing a world orb inside the publisher and pressing the submit button will send the world (and other important information) to the Resonite servers.

More information can be found in the Submitting Worlds page.

There is currently no way to "Unpublish" a world. But the alternatives to doing something similar is either going to the world metadata and setting the "Who can open this world?" to "Only Me" (effectively hiding it), or just deleting the world.