What it is
A plugin, not a service
If you run ArchiSteamFarm and want to know when something needs you, this puts it in
a chat room. It sends a message when ASF stops a bot, when a bot stays disconnected
and when it logs on again, when farming finishes and when ASF is updated.
One plugin and one room serve every bot in the instance, including bots you add
later. Delivery runs on a background queue, so a slow homeserver never slows ASF
down, and the access token is never logged.
Events
Each one is on or off, globally and per bot, except AsfUpdated, which is global
BotStoppedByAsf | ASF stopped the bot: login failed, or it needs input. On. |
BotDisconnected | Still disconnected after a set time, 5 minutes by default. On. |
BotReconnected | Logged on again after a disconnect was reported. On. |
FarmingFinished | Farming finished and something was farmed. On. |
AsfUpdated | ASF is newer than at the last start. On. |
BotStopped | A bot stopped without an ASF error, for example the stop command. Off. |
FarmingStarted | Farming started. Off. |
FarmingStopped | Farming stopped. Off. |
Global and per bot
ASF's own config files
The settings live in an ASFNotifier block in ASF.json.
A bot can have its own block in its config file to silence it or to change which
events it reports. A per-bot value wins over the global one, and ASF applies an edit
when the bot config reloads, with no restart.
{ "ASFNotifier": {
"Events": { "FarmingFinished": false }
} }
The room is global: there is no per-bot room.
Quick start
From the release zip
-
Download
ASFNotifier.zip from the latest release and extract its
contents into plugins/ASFNotifier/. With Docker, that is the mounted
plugins directory.
-
On your Matrix homeserver, create a bot user and an unencrypted room,
invite the bot and join it. Note its access token and the room ID.
- Add the room to
ASF.json:
{
"ASFNotifier": {
"Matrix": {
"HomeserverUrl": "https://matrix.example.org",
"RoomId": "!abc123:example.org"
}
}
}
-
Put the token in the environment of the ASF process, not in
ASF.json:
ASF_NOTIFIER_MATRIX_ACCESS_TOKEN.
-
Restart ASF, then send
!notifytest to a bot as its Master or Owner. A
test message appears in the room.
Requirements
Matrix only, unencrypted rooms only
Built and tested against ArchiSteamFarm 6.3.10.6. The .NET runtime is the one ASF ships with, so
there is nothing else to install. You need a Matrix homeserver, a dedicated bot user
and an unencrypted room, addressed by its room ID rather than an alias.
Telegram, Discord and the rest
Through Matrix
The plugin speaks Matrix only. To get the same alerts elsewhere, bridge the alerts
room to the other network, for example with the mautrix bridges for Telegram,
Discord, WhatsApp, Signal and Slack, or just read the room in any Matrix client with
push notifications on.
Bridges are not tested by this project: the plugin only ever posts to the room.
Updates
Through ASF's plugin updater
Add ASFNotifier to PluginsUpdateList in
ASF.json and ASF fetches new releases from GitHub by itself, in Docker
too. It is opt-in: by default no plugin is updated. The README says how to turn it
off, update by hand or stay on one version. After an update ASF restarts itself, or exits in Docker, so the container needs a restart policy.
Quiet by design
Little noise
Stop messages wait about ten seconds, so an ASF restart does not look like every bot
stopping. The same event for the same bot is sent at most once every ten minutes,
and at most twenty go out in an hour, apart from stops by ASF and reconnects. A short outage that ends before the
threshold sends nothing.
Get it
Repository, release and README
The source, the releases and the full documentation are on GitHub.
Latest release
Repository
README
Open and free โ support it
Apache-2.0
Free and open source. If it saved you a night of wondering why nothing was farming, a donation is much appreciated.
Donate
GitHub Sponsors