Each server for a given space has a maximum user capacity, which can be customized. When a single server hits that limit, a new one is spawned where additional users can connect to. This sharding of the space can also be turned off, which limits the number of concurrent participants to a fixed value.

Additionally, through scripting, creators can teleport users between servers, and this system can be used for matchmaking. The system is flexible, and can be used to create many different features, such as:

Grouping users into servers that match game types
Grouping admins into a single server by default.
Making a lobby waiting area where users can select their destination
Allow users to have private voice conversations by teleporting them to private servers.

Users are able to switch between servers through our core UI, but creators can customize and enhance the functionality using scripting.

<aside> <img src="/icons/clipping_gray.svg" alt="/icons/clipping_gray.svg" width="40px" /> There is a maximum of 50 players per server, and there are no limits to how many servers your space can have. The default server size (if you don’t change anything in your project settings) is 16 players.

Spaces published before Toolkit version 0.80 (Oct 4, 2023) will be set to 50 players per instance, which is unchanged from before the update. This can be changed by the space creator when publishing a new update to the space.

</aside>

Untitled

Server Properties

All these properties can be configured either through the Space package settings, or through Visual Scripting.

	Data Type	Description
Is Host	boolean	Host instances are considered the “main” or “leader” instance. Today, the only difference is that when you add content to the space from within the Spatial app, only the host instance will save those changes.
In the future, we may use the host server as the source for cross-server replication.
Is Open	boolean	Users can only join servers that are open
Is Visible	boolean	Servers that are set to invisible don’t show up in the “Switch Server” menu, and users will not be elected to randomly join them. You can use invisible servers as private servers, or for in-progress PVP games that should not allow additional participants.
Capacity	integer	The maximum capacity of users that can join a server. The platform maximum is set to `50` but this can be configured to any value between 2 and 50.
Properties	Pair<string, integer	boolean

Space Settings

Space packages allow you to customize server instancing at a basic level.

When a user joins a space for the first time, they will enter a Server that has these initial settings. Additionally, the system will always try to fill servers before sending users to more empty servers.

Untitled

<aside> <img src="/icons/flag_gray.svg" alt="/icons/flag_gray.svg" width="40px" /> Disabling Server Instancing This feature can be completely turned off. When it is off, the space always only has 1 server, and will only allow concurrent user capacity to the specified setting. Users who attempt to join while the server is at capacity will get a message explaining that the space is at capacity. Also note that when this feature is turned off, matchmaking features are not available.

</aside>

Visual Scripting Nodes

Action Nodes

| --- | --- |

Trigger Nodes