SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias MinecraftAccountProto

    MinecraftAccountProto: Message<"soulfire.v1.MinecraftAccountProto"> & {
        accountData:
            | {
                case: "onlineChainJavaData";
                value: MinecraftAccountProto_OnlineChainJavaData;
            }
            | {
                case: "offlineJavaData";
                value: MinecraftAccountProto_OfflineJavaData;
            }
            | { case: "bedrockData"; value: MinecraftAccountProto_BedrockData }
            | {
                case: "onlineSimpleJavaData";
                value: MinecraftAccountProto_OnlineSimpleJavaData;
            }
            | {
                case: "theAlteningJavaData";
                value: MinecraftAccountProto_TheAlteningJavaData;
            }
            | { case: undefined; value?: undefined };
        config: SettingsNamespace[];
        lastKnownName: string;
        persistentMetadata: SettingsNamespace[];
        profileId: string;
        type: MinecraftAccountProto_AccountTypeProto;
    }

    Represents an authenticated Minecraft account that can be used by bots. This can be a Microsoft account (Java or Bedrock), TheAltening Java account, raw Java access-token account, or offline account. The account contains authentication data, profile information, and per-account settings. Used throughout the system for instance configuration and bot management.

    Type Declaration

    • accountData:
          | {
              case: "onlineChainJavaData";
              value: MinecraftAccountProto_OnlineChainJavaData;
          }
          | { case: "offlineJavaData"; value: MinecraftAccountProto_OfflineJavaData }
          | { case: "bedrockData"; value: MinecraftAccountProto_BedrockData }
          | {
              case: "onlineSimpleJavaData";
              value: MinecraftAccountProto_OnlineSimpleJavaData;
          }
          | {
              case: "theAlteningJavaData";
              value: MinecraftAccountProto_TheAlteningJavaData;
          }
          | { case: undefined; value?: undefined }

      The platform-specific authentication data. Exactly one of these fields will be set based on the account type.

      from oneof soulfire.v1.MinecraftAccountProto.account_data

    • config: SettingsNamespace[]

      Per-bot configuration settings stored with the account. Organized as namespace -> key -> value mappings. These settings override instance-level settings when the bot is running. Typically includes bot-specific behavior settings.

      from field: repeated soulfire.v1.SettingsNamespace config = 8;

    • lastKnownName: string

      The last known username/gamertag for this account. Updated during authentication and refresh operations. For Java: The Minecraft username (up to 16 characters). For Bedrock: The Xbox gamertag.

      from field: string last_known_name = 3;

    • persistentMetadata: SettingsNamespace[]

      Persistent metadata stored with the account across sessions. Organized as namespace -> key -> value mappings. Used by plugins and the system to store account-specific state that should persist across bot restarts (e.g., last position, inventory cache).

      from field: repeated soulfire.v1.SettingsNamespace persistent_metadata = 9;

    • profileId: string

      The unique profile identifier (UUID) for this account. For online accounts: The profile UUID returned by the authentication provider. For offline accounts: A deterministic UUID derived from the username. Format: Standard UUID string (e.g., "550e8400-e29b-41d4-a716-446655440000").

      from field: string profile_id = 2;

    • type: MinecraftAccountProto_AccountTypeProto

      The authentication type used for this account. Determines which account_data field is populated.

      from field: soulfire.v1.MinecraftAccountProto.AccountTypeProto type = 1;

    from message soulfire.v1.MinecraftAccountProto