SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Interface CreateBotOptions

    interface CreateBotOptions {
        auth?: "offline" | "microsoft";
        call?: CallOptions;
        instanceName?: string;
        name?: string;
        onDeviceCode?: (code: DeviceCode) => Effect<void, SoulFireOperationError>;
        readyTimeoutMs?: number;
        server: string;
        username: string;
    }

    Hierarchy (View Summary)

    Index
    auth? call? instanceName? name? onDeviceCode? readyTimeoutMs? server username
    auth?: "offline" | "microsoft"

    Account authentication, default offline. Microsoft provisioning can require device-code login.

    call?: CallOptions
    instanceName?: string
    name?: string
    onDeviceCode?: (code: DeviceCode) => Effect<void, SoulFireOperationError>

    Effect callback for Microsoft sign-in codes. Without it, the SDK logs the URL and code.

    readyTimeoutMs?: number

    Positive, finite startup and player-snapshot deadline in milliseconds. Defaults to 30,000.

    server: string
    username: string

    Minecraft username for a new offline account. Existing conflicting account configuration fails.

    Settings
    Member Visibility

    On This Page
    Properties