Permission system: Difference between revisions

From Resonite Wiki
Reword most things to make it read better
various tweaks, technical notes
 
Line 5: Line 5:


== Roles == <!--T:2-->
== Roles == <!--T:2-->
There are a handful of default roles in a world. Each permission includes the capabilities of the last.
There are a handful of default roles in a world. Each role includes the capabilities of the last.
* '''Admin''': Full administrative capabilities of the world and its users.
* '''Admin''': Full administrative capabilities of the world and its users.
* '''Builder''': Full editing permissions of the world.
* '''Builder''': Full editing permissions of the world.
Line 14: Line 14:
== Tools and Moderation ==
== Tools and Moderation ==
Underneath the "Users" tab in the [[Dash menu#Session Menu|Session Menu]] is a list of actions you may perform depending on your role in the session. You may do things such as:
Underneath the "Users" tab in the [[Dash menu#Session Menu|Session Menu]] is a list of actions you may perform depending on your role in the session. You may do things such as:
* '''Jump''': Teleports you to the user's current position.
* '''Respawn''': Completely resets a user and their avatar, as if they had just joined.
* '''Silence''': Mutes the user for everyone in the session.
* '''Kick''': Disconnect the user from the session, temporarily removing them.
* '''Kick''': Disconnect the user from the session, temporarily removing them.
* '''Ban''': Kicks the user and disallows them from joining again.
* '''Ban''': Kicks the user and disallows them from joining again.
* '''Silence''': Mutes the user for everyone in the session.
* '''Respawn''': Completely resets a user and their avatar, as if they had just joined.


Depending on your own permissions, you may also change other users' permissions. This is done through the "Permissions" tab in the same menu.
Depending on your own permissions, you may also change other users' roles, as well as the default role for new players (depending on whether they're anonymous, registered, the host's contacts, or the host themself). This is done through the "Permissions" tab in the same menu.
 
== Technical ==
Every new world comes with a default set of permissions under a slot named Roles, roughly organized by the respective role. Each of its child slots has a number of components from the [[:Category:Components:Permissions|Permissions]] category.
 
As of September 2025, there's no official way to check a player's permissions within [[ProtoFlux]].<ref>https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/297</ref> It's still possible to test for some of them based on their side effects; for example, [[Edit Mode]] permissions (by default given to the Builder role and above) can be tested for with the [[Protoflux:CanBeGrabbed|CanBeGrabbed]] node targeting a slot with the Developer [[tag]].<ref>https://discord.com/channels/1040316820650991766/1243347566892941435/1415719210570748040</ref>
 
== References ==
<references />

Latest revision as of 18:50, 12 September 2025

This article or section is a stub. You can help the Resonite wiki by expanding it.

Permissions are the forefront of what a user can use to protect themselves in a Session. They allow for Worlds to be set in whichever way you as a creator deem it so. For example, you could create a social world with no building, or even an "experience" world that will only allow you to interact with specific set pieces.

Roles

There are a handful of default roles in a world. Each role includes the capabilities of the last.

  • Admin: Full administrative capabilities of the world and its users.
  • Builder: Full editing permissions of the world.
  • Moderator: Ability to kick, silence, respawn, and change the role of users.
  • Guest: Ability to interact with the world and spawn items.
  • Spectator: The base-level permissions, allowing you to use an avatar, move around and chat with people.

Tools and Moderation

Underneath the "Users" tab in the Session Menu is a list of actions you may perform depending on your role in the session. You may do things such as:

  • Jump: Teleports you to the user's current position.
  • Respawn: Completely resets a user and their avatar, as if they had just joined.
  • Silence: Mutes the user for everyone in the session.
  • Kick: Disconnect the user from the session, temporarily removing them.
  • Ban: Kicks the user and disallows them from joining again.

Depending on your own permissions, you may also change other users' roles, as well as the default role for new players (depending on whether they're anonymous, registered, the host's contacts, or the host themself). This is done through the "Permissions" tab in the same menu.

Technical

Every new world comes with a default set of permissions under a slot named Roles, roughly organized by the respective role. Each of its child slots has a number of components from the Permissions category.

As of September 2025, there's no official way to check a player's permissions within ProtoFlux.[1] It's still possible to test for some of them based on their side effects; for example, Edit Mode permissions (by default given to the Builder role and above) can be tested for with the CanBeGrabbed node targeting a slot with the Developer tag.[2]

References