Automated anti-loneliness bots for your Pleroma/Mastodon instance
Go to file
Wouter Groeneveld 0c1228dab5 added readme 2021-04-01 19:48:32 +02:00
.yarn/releases first commit! 👏 2021-03-29 20:29:25 +02:00
data mobygames API implementation 2021-04-01 13:19:09 +02:00
src integration mobygames buddy in chat 2021-04-01 16:24:46 +02:00
.gitignore mobygames API implementation 2021-04-01 13:19:09 +02:00
.pnp.js rough work of tooting and ac buddy done 2021-03-30 15:55:01 +02:00
.yarnrc.yml first commit! 👏 2021-03-29 20:29:25 +02:00 added readme 2021-04-01 19:48:32 +02:00
package.json mobygames API implementation 2021-04-01 13:19:09 +02:00
plerobuddies.sublime-project first commit! 👏 2021-03-29 20:29:25 +02:00
screenshot.jpg added readme 2021-04-01 19:48:32 +02:00
yarn.lock rough work of tooting and ac buddy done 2021-03-30 15:55:01 +02:00


Yay! Working examples say more than a 1000 words:

Screenshot from a Pleroma instance

Mastodon/Pleroma Buddies (bots)

Execute through yarn toot or yarn node src/chat.js. It cycles through all configured "buddies" and toots a message accordingly. Use your favorite crontab timestamp to fire off toots automatically.

Creating a new buddy

Create a directory in src/buddies/ and add it to config.js using the same name. Each buddy should have a buddy.js with one exposed method called chat, which gets executed with a config parameter. Look at the examples for more information. End the file with something like module.exports = { chat }.

The function chat should create a "toot", with the following structure:

    "toot": "hi there buddy!",
    "attach": [ "file1.jpg", "file2.jpg" ],
    "attachDescription": `Screenshots of game x`

An attach and its description are optional. Newlines using \n in a toot are allowed.

Configuring the buddies

See config.sample.js. A config file should expose buddies as an array with the following structure:

    name: "buddyname", // same as the dir name
    instance: "", // where to post to
    oauthToken: "my-token" // the oauth token for that server/user to post the status  with

Optional config flags can be used in the chat function if desired.

How to get an OAuth token from a Masto?Pleroma instance?

I've prepared a few utility functions in registerApp.js for you. First, call await register(), which prints an URL to go to. Next, fill in the client id, secret, and returned token, after granting the app access to read and write. Then, call await fetchToken(). Paste that token in the config file. Done!

Token refreshing is not (yet) implemented. Most tokens are valid for a year or so. Who knows what'll happen then.