Steam plugin
The Steam plugin is a local Steam account on the Agent. Agent 1.1.55 or newer.
Required in China. See Regions.
Install
Open the Agent. System, Settings, Plugins.
Install Steam plugin downloads the plugin. Update Steam plugin replaces it when a newer build is published.
The Plugins page requires agent.plugins. Install and update require the root user.
The file is steamdownloader.exe on Windows and steamdownloader on Linux. It is stored in the Agent plugins directory.
Configure
Add this to config.toml and restart the Agent.
[steam_plugin]
enabled = true
plugin = "steamdownloader.exe"
username = "<steam account>"
On Linux, plugin is steamdownloader.
enabled defaults to false. While it is false, the plugin is installed and idle.
username is the Steam account name.
Sign in
System, Settings, Steam.
The Steam page is shown after the plugin is installed. Sign-in, sign-out, and Test require the root user.
- Sign in.
- Enter the Steam username and password.
- If Steam asks, enter the Steam Guard code, enter the email code, or approve the login in the Steam app, then Continue.
Status values:
| Status | Meaning |
|---|---|
| Not signed in | No saved login |
| Code required | Steam Guard or email code |
| Approval required | Approve the login in the Steam app |
| Password required | The saved login needs the password again |
| Signed in | The account is ready |
| Failed | The last attempt failed |
Sign out removes the saved account.
Credential storage
Credentials to the account are stored on the device next to the plugins folder. Ensure file access is restricted.
Related Articles
Frequently asked questions
Common questions about connecting Manager to an Agent, console windows, OmegaManager migration, ports, RCon, and the cache directory.
Moving an Agent installation
Depending on requirement, you may not require to move the entire installation, it is possible to change the locations of the following directories:
Updating an Architect Agent
Update Architect Agent from Toolbox on Windows, or replace the binary manually when an automatic update is not available.