Type Alias ClientOptions

ClientOptions: ({
    token: string;
} | {
    password: string;
    username: string;
}) & {
    game?: Partial<Classes.GameOptions>;
    ribbon?: Partial<RibbonOptions>;
    social?: Partial<Types.Social.Config>;
    turnstile?: string;
    userAgent?: string;
}

Type declaration

  • Optionalgame?: Partial<Classes.GameOptions>
  • Optionalribbon?: Partial<RibbonOptions>

    The Ribbon (websocket handler) config

  • Optionalsocial?: Partial<Types.Social.Config>

    The Social config

  • Optionalturnstile?: string

    a cf_clearance Cloudflare turnstile token.

  • OptionaluserAgent?: string

    The client's user agent.

    Default

    "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36 Edg/123.0.0.0"

Settings

Member Visibility