# maubot-ntfy

This is a [maubot](https://maubot.xyz/) plugin to subscribe
to [ntfy](https://ntfy.sh/) topics and send messages to a matrix room.

## Usage

Install as a maubot plugin and configure an instance. Until maubot supports
installing python dependencies, you should install the `emoji` python package
for full functionality. Alternatively, `@ntfy:catgirl.cloud` is available as
well.

### Commands

| Command                                           | Example                                                                       | Description                                                                                     |
|---------------------------------------------------|-------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------|
| `!ntfy add-topic <server>/<topic>`                | `!ntfy add-topic ntfy.sh/my_topic`                                            | Adds a topic to the database and makes it available globally within this bot instance.          |
| `!ntfy remove-topic <server>/<topic>`             | `!ntfy remove-topic ntfy.sh/my_topic`                                         | Removes an available topic from the database and to cancels all associated subscriptions.       |
| `!ntfy list-topics`                               |                                                                               | Lists all available topics for this bot instance.                                               | 
| `!ntfy subscribe <server>/<topic>`                | `!ntfy subscribe ntfy.sh/my_topic`                                            | Subscribe the current room to the ntfy topic. Future messages will be sent to the room.         |
| `!ntfy subscribe <server>/<topic> <access_token>` | `!ntfy subscribe ntfy.sh/my_protected_topic tk_be6uc2ca1x1orakcwg1j3hp0ylot6` | Subscribes to a protected topic via [access token](https://docs.ntfy.sh/config/#access-tokens). |
| `!ntfy unsubscribe server/topic`                  | `!ntfy subscribe ntfy.sh/my_topic`                                            | Unsubscribes a room from a topic.                                                               | 
| `!ntfy list-subscriptions`                        |                                                                               | Lists all active subscriptions for this bot room.                                               |