Sopel Mastodon

Mastodon plugin for Sopel IRC bots.

Installation

You must already have Sopel installed to use this method.

git clone https://github.com/hackspace-marburg/troet
cd sopel-mastodon
pip install .

Setup

The plugin expects a mastodon section in the configuration looking like this:

[mastodon]
id = # Mastodon client ID
secret = # Mastodon client secret
token = # Mastodon access token
base_url = https://chaos.social # Base URL of the Mastodon instance of the bot account
notification_channel = "#hsmr" # IRC channel where the Bot should put notifications. Optional
delayed = false # Optional: Only post toots after a set delay. Default: false
delay = 360 # Optional: Delay (in seconds) until toots are posted if delayed mode (set above) is used. Default: 360

Limitations

This is not a general purpose Mastodon client. The intention was to make interaction between an IRC Channel and Mastodon possible to:

• Toot
• Be notified and reply to mentions (only available if notification_channel is set. Otherwise no notifications will occur)
• Delete things others tooted earlier
• Reply to specific toots (complicated, but also rarest intended use case)

As such you can only react / reply based on toots the bot has already seen. This removes the necessity for users to enter global toot/status id's for reactions. To make this easier each toot sent or recieved is assigned a 4 character code by which it will be refered to by the bot. This code is only meaningful for the bot and is not taken from the Mastodon network.

Commands

Each command exists twice: a long form command and a shorthand. Beaware: the shorthands might interfere with other plugins.

.toot .t

Send a toot! Whatever is entered after the command is tooted. At the end a newline and the Username of the sending user will be attached. On success returns the bot code of the toot as well as a permalink to it.

.tootanon .ta

Does the same as .toot but without attaching the username.

.reply .r

The first word after the command is the bot code of the toot to reply to.

.replyanon .ra

Relates to reply as tootanon relates to toot.

.delete .d

Given the bot code of the toot it will try to delete the toot. Only works on toots sent from this account, others will obviously fail.

.search .s

If given a permalink to a toot it will show this toot in IRC and assign a bot code to it. Afterwards the bot can be used to reply to it. In the Mastodon UI you can get the permalink of a toot by clicking on the timestamp. If it contains /web/ it is not the permalink.

.listedtoot .lt

To prevent potential spam from the bot to be visible on the Mastodon instances public timeline all normal toots and replies are sent with visibility set to unlisted. This command is the exception to this rule. This will act as .toot does.

.mute .m

Given a permalink or a bot code of a toot this will mute notifications originating from the given toot.

.cancel

Stops all currently requsted but unposted toots (used in delayed mode)

TODOs

• write proper Readme.md
• At the moment this code painfully ignores any kind of ratelimiting
  • If the size of the messageCache is too big (i.e.: close to 300) this could be a problem while starting the bot
    • Toots need to be reloaded due to message structure cannot be json serialized easily (because of datetime types) (i.e. I am lazy and should work on a workaround)
• Add Feature for sharing toots (Twitter "retweet" equivalent)