rivet.yaml (legacy) (SchemaStore) JSON Schema

Type	object
File match	`rivet.yaml` `rivet..yaml` `rivet.toml` `rivet..toml`
Schema URL	https://catalog.lintel.tools/schemas/schemastore/rivet-yaml-legacy/latest.json
Source	https://rivet.gg/rivet.schema.json

CloudVersionEngineConfig object

unity object

unreal object

1 nested properties

game_module string required

Name of the Unreal module that holds the game code. This is usually the value of $.Modules[0].Name in the file MyProject.unproject. Configures Rivet CLI behavior. Has no effect on server behavior.

godot object

html5 object

custom object

CloudVersionCdnConfig object

CDN configuration for a given version.

build_command string

Configures Rivet CLI behavior. Has no effect on server behavior.

build_output string

Configures Rivet CLI behavior. Has no effect on server behavior.

build_env Record<string, string>

Configures Rivet CLI behavior. Has no effect on server behavior.

site_id string

format=uuid

routes CloudVersionCdnRoute[]

Multiple CDN version routes.

CloudVersionMatchmakerConfig object

Matchmaker configuration for a given version.

game_modes Record<string, object>

A list of game modes.

captcha object

Matchmaker captcha configuration.

4 nested properties

requests_before_reverify integer required

Denotes how many requests a connection can make before it is required to reverify a captcha.

verification_ttl integer required

Denotes how long a connection can continue to reconnect without having to reverify a captcha (in milliseconds).

format=int64

hcaptcha object

hCpatcha configuration.

3 nested properties

level string

Deprecated How hard a captcha should be.

Values: "easy" "moderate" "difficult" "always_on"

site_key string

Site key for your hCaptcha application. Must be set.

secret_key string

Secret key for your hCaptcha application. Must be set.

turnstile object

Turnstile captcha configuration.

2 nested properties

site_key string required

secret_key string required

dev_hostname string

Configures Rivet CLI behavior. Has no effect on server behavior.

regions Record<string, object>

max_players integer

max_players_direct integer

max_players_party integer

docker object

A game mode runtime running through Docker.

8 nested properties

dockerfile string

Configures Rivet CLI behavior. Has no effect on server behavior.

build_args Record<string, string>

Configures Rivet CLI behavior. Has no effect on server behavior.

image string

Configures Rivet CLI behavior. Has no effect on server behavior.

image_id string

format=uuid

args string[]

env Record<string, string>

network_mode string

Configures how the container's network is isolated from the host. bridge (default) networking isolates the container's network from the host & other containers. host networking removes isolation between the container and the host. Only available in Rivet Open Source & Enterprise. Read more about bridge vs host networking here.

Values: "bridge" "host"

ports Record<string, object>

tier string

idle_lobbies object

Configuration for how many idle lobbies a game version should have.

2 nested properties

min integer required

max integer required

lobby_groups CloudVersionMatchmakerLobbyGroup[]

Deprecated: use game_modes instead A list of game modes.

CloudVersionKvConfig object

KV configuration for a given version.

CloudVersionIdentityConfig object

Deprecated Identity configuration for a given version.

display_names string[]

Deprecated

avatars string[]

Deprecated

custom_display_names CloudVersionIdentityCustomDisplayName[]

Deprecated

custom_avatars CloudVersionIdentityCustomAvatar[]

Deprecated

CloudVersionEngineUnityConfig object

CloudVersionEngineUnrealConfig object

game_module string required

Name of the Unreal module that holds the game code. This is usually the value of $.Modules[0].Name in the file MyProject.unproject. Configures Rivet CLI behavior. Has no effect on server behavior.

CloudVersionEngineGodotConfig object

CloudVersionEngineHtml5Config object

CloudVersionEngineCustomConfig object

CloudVersionCdnRoute object

glob string required

priority integer required

Unsigned 32 bit integer.

middlewares CloudVersionCdnMiddleware[] required

Multiple CDN version middleware.

CloudVersionMatchmakerGameMode object

A game mode.

regions Record<string, object>

max_players integer

max_players_direct integer

max_players_party integer

docker object

A game mode runtime running through Docker.

8 nested properties

dockerfile string

Configures Rivet CLI behavior. Has no effect on server behavior.

build_args Record<string, string>

Configures Rivet CLI behavior. Has no effect on server behavior.

image string

Configures Rivet CLI behavior. Has no effect on server behavior.

image_id string

format=uuid

args string[]

env Record<string, string>

network_mode string

Configures how the container's network is isolated from the host. bridge (default) networking isolates the container's network from the host & other containers. host networking removes isolation between the container and the host. Only available in Rivet Open Source & Enterprise. Read more about bridge vs host networking here.

Values: "bridge" "host"

ports Record<string, object>

listable boolean

taggable boolean

allow_dynamic_max_players boolean

actions object

Configuration for the connection types allowed for a game mode.

3 nested properties

find object

Configures the requirements and authentication for the /find endpoint. If this value is not set in the config, the /find endpoint is still enabled.

3 nested properties

enabled boolean required

Sets whether or not the /find endpoint is enabled.

identity_requirement string

Deprecated The registration requirement for a user when joining/finding/creating a lobby. "None" allows for connections without an identity.

Values: "none" "guest" "registered"

verification object

Configuration that tells Rivet where to send validation requests and with what headers. When set, Rivet will send the verification_data property (given by the user in the find/join/create endpoint) to the given url along with the headers provided and some information about the requested lobby. The response of this request will determine if the user can join that lobby or not.

join object

Configures the requirements and authentication for the /join endpoint. If this value is not set in the config, the /join endpoint is still enabled.

3 nested properties

enabled boolean required

Sets whether or not the /join endpoint is enabled.

identity_requirement string

Deprecated The registration requirement for a user when joining/finding/creating a lobby. "None" allows for connections without an identity.

Values: "none" "guest" "registered"

verification object

Configuration that tells Rivet where to send validation requests and with what headers. When set, Rivet will send the verification_data property (given by the user in the find/join/create endpoint) to the given url along with the headers provided and some information about the requested lobby. The response of this request will determine if the user can join that lobby or not.

create object

Configures the requirements and authentication for the /create endpoint. If this value is not set in the config, the /create endpoint is NOT enabled.

6 nested properties

enabled boolean required

Sets whether or not the /create endpoint is enabled.

identity_requirement string

Deprecated The registration requirement for a user when joining/finding/creating a lobby. "None" allows for connections without an identity.

Values: "none" "guest" "registered"

verification object

Configuration that tells Rivet where to send validation requests and with what headers. When set, Rivet will send the verification_data property (given by the user in the find/join/create endpoint) to the given url along with the headers provided and some information about the requested lobby. The response of this request will determine if the user can join that lobby or not.

enable_public boolean

Defaults to false when unset.

enable_private boolean

Defaults to true when unset.

max_lobbies_per_identity integer

Deprecated

tier string

idle_lobbies object

Configuration for how many idle lobbies a game version should have.

2 nested properties

min integer required

max integer required

CloudVersionMatchmakerCaptcha object

Matchmaker captcha configuration.

requests_before_reverify integer required

Denotes how many requests a connection can make before it is required to reverify a captcha.

verification_ttl integer required

Denotes how long a connection can continue to reconnect without having to reverify a captcha (in milliseconds).

format=int64

hcaptcha object

hCpatcha configuration.

3 nested properties

level string

Deprecated How hard a captcha should be.

Values: "easy" "moderate" "difficult" "always_on"

site_key string

Site key for your hCaptcha application. Must be set.

secret_key string

Secret key for your hCaptcha application. Must be set.

turnstile object

Turnstile captcha configuration.

2 nested properties

site_key string required

secret_key string required

CloudVersionMatchmakerGameModeRegion object

A game mode region.

tier string

idle_lobbies object

Configuration for how many idle lobbies a game version should have.

2 nested properties

min integer required

max integer required

CloudVersionMatchmakerGameModeRuntimeDocker object

A game mode runtime running through Docker.

dockerfile string

Configures Rivet CLI behavior. Has no effect on server behavior.

build_args Record<string, string>

Configures Rivet CLI behavior. Has no effect on server behavior.

image string

Configures Rivet CLI behavior. Has no effect on server behavior.

image_id string

format=uuid

args string[]

env Record<string, string>

network_mode string

Configures how the container's network is isolated from the host. bridge (default) networking isolates the container's network from the host & other containers. host networking removes isolation between the container and the host. Only available in Rivet Open Source & Enterprise. Read more about bridge vs host networking here.

Values: "bridge" "host"

ports Record<string, object>

CloudVersionMatchmakerGameModeIdleLobbiesConfig object

Configuration for how many idle lobbies a game version should have.

min integer required

max integer required

CloudVersionMatchmakerLobbyGroup object

A game mode.

name_id string required

Deprecated: use GameMode instead A human readable short identifier used to references resources. Different than a rivet.common#Uuid because this is intended to be human readable. Different than rivet.common#DisplayName because this should not include special characters and be short.

regions CloudVersionMatchmakerLobbyGroupRegion[] required

A list of game mode regions.

max_players_normal integer required

Unsigned 32 bit integer.

max_players_direct integer required

Unsigned 32 bit integer.

max_players_party integer required

Unsigned 32 bit integer.

runtime object required

Deprecated: use GameMode instead A union representing the runtime a game mode runs on.

1 nested properties

docker object

Deprecated: use GameMode instead A game mode runtime running through Docker.

5 nested properties

args string[] required

env_vars CloudVersionMatchmakerLobbyGroupRuntimeDockerEnvVar[] required

ports CloudVersionMatchmakerLobbyGroupRuntimeDockerPort[] required

build_id string

format=uuid

network_mode string

Configures how the container's network is isolated from the host. bridge (default) networking isolates the container's network from the host & other containers. host networking removes isolation between the container and the host. Only available in Rivet Open Source & Enterprise. Read more about bridge vs host networking here.

Values: "bridge" "host"

CloudVersionIdentityCustomDisplayName object

display_name string required

Represent a resource's readable display name.

CloudVersionIdentityCustomAvatar object

upload_id string required

format=uuid

CloudVersionCdnMiddleware object

kind object required

1 nested properties

custom_headers object

1 nested properties

headers CloudVersionCdnHeader[] required

CloudVersionMatchmakerGameModeActions object

Configuration for the connection types allowed for a game mode.

find object

Configures the requirements and authentication for the /find endpoint. If this value is not set in the config, the /find endpoint is still enabled.

3 nested properties

enabled boolean required

Sets whether or not the /find endpoint is enabled.

identity_requirement string

Deprecated The registration requirement for a user when joining/finding/creating a lobby. "None" allows for connections without an identity.

Values: "none" "guest" "registered"

verification object

Configuration that tells Rivet where to send validation requests and with what headers. When set, Rivet will send the verification_data property (given by the user in the find/join/create endpoint) to the given url along with the headers provided and some information about the requested lobby. The response of this request will determine if the user can join that lobby or not.

2 nested properties

url string required

headers Record<string, string> required

join object

Configures the requirements and authentication for the /join endpoint. If this value is not set in the config, the /join endpoint is still enabled.

3 nested properties

enabled boolean required

Sets whether or not the /join endpoint is enabled.

identity_requirement string

Deprecated The registration requirement for a user when joining/finding/creating a lobby. "None" allows for connections without an identity.

Values: "none" "guest" "registered"

verification object

Configuration that tells Rivet where to send validation requests and with what headers. When set, Rivet will send the verification_data property (given by the user in the find/join/create endpoint) to the given url along with the headers provided and some information about the requested lobby. The response of this request will determine if the user can join that lobby or not.

2 nested properties

url string required

headers Record<string, string> required

create object

Configures the requirements and authentication for the /create endpoint. If this value is not set in the config, the /create endpoint is NOT enabled.

6 nested properties

enabled boolean required

Sets whether or not the /create endpoint is enabled.

identity_requirement string

Deprecated The registration requirement for a user when joining/finding/creating a lobby. "None" allows for connections without an identity.

Values: "none" "guest" "registered"

verification object

Configuration that tells Rivet where to send validation requests and with what headers. When set, Rivet will send the verification_data property (given by the user in the find/join/create endpoint) to the given url along with the headers provided and some information about the requested lobby. The response of this request will determine if the user can join that lobby or not.

2 nested properties

url string required

headers Record<string, string> required

enable_public boolean

Defaults to false when unset.

enable_private boolean

Defaults to true when unset.

max_lobbies_per_identity integer

Deprecated

CloudVersionMatchmakerCaptchaHcaptcha object

hCpatcha configuration.

level string

Deprecated How hard a captcha should be.

Values: "easy" "moderate" "difficult" "always_on"

site_key string

Site key for your hCaptcha application. Must be set.

secret_key string

Secret key for your hCaptcha application. Must be set.

CloudVersionMatchmakerCaptchaTurnstile object

Turnstile captcha configuration.

site_key string required

secret_key string required

CloudVersionMatchmakerNetworkMode string

Configures how the container's network is isolated from the host. bridge (default) networking isolates the container's network from the host & other containers. host networking removes isolation between the container and the host. Only available in Rivet Open Source & Enterprise. Read more about bridge vs host networking here.

CloudVersionMatchmakerGameModeRuntimeDockerPort object

Port config for a docker build.

port integer

The port number to connect to.

Related - cloud.version.matchmaker.PortProtocol - cloud.version.matchmaker.ProxyKind

port_range object

Range of ports that can be connected to. If configured, network_mode must equal host. Port ranges may overlap between containers, it is the responsibility of the developer to ensure ports are available before using. Read more about host networking here. Only available on Rivet Open Source & Enterprise.

With HTTP, the port will always be 80. The hostname of the port correctly routes the incoming connection to the correct port being used by the game server.
With HTTPS, the port will always be 443. The hostname of the port correctly routes the incoming connection to the correct port being used by the game server.
Using TCP/UDP, the port will be a random number between 26000 and 31999. This gets automatically routed to the correct port being used by the game server.

Related - cloud.version.matchmaker.GameModeRuntimeDockerPort - cloud.version.matchmaker.ProxyKind - /docs/dynamic-servers/concepts/game-guard - matchmaker.lobbies.find

Values: "http" "https" "tcp" "tcp_tls" "udp"

proxy string

Range of ports that can be connected to. game_guard (default) proxies all traffic through Game Guard to mitigate DDoS attacks and provide TLS termination. none sends traffic directly to the game server. If configured, network_mode must equal host. Read more about host networking here. Only available on Rivet Open Source & Enterprise.

Related - /docs/dynamic-servers/concepts/game-guard - cloud.version.matchmaker.PortProtocol

Values: "none" "game_guard"

dev_port integer

Configures Rivet CLI behavior. Has no effect on server behavior.

dev_port_range object

Range of ports that can be connected to. If configured, network_mode must equal host. Port ranges may overlap between containers, it is the responsibility of the developer to ensure ports are available before using. Read more about host networking here. Only available on Rivet Open Source & Enterprise.

With HTTP, the port will always be 80. The hostname of the port correctly routes the incoming connection to the correct port being used by the game server.
With HTTPS, the port will always be 443. The hostname of the port correctly routes the incoming connection to the correct port being used by the game server.
Using TCP/UDP, the port will be a random number between 26000 and 31999. This gets automatically routed to the correct port being used by the game server.

Related - cloud.version.matchmaker.GameModeRuntimeDockerPort - cloud.version.matchmaker.ProxyKind - /docs/dynamic-servers/concepts/game-guard - matchmaker.lobbies.find

Values: "http" "https" "tcp" "tcp_tls" "udp"

CloudVersionMatchmakerLobbyGroupRegion object

Deprecated: use GameMode instead A game mode region.

region_id string required

format=uuid

tier_name_id string required

A human readable short identifier used to references resources. Different than a rivet.common#Uuid because this is intended to be human readable. Different than rivet.common#DisplayName because this should not include special characters and be short.

idle_lobbies object

Deprecated: use GameMode instead Configuration for how many idle lobbies a game version should have.

2 nested properties

min_idle_lobbies integer required

Unsigned 32 bit integer.

max_idle_lobbies integer required

Unsigned 32 bit integer.

CloudVersionMatchmakerLobbyGroupRuntime object

Deprecated: use GameMode instead A union representing the runtime a game mode runs on.

docker object

Deprecated: use GameMode instead A game mode runtime running through Docker.

5 nested properties

args string[] required

env_vars CloudVersionMatchmakerLobbyGroupRuntimeDockerEnvVar[] required

ports CloudVersionMatchmakerLobbyGroupRuntimeDockerPort[] required

build_id string

format=uuid

network_mode string

Configures how the container's network is isolated from the host. bridge (default) networking isolates the container's network from the host & other containers. host networking removes isolation between the container and the host. Only available in Rivet Open Source & Enterprise. Read more about bridge vs host networking here.

Values: "bridge" "host"

DisplayName string

Represent a resource's readable display name.

CloudVersionCdnMiddlewareKind object

custom_headers object

1 nested properties

headers CloudVersionCdnHeader[] required

CloudVersionMatchmakerGameModeFindConfig object

Configures the requirements and authentication for the /find endpoint. If this value is not set in the config, the /find endpoint is still enabled.

enabled boolean required

Sets whether or not the /find endpoint is enabled.

identity_requirement string

Deprecated The registration requirement for a user when joining/finding/creating a lobby. "None" allows for connections without an identity.

Values: "none" "guest" "registered"

verification object

Configuration that tells Rivet where to send validation requests and with what headers. When set, Rivet will send the verification_data property (given by the user in the find/join/create endpoint) to the given url along with the headers provided and some information about the requested lobby. The response of this request will determine if the user can join that lobby or not.

2 nested properties

url string required

headers Record<string, string> required

CloudVersionMatchmakerGameModeJoinConfig object

Configures the requirements and authentication for the /join endpoint. If this value is not set in the config, the /join endpoint is still enabled.

enabled boolean required

Sets whether or not the /join endpoint is enabled.

identity_requirement string

Deprecated The registration requirement for a user when joining/finding/creating a lobby. "None" allows for connections without an identity.

Values: "none" "guest" "registered"

verification object

Configuration that tells Rivet where to send validation requests and with what headers. When set, Rivet will send the verification_data property (given by the user in the find/join/create endpoint) to the given url along with the headers provided and some information about the requested lobby. The response of this request will determine if the user can join that lobby or not.

2 nested properties

url string required

headers Record<string, string> required

CloudVersionMatchmakerGameModeCreateConfig object

Configures the requirements and authentication for the /create endpoint. If this value is not set in the config, the /create endpoint is NOT enabled.

enabled boolean required

Sets whether or not the /create endpoint is enabled.

identity_requirement string

Deprecated The registration requirement for a user when joining/finding/creating a lobby. "None" allows for connections without an identity.

Values: "none" "guest" "registered"

verification object

Configuration that tells Rivet where to send validation requests and with what headers. When set, Rivet will send the verification_data property (given by the user in the find/join/create endpoint) to the given url along with the headers provided and some information about the requested lobby. The response of this request will determine if the user can join that lobby or not.

2 nested properties

url string required

headers Record<string, string> required

enable_public boolean

Defaults to false when unset.

enable_private boolean

Defaults to true when unset.

max_lobbies_per_identity integer

Deprecated

CloudVersionMatchmakerCaptchaHcaptchaLevel string

Deprecated How hard a captcha should be.

CloudVersionMatchmakerPortRange object

Range of ports that can be connected to. If configured, network_mode must equal host. Port ranges may overlap between containers, it is the responsibility of the developer to ensure ports are available before using. Read more about host networking here. Only available on Rivet Open Source & Enterprise.

With HTTP, the port will always be 80. The hostname of the port correctly routes the incoming connection to the correct port being used by the game server.
With HTTPS, the port will always be 443. The hostname of the port correctly routes the incoming connection to the correct port being used by the game server.
Using TCP/UDP, the port will be a random number between 26000 and 31999. This gets automatically routed to the correct port being used by the game server.

Related - cloud.version.matchmaker.GameModeRuntimeDockerPort - cloud.version.matchmaker.ProxyKind - /docs/dynamic-servers/concepts/game-guard - matchmaker.lobbies.find

CloudVersionMatchmakerProxyKind string

Range of ports that can be connected to. game_guard (default) proxies all traffic through Game Guard to mitigate DDoS attacks and provide TLS termination. none sends traffic directly to the game server. If configured, network_mode must equal host. Read more about host networking here. Only available on Rivet Open Source & Enterprise.

Related - /docs/dynamic-servers/concepts/game-guard - cloud.version.matchmaker.PortProtocol

CloudVersionMatchmakerLobbyGroupIdleLobbiesConfig object

Deprecated: use GameMode instead Configuration for how many idle lobbies a game version should have.

min_idle_lobbies integer required

Unsigned 32 bit integer.

max_idle_lobbies integer required

Unsigned 32 bit integer.

CloudVersionMatchmakerLobbyGroupRuntimeDocker object

Deprecated: use GameMode instead A game mode runtime running through Docker.

args string[] required

env_vars CloudVersionMatchmakerLobbyGroupRuntimeDockerEnvVar[] required

ports CloudVersionMatchmakerLobbyGroupRuntimeDockerPort[] required

build_id string

format=uuid

network_mode string

Configures how the container's network is isolated from the host. bridge (default) networking isolates the container's network from the host & other containers. host networking removes isolation between the container and the host. Only available in Rivet Open Source & Enterprise. Read more about bridge vs host networking here.

Values: "bridge" "host"

CloudVersionCdnCustomHeadersMiddleware object

headers CloudVersionCdnHeader[] required

CloudVersionMatchmakerGameModeIdentityRequirement string

Deprecated The registration requirement for a user when joining/finding/creating a lobby. "None" allows for connections without an identity.

CloudVersionMatchmakerGameModeVerificationConfig object

Configuration that tells Rivet where to send validation requests and with what headers. When set, Rivet will send the verification_data property (given by the user in the find/join/create endpoint) to the given url along with the headers provided and some information about the requested lobby. The response of this request will determine if the user can join that lobby or not.

url string required

headers Record<string, string> required

CloudVersionMatchmakerLobbyGroupRuntimeDockerEnvVar object

Deprecated: use GameMode instead A docker environment variable.

key string required

value string required

CloudVersionMatchmakerLobbyGroupRuntimeDockerPort object

Deprecated: use GameMode instead A docker port.

label string required

The label of this docker port.

proxy_protocol string required

Signifies the protocol of the port. Note that when proxying through GameGuard (via ProxyKind), the port number returned by /find, /join, and /create will not be the same as the port number configured in the config:

With HTTP, the port will always be 80. The hostname of the port correctly routes the incoming connection to the correct port being used by the game server.
With HTTPS, the port will always be 443. The hostname of the port correctly routes the incoming connection to the correct port being used by the game server.
Using TCP/UDP, the port will be a random number between 26000 and 31999. This gets automatically routed to the correct port being used by the game server.

Related - cloud.version.matchmaker.GameModeRuntimeDockerPort - cloud.version.matchmaker.ProxyKind - /docs/dynamic-servers/concepts/game-guard - matchmaker.lobbies.find

Values: "http" "https" "tcp" "tcp_tls" "udp"

target_port integer

The port number to connect to.

port_range object

Range of ports that can be connected to. If configured, network_mode must equal host. Port ranges may overlap between containers, it is the responsibility of the developer to ensure ports are available before using. Read more about host networking here. Only available on Rivet Open Source & Enterprise.

rivet.yaml (legacy)

Validate with Lintel

Properties

Definitions

Related - cloud.version.matchmaker.PortProtocol - cloud.version.matchmaker.ProxyKind

Related

Related - cloud.version.matchmaker.GameModeRuntimeDockerPort - cloud.version.matchmaker.ProxyKind - /docs/dynamic-servers/concepts/game-guard - matchmaker.lobbies.find

Related - /docs/dynamic-servers/concepts/game-guard - cloud.version.matchmaker.PortProtocol

Related

Related - cloud.version.matchmaker.GameModeRuntimeDockerPort - cloud.version.matchmaker.ProxyKind - /docs/dynamic-servers/concepts/game-guard - matchmaker.lobbies.find

Related

Related - cloud.version.matchmaker.GameModeRuntimeDockerPort - cloud.version.matchmaker.ProxyKind - /docs/dynamic-servers/concepts/game-guard - matchmaker.lobbies.find

Related - /docs/dynamic-servers/concepts/game-guard - cloud.version.matchmaker.PortProtocol

Related - cloud.version.matchmaker.GameModeRuntimeDockerPort - cloud.version.matchmaker.ProxyKind - /docs/dynamic-servers/concepts/game-guard - matchmaker.lobbies.find

Related