Terminology

Server/Client

SoulFire has two main components: a server and a client.

Server

The SoulFire server is also called the backend. It manages users, bots, and instances.

• Users: The server manages the users and their permissions.
• Instances: An instance keeps one group of accounts, bots, proxies, scripts, settings, and permissions separate from other groups.
• Bots: Each configured account is one independently controlled bot with its own desired and runtime state.
• Plugins: SoulFire plugins are loaded and managed by the server.
• Proxies/Accounts: The server manages the proxies and accounts used by the bots.

Client

The client is also called the frontend. It connects to the SoulFire server and sends requests. A GUI client has a graphical interface. A CLI client uses a terminal. Custom software can use the SoulFire API as an API client.

• GUI: The client can be a graphical user interface.
• CLI: The client can be a command-line interface.
• API: The client can be an API client.
• Interactions: The client interacts with the server to manage users, instances, bots, plugins, proxies and accounts.

Clients can connect to any SoulFire server, as long as they have the correct credentials and use the same API version.

Chart

This chart shows the relationship between clients, servers, instances, and bots.