Skip to content
This repository has been archived by the owner on Sep 26, 2022. It is now read-only.

Latest commit

 

History

History
108 lines (87 loc) · 2.79 KB

README.md

File metadata and controls

108 lines (87 loc) · 2.79 KB

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 <text>
|reply <id> <text>
|delete <id>
|boost <id>
|favorite <id>
|unfavorite <id>
|follow <text>
|unfollow <text>

Available commands for twitter are :

!tweet <text>
!reply <id> <text>
!delete <id>
!retweet <id>
!rt <id> # alias for !retweet
!favorite <id>
!unfavorite <id>
!follow <text>
!unfollow <text>

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

|toot -private <text>
|replytoot -direct <text>

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 :

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

And finally, compile umrc :

$ 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 :

/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.