Each player who connects to a Foundry Virtual Tabletop session is a User. Each user is assigned a role which determines what the user has permission to do within the confines of the game world. Permissions can be configured in order to more finely control the features available to users in any hosted World. Foundry VTT has two tiers of permission settings which can be configured to allow as much or as little restriction as needed for your game and your users.
- Role Permissions
- Chosen when setting up player accounts to assign use a configured set of default permissions for that account type in the Game World.
- Document Permissions
- Assigned to each actor, item, journal entry or other document to allow users to access documents. Document permissions control how a specific user may interact with that document.
Users are created within an active Game World, and the set of users is specific to that world. There are no global, cross-world, user accounts within Foundry VTT, each World maintains it's own player list and user-level permission controls.
To manage a world's users, click the Game Settings icon ( ) on the right sidebar, and then click on User Management. This will take you to the user management screen. From here you can add new users, remove existing users, change passwords, and change roles.
- User Name
- Displays the current user's name which is shown in the dropdown list on the game login page and in the players panel.
- Sets the user's password. Newly created users do not start with a password and must be given one.
- User Role
- This dropdown allows you to select what role you want the user to have. All newly created users start with the Player role. Roles are detailed further down in this article.
- Delete User ( )
- This button deletes the associated user. You will be prompted to confirm deletion when this function is used.
- Create Additional User ( )
- This creates a generic user in a new slot named "Player" plus a number (i.e. "Player 1") with the default role of Player, which has limited permissions and ability to access tools. New users do not start with a password, though one can be added if desired.
- Configure Permissions ( )
- Opens the User Permission Management screen which determines what each user role can do. This panel is detailed further down in this article.
- Save and Return ( )
- Saves the User Configuration panel as it currently is, and reloads the world to apply the changes.
Each User has a specific role which configures their basic permission set of actions they can perform within a Foundry VTT game. The role for each User is configured using the User Management page described above. Each of the role levels and their meanings are described below:
The User is blocked from taking actions in Foundry Virtual Tabletop. You can use this role to temporarily or permanently ban a user from joining the game.
The User is able to join the game with permissions available to a standard player. They cannot take some more advanced actions which require Trusted permissions, but they have the basic functionalities needed to operate in the virtual tabletop.
Similar to the Player role, except a Trusted User has the ability to perform some more advanced actions like create drawings, measured templates, or even to (optionally) upload media files to the server.
- Game Master
A special User who has administrative control over this specific World. Game Masters behave quite differently than Players in that they have the ability to see all Documents and Objects within the world as well as the capability to configure World settings.
A special User who has many of the same in-game controls as a Game Master User, but does not have the ability to perform administrative actions like changing User roles or modifying World-level settings.
Actors, Items, Journals, Roll Tables, and Cards can have theses settings changed by right clicking them in the main sidebar directory and choosing ( ) Configure Ownership. This opens the configuration panel which allows you to set what each world user can do with the document being configured. By default all of the listed document types begin with no ownership settings, and are only visible and editable by gamemaster accounts. The following ownership levels are available:
- Restricts the associated document so that it may not be seen by this user.
- Allows the user to interact with the document in basic ways, allowing them to see it in sidebars and see only limited aspects of its contents. The limits of this interaction are defined by the game system being used.
- Allows the user to view this document as if they were owner, but prevents them from making any changes to it.
- Allows the user to view and make changes to the document as its owner. Owned documents cannot be deleted by anyone other than a gamemaster level user.
Right clicking on a username in the players list located in the bottom-left of the UI allows you to open the User Configuration panel. If you are a user with the player or trusted player role you can only open your own user configuration, but gamemasters and assistant gamemasters can configure any user they want. This user configuration window allows that user to have an actor assigned to them, and determines a few other cosmetic settings.
- Player Avatar
- Allows the user to select an optional image that is used in various places around the Foundry VTT user interface.
- Player Color
- Allows the user to select what color the dot next to their name is. This also affects the color of their cursor, their drawings, and various other small aspects of the user interface. A color is randomly assigned to each newly created user.
- Select Character
- Allows the user to select one of the actors they have permission to control. This associates that actor with them as their default actor. Users can have multiple actors they have control or oversight with, but only one may be their default actor.
To interact with Users programmatically, you will primarily use the following API concepts:
- The User Document
- The Users Collection
- The UserManagement Setup Application