Skip to content
tickcli

RemoteServerOptions

Properties

Section titled “Properties”

address?

Section titled “address?”

optional address?: (req) => string

Parameters

Section titled “Parameters”
req
Section titled “req”

IncomingMessage

Returns

Section titled “Returns”

string

deployment

Section titled “deployment”

deployment: (id) => Deployment | Promise<Deployment | null | undefined> | null | undefined

Parameters

Section titled “Parameters”
id
Section titled “id”

string

Returns

Section titled “Returns”

Deployment | Promise<Deployment | null | undefined> | null | undefined

limits?

Section titled “limits?”

optional limits?: Partial<Limits>

saves?

Section titled “saves?”

optional saves?: string | SavePort

a folder for saved profiles and worlds, or your own SavePort

secret?

Section titled “secret?”

optional secret?: string

signs public player ids; keep it stable so ids stay the same across restarts (default: random per process)

trustProxy?

Section titled “trustProxy?”

optional trustProxy?: boolean

behind a proxy on a private network: players’ addresses from X-Forwarded-For (see clientAddress in tickcli/node)