Optionaloptions: CallOptionsStop this client's managed local server, if present.
The connection scope calls this operation automatically. Downloaded files and server data remain in place. For a remote connection, this operation does nothing.
Optionaloptions: CallOptionsCreate or reuse a ready bot on this connected SoulFire server.
Minecraft address, username, authentication, and readiness options.
An Effect that produces an observed bot and requires Scope.
The instance name defaults to the trimmed Minecraft address, and the bot name defaults to the username. Repeated calls reuse named resources. Conflicting configuration fails. Cleanup stops a bot this operation started and preserves one that was already running. The instance and account remain available.
Optionaloptions: CallOptionsFind or create a named instance for the authenticated user.
Stable instance name used for provisioning.
Minecraft server address and RPC call options.
An Effect that produces an instance handle after server acceptance.
Create an instance handle without a network request.
Existing instance UUID, not the friendly name.
A handle using this client's transport. It does not check existence or access.
getOrCreateInstance to provision by name.
Optionaloptions: CallOptionsReplace the bearer token or provider for subsequent requests.
This synchronous change does not restart existing streams or run a handshake.
Token, a provider evaluated per request, or undefined to clear it.
StaticconnectConnect to an existing server and check SDK compatibility.
gRPC-Web URL, authentication, timeouts, and compatibility requirements.
A lazy Effect that produces the connected client after the handshake.
The handshake checks the SDK API version, required capabilities, and plugin
versions. Requires Scope; cleanup closes any resources this client owns.
A remote SoulFire server continues running after the scope closes.
Failures use SoulFireConnectionError in the Effect error channel.
unauthenticated when login must precede the handshake.
StaticconnectStaticunauthenticatedCreate a scoped client without an SDK handshake.
Use this client to complete the login flow before compatibility negotiation. Server metadata is unavailable until the handshake completes.
Connection options accepted by connect.
A lazy Effect that produces a client and requires Scope.
A scoped connection to a SoulFire server and its instances.
Use SoulFire.connect for an existing server. The Node and Bun entry points also provide managed installation and a one-call
createBothelper. SDK operations return lazy Effects and Streams. Compose them in an Effect workflow and run the complete workflow at the application boundary.Remarks
The connection handshake checks API compatibility, capabilities, and plugins. Keep client operations inside the connection scope. Cleanup stops a managed local process but leaves persistent server data and downloaded files in place.