Compare commits

...

2 commits

Author SHA1 Message Date
Hugh Rundle e2ece557c2
add some more options
- add extra reply options
- fix mentions
2024-08-10 12:09:36 +10:00
Hugh Rundle 2a6cf879b6
update readme and deps 2024-08-10 11:44:48 +10:00
3 changed files with 37 additions and 21 deletions

View file

@ -45,6 +45,14 @@ Then run `npm install .` to install npm modules `axios` and `ws`.
Start the bot with the traditional `node index.js`. Start the bot with the traditional `node index.js`.
However, you probably want this to run automatically on a web server. You can do this with `systemd` using the example unit file: `mastodon-clippy.service.example`. Adjust this for your user and paths, and then activate it:
```bash
sudo cp mastodon-clippy.service.example /etc/systemd/system/mastodon-clippy.service
sudo systemctl enable mastodon-clippy.service
sudo systemctl start mastodon-clippy service
```
## interacting with the bot ## interacting with the bot
To "sign up" for notification from your bot, users have two options: To "sign up" for notification from your bot, users have two options:

View file

@ -1,4 +1,4 @@
/* /*
Clippy bot for mastodon. Clippy bot for mastodon.
@ -53,25 +53,33 @@ function initiateSettings(socket) {
// return random suggestion string // return random suggestion string
function suggestion(username) { function suggestion(username) {
const n = crypto.randomInt(8) const n = crypto.randomInt(12)
switch(n) { switch(n) {
case 0: case 0:
return 'How about logging off instead?'; return 'How about logging off instead?';
case 1: case 1:
return `Would you like to delete your toot, ${username}?`; return `Would you like to delete your toot, @${username}?`;
case 2: case 2:
return 'Can I help you take a walk outside?'; return 'Can I help you take a walk outside? 🚶‍➡️';
case 3: case 3:
return 'You may like to reconsider your life choices.'; return 'You may like to reconsider your life choices.';
case 4: case 4:
return 'Why not try looking at #CatsOfMastodon instead?'; return 'Why not try looking at #CatsOfMastodon instead?';
case 5: case 5:
return `Come on ${username}, we've talked about this.`; return `Come on @${username}, we've talked about this. 🤷‍♂️`;
case 6: case 6:
return `You should go look at some trees. Trees are calming`; return `You should go look at some trees. Trees are calming 🌳`;
case 7: case 7:
return `I'm not angry. I'm just very disappointed.`; return `I'm not angry. I'm just very disappointed. 😔`;
case 8:
return `You said you were going to stop doing that ...and yet here we are.`;
case 9:
return `Time to touch some grass 🌱`;
case 10:
return `Why not have a nice cup of tea instead? 🫖`;
case 11:
return `And yet you still haven't read all of those books in your TBR pile. 🤔`;
} }
} }
@ -133,42 +141,42 @@ function listen() {
// make sure bot is set up correctly each time it starts // make sure bot is set up correctly each time it starts
initiateSettings(ws) initiateSettings(ws)
// errors // errors
ws.on('error', err => { ws.on('error', err => {
console.error(`WebSocket error: ${err.message}`) console.error(`WebSocket error: ${err.message}`)
resetConnection(ws) resetConnection(ws)
}) })
// check updates and notifications in the stream // check updates and notifications in the stream
ws.on('message', msg => { ws.on('message', msg => {
let packet = JSON.parse(msg) let packet = JSON.parse(msg)
let data = JSON.parse(packet.payload) let data = JSON.parse(packet.payload)
// notifications // notifications
if (packet.event == 'notification') { if (packet.event == 'notification') {
// always follow back // always follow back
if (data.type == 'follow') { if (data.type == 'follow') {
followAction(data.account.id, 'follow') followAction(data.account.id, 'follow')
} }
if (data.type == 'mention') { if (data.type == 'mention') {
let post = data.status.content let post = data.status.content
// check start requests // check start requests
if (post.match(/\bSTART\b/)) { if (post.match(/\bSTART\b/)) {
followAction(data.account.id, 'follow') followAction(data.account.id, 'follow')
} }
// check stop requests // check stop requests
if (post.match(/\STOP\b/)) { if (post.match(/\STOP\b/)) {
followAction(data.account.id, 'unfollow') followAction(data.account.id, 'unfollow')
} }
} }
} }
// updates (posts) // updates (posts)
if (packet.event == 'update') { if (packet.event == 'update') {
let rid = data.id let rid = data.id
@ -185,7 +193,7 @@ function listen() {
} }
else if (data.spoiler_text.toLowerCase().includes(topic)) { else if (data.spoiler_text.toLowerCase().includes(topic)) {
sendResponse(rid, user, username) sendResponse(rid, user, username)
} }
else if (data.tags.map(tag => tag.name.toLowerCase()).includes(topic)) { else if (data.tags.map(tag => tag.name.toLowerCase()).includes(topic)) {
sendResponse(rid, user, username) sendResponse(rid, user, username)
} }

View file

@ -1,8 +1,8 @@
{ {
"name": "mastodon-clippy", "name": "mastodon-clippy",
"version": "1.1.1", "version": "1.1.2",
"description": "Mastodon clippy bot", "description": "Mastodon clippy bot",
"repository": "https://github.com/hughrun/mastodon-clippy.git", "repository": "https://git.suboptimal.solutions/hugh/mastodon-clippy",
"main": "index.js", "main": "index.js",
"scripts": { "scripts": {
"test": "echo \"Error: no test specified\" && exit 1" "test": "echo \"Error: no test specified\" && exit 1"
@ -10,7 +10,7 @@
"author": "Hugh Rundle <hugh@hughrundle.net> (https://www.hughrundle.net)", "author": "Hugh Rundle <hugh@hughrundle.net> (https://www.hughrundle.net)",
"license": "AGPL-3.0-or-later", "license": "AGPL-3.0-or-later",
"dependencies": { "dependencies": {
"axios": "^0.21.2", "axios": "^1.7.3",
"ws": "^7.5.2" "ws": "^8.18"
} }
} }