Provider

TypeScript

type OverlayProvider = {
  productId: string
  name: string
  protocolVersion: number
  basePath: string
  overlays: Overlay<string>[]
}

C#

struct OverlayProvider
{
    public string ProductId;
    public int ProtocolVersion;
    public string Name;
    public string BasePath;
    public Overlay[] Overlays;
}

The OverlayProvider object contains the following properties:

Product ID

The product ID of the overlay provider. Should be in the format of reverse domain name, e.g. com.example.overlay.

Protocol version

The version should be larger than or equal to the version supported by the overlay explorer.

Name

The name of the overlay provider, aka the name of the overlay website.

Base path

This is the base path of all the overlays.

caution

The overlay explorer always assume that all overlays has a URL starting with the same base path.

Templates

Port

The explorer will replace any {port} in the base path with the port number of the server.

Password

The explorer will replace any {password} in the base path with the password of the server.

Overlays

A list of available overlays.