SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Variable SoulFireConst

    SoulFire: {
        connect: (
            options: SoulFireOptions,
        ) => Effect<SoulFireClient, SoulFireConnectionError, Scope>;
        connectManaged: (
            options: SoulFireOptions,
            localServer: LocalServerController,
        ) => Effect<SoulFireClient, SoulFireConnectionError, Scope>;
        createBot: (
            options: ManagedBotOptions,
        ) => Effect<
            SoulFireBot,
            SoulFireConnectionError
            | SoulFireOperationError,
            Scope,
        >;
        install: (
            options?: SoulFireInstallOptions,
        ) => Effect<SoulFireClient, SoulFireConnectionError, Scope>;
        installLayer: (
            options?: SoulFireInstallOptions,
        ) => Layer<SoulFireService, SoulFireConnectionError>;
        layer: (
            options: SoulFireOptions,
        ) => Layer<SoulFireService, SoulFireConnectionError>;
        unauthenticated: (
            options: SoulFireOptions,
        ) => Effect<SoulFireClient, SoulFireConnectionError, Scope>;
        connectWithHttpClient(
            options: SoulFireOptions,
        ): Effect<SoulFireClient, SoulFireConnectionError, Scope | HttpClient>;
        layerWithHttpClient(
            options: SoulFireOptions,
        ): Layer<SoulFireService, SoulFireConnectionError, HttpClient>;
    } = ...

    Node.js connection and managed installation helpers.

    connect checks compatibility with an existing SoulFire server. install downloads and starts a local server, while createBot also provisions a ready bot. These operations require Scope. Cleanup stops the managed process and leaves downloaded files and persistent data in place.

    Type Declaration

    Import this object from @soulfiremc/sdk/node. createBot uses offline authentication unless configured otherwise. Its Minecraft address is separate from a remote client's gRPC-Web URL.

    Settings
    Member Visibility