Metadata-Version: 2.4
Name: nonebot-plugin-asf
Version: 0.1.3
Summary: NoneBot plugin for controlling ArchiSteamFarm through Telegram and ASF IPC.
Project-URL: Homepage, https://github.com/zanderzhng/nonebot-plugin-asf
Project-URL: Repository, https://github.com/zanderzhng/nonebot-plugin-asf
Project-URL: ASF IPC, https://github.com/JustArchiNET/ArchiSteamFarm/wiki/IPC
Author: zanderzhng
License: MIT
Requires-Python: >=3.10
Requires-Dist: httpx[socks]<1.0.0,>=0.27.0
Requires-Dist: nonebot2[fastapi]<3.0.0,>=2.5.0
Description-Content-Type: text/markdown

# nonebot-plugin-asf

NoneBot plugin for controlling ArchiSteamFarm through Telegram and ASF IPC.

## Runtime Model

Load `nonebot_plugin_asf` from a NoneBot app. The plugin handles Telegram Bot
API long polling directly and forwards authorized `!` commands to ASF IPC.

## Configuration

Set these environment variables:

- `TELEGRAM_BOT_TOKEN`
- `TELEGRAM_PROXY`, optional HTTP or SOCKS proxy URL for Telegram API access
- `TELEGRAM_ALLOWED_USER_IDS`, comma-separated Telegram user IDs
- `TELEGRAM_ALLOWED_CHAT_IDS`, optional comma-separated chat IDs
- `ASF_BASE_URL`, default `http://asf:1242`
- `ASF_IPC_PASSWORD`
- `POLL_TIMEOUT_SECONDS`, default `45`

At least one of `TELEGRAM_ALLOWED_USER_IDS` or `TELEGRAM_ALLOWED_CHAT_IDS` must
be set.

## Usage

- `/help` shows wrapper usage.
- `/commands` lists ASF commands and is registered in Telegram's bot menu.
- ASF commands require `!`, for example `!status`.
