SoulFire LogoSoulFire

Names and compatibility

Map Project, feature, and script-node labels to the identifiers used by existing integrations.

The updated app uses Project for a saved automation container. Older releases call it Instance. A project owns bots, settings, accounts, proxies, scripts, files, access, and metadata, and remains available while its bots are stopped. Fleet describes a selection of bots within that project.

The display-name migration changes labels, not API identities, data ownership, configuration formats, or runtime behavior. Published SDK references and generated node documentation keep their pinned source revision and can use the earlier labels.

Product names

Earlier labelUpdated labelCompatibility
InstanceProjectAPI types and fields keep Instance, instanceId, and instance_id.
Instance settingsProject settingsExisting routes stay valid.
Bot POVBot viewPOV remains the technical capability name.
Control lease in app textTake control / Release controlLease terminology remains in the API.
Load profile / Save profileImport configuration / Export configurationExisting JSON files remain importable.
Duplicate instanceCreate from configurationSame copy operation, with its contents described explicitly.

A Minecraft profile ID still identifies a Minecraft account. It is not a configuration file or a SoulFire user ID. The instance CLI command and SDK methods such as client.instance(...), getOrCreateInstance, and get_or_create_instance remain valid. Raw API errors can still refer to an Instance or an instance_id field.

Feature names

Earlier nameUpdated display nameStable ID
Auto ArmorAuto equip armorauto-armor
Auto TotemAuto equip totemauto-totem
Auto JumpRandom jumpauto-jump
Auto Chat MessageAuto chatauto-chat-message
Auto RegisterAuto login and registerauto-register
AI Chat BotAI chatai-chat-bot
Kill Aura / KillAuraAuto attackkill-aura
Client SettingsMinecraft client settingsclient-settings
Fake Virtual HostHandshake host overridefake-virtual-host
Server List BypassPing before joinserver-list-bypass
Forwarding BypassPlayer forwardingforwarding-bypass

Other built-in names use sentence case, including Auto eat, Auto respawn, Auto reconnect, Captcha solver, Chat logger, Disconnect logger, and Client brand. Anti AFK retains its familiar acronym. The migrated app searches stable IDs in hyphenated, spaced, and compact forms, so earlier names remain discoverable. A connected server supplies its feature labels. Older servers can still show the earlier names.

Script nodes

Earlier nameUpdated display nameStable type
DebounceCooldownflow.debounce
On Bot InitOn connection createdtrigger.on_bot_init
On JoinOn player readytrigger.on_join
Get Bot StateGet movement statedata.get_bot_state
Select SlotSelect hotbar slotaction.select_slot
Drop ItemDrop cursor itemaction.drop_item
PrintLog messageaction.print
Pathfind ToGo to positionaction.pathfind_to
Get/Set Session Bot VariableGet/Set connection variablevariable.get_session_bot, variable.set_session_bot
Get/Set Session Instance VariableGet/Set project runtime variablevariable.get_session_instance, variable.set_session_instance
Get/Set Persistent Bot VariableGet/Set persistent bot variablevariable.get_persistent_bot, variable.set_persistent_bot
Get/Set Persistent Instance VariableGet/Set persistent project variablevariable.get_persistent_instance, variable.set_persistent_instance

Existing graphs resolve through the same node types and keep explicit labels chosen by their authors. Previous node names remain search keywords. Use the node reference for ports and the pinned implementation. See script state for variable ownership and lifetime.

Configuration copies and exports

Create from configuration copies settings, accounts and their credentials, proxies, project and account persistent metadata, and the icon. It excludes scripts, files, permissions, and history. The new project belongs to the person who creates it.

Export configuration includes settings, accounts and their credentials, proxies, and account persistent metadata. The app currently omits project-level persistent metadata from exports.

Keep exported files private

Configuration files contain account credentials and proxy passwords. Share them only with people who should have those credentials.

A configuration export is not a complete project backup.

New downloads use soulfire-configuration.json. Older files named profile.json remain importable. Use server backup and restore when you need to recover the complete SoulFire server.

Versions and translations

The app's English source strings change first. Other locales keep their existing names until their Crowdin translations are reviewed. Examples that use instance identifiers remain compatible, including examples for SDK versions published before this display-name migration.

The shared naming proposal records the selected mappings and the coordinated rollout. Its acceptance status is separate from implementation and release.

How is this page?

Last updated on

On this page