SoulFire TypeScript SDK 2.10.8
    Preparing search index...

    Variable SoulFireConst

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

    Bun 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/bun. createBot uses offline authentication unless configured otherwise. Its Minecraft address is separate from a remote client's gRPC-Web URL.