For the complete documentation index, see llms.txt. This page is also available as Markdown.

Trusted Clients

Trusted Clients are machines that be launched alongside your world, that can offload work from your server, to help enable larger scales. (They are clients, but are managed internally, and so "trusted" to do the work of the server, as opposed to player clients)

There are two types of trusted client:

  • Worker Clients - used to run offloaded compute. Can be used for expensive gameplay systems, e.g. managing NPCs.

  • Sentinel Clients - used to run offloaded validation. Instead of the server needing to check everything the players do, the sentinels can take that responsibility

NOTE: Worker clients are similar, but distinct from Bots. If you want fake players that are representative of human players in terms of networking load, you should use bots.

How to set up trusted clients

How to use trusted clients in-editor

If you want to use Trusted Clients in-editor, you will need to do the following:

  • First, you will need to configure a Trusted Client Api Key.

    • This is set in your Editor Preferences -> Sign In Settings

    • The value for your trusted client API key is in your dashboard (admin -> API Keys), if your project has one. If not, you will be unable to use trusted clients.

  • Then, when playing in editor, you can set one of the clients to run as a Worker or Sentinel Client through Editor Preferenecs -> Morpheus -> Editor Client Connection Types

    • Each entry in the list dictates which connection type will be used for the client of that index. Each will default to Player (meaning a human controlled character), but you can set one to be Worker, to use a Worker Client in-editor, or Sentinel to use sentinels.

  • Then, when playing in editor, increase the Number of Players, to include the connections you added above.

How to add trusted clients to your world

Much like Bots, you can configure the number of trusted clients your world starts with via the launch config in the dashboard.

You can also add trusted clients directly to a launched world by navigating to the "Operations" tab on your project Dashboard.

NOTE: Currently the only type of supported trusted clients are Worker Clients.

Worker Clients

Worker clients are generic trusted clients that can be used to run offloaded gameplay logic. In Unreal, their "connection" type will extend M_WorkerConnection.

You can tell if your local connection is a worker connection by using GetLocalClientConnection from a Morpheus Actor, and casting to M_WorkerConnection.

If you want to spawn Morpheus Actors that the worker client has authority over, you will need to send call SpawnMorpheusActorWithSplitAuthority from the server, with the worker's ClientConnection.

Sentinel Clients

Sentinel clients are not publicly available yet.

Last updated