https://github.com/Ulrar/umrc

IRC bot to control a mastodon or twitter account from a channel
https://github.com/Ulrar/umrc

Last synced: about 2 months ago
JSON representation

IRC bot to control a mastodon or twitter account from a channel

• Host: GitHub
• URL: https://github.com/Ulrar/umrc
• Owner: Ulrar
• License: other
• Archived: true
• Created: 2017-04-30T18:15:12.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-10-31T21:45:55.000Z (almost 7 years ago)
• Last Synced: 2024-07-27T01:40:04.515Z (about 2 months ago)
• Language: Haskell
• Homepage:
• Size: 46.9 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
umrc is a bot to allow using a Mastodon account from IRC.

It will display on the configured channel incomming notifications (follows, mentions ..)

Available commands for Mastodon are :

```

|toot 

|reply  

|delete 

|boost 

|favorite 

|unfavorite 

|follow 

|unfollow 

```

Available commands for twitter are :

```

!tweet 

!reply  

!delete 

!retweet 

!rt  # alias for !retweet

!favorite 

!unfavorite 

!follow 

!unfollow 

```

You can also set the toot visibility like that, if you want :

```

|toot -private 

|replytoot -direct 

```

Thanks to @syucream for the Hastodon library, I'm using an (included) slightly

modified version of it here. See https://github.com/syucream/hastodon for the original.

# Compilation

Unfortunatly you'll need cabal >= 1.22, which means you'll need backports on debian jessie.

See https://backports.debian.org/Instructions/ for instructions on enabling backports.

Then you'll need to install packages :

```bash

apt-get -t jessie-backports install cabal-install ghc

```

And finally, compile umrc :

```bash

$ cabal update

$ cabal install --only-dependencies

$ cabal build

```

That should give you the final binary in dist/build/umrc/umrc.

# Configuration

You need to register the app on mastodon and get a client id, secret and a token.

You can use https://tinysubversions.com/notes/mastodon-bot/ for that, and use those ids

in the config file.

As for twitter, you'll need to register an app too because the twitter API is ridiculous.

You can do that here : https://apps.twitter.com/

You'll need to create the APP (find some unused name ..) and get the consumer key (appkey),

consumer secret (appsecret), and then generate an access token and add that to the config too.

```

[IRC]

server = chat.freenode.net

nick = umrc

chan = #umrc

admins = Ulrar, Someone else

[MASTODON]

enabled = true

clientId = ID

clientSecret = Another ID

token = The token

domain = mastodon.tld

[TWITTER]

enabled = true

appkey = KEY

appsecret = SECRET

token = TOKEN

tokensecret = TOKEN SECRET

```

If you don't want to use Mastodon or Twitter, just change enabled to false and it'll become

inactive, the commands will just reply "X is disabled".

See the included config.ini for an (inactive) example.

Save that somewhere as config.ini

# Running

Copy the binary and the config somewhere, and you can just run it with the config as a parameter.

For example, if you copied the binary in /usr/local/bin and the config in /etc :

```sh

/usr/local/bin/umrc /etc/umrc.ini

```

You might want to write an init file to start it automatically at boot.

I included a SysV init script in the init_scripts directory, you just need to copy the init.d

content to your /etc/init.d and the default content to your /etc/default/ and adjust the values

in there.