| 1 | The Twitter module implements Twitter support for BarnOwl. It also |
|---|
| 2 | supports automatic mirroring of some subset of Zephyrs you send to |
|---|
| 3 | Twitter. |
|---|
| 4 | |
|---|
| 5 | To configure it, first |
|---|
| 6 | |
|---|
| 7 | * Add your twitter credentials to ~/.owl/twitter as a JSON hash, e.g. |
|---|
| 8 | {"user":"nelhage", "password":"sekrit" } |
|---|
| 9 | * Load the module (cp Twitter.par into ~/.owl/modules and :reload-module Twitter) |
|---|
| 10 | * Set the twitter:class, twitter:instance, and twitter:opcode |
|---|
| 11 | variables to the destination you want messages to be mirrored |
|---|
| 12 | from. By default, they are -c $YOUR_USERNAME -i status -O twitter |
|---|
| 13 | Setting twitter:opcode to "" will cause "normal" (i.e. no opcode) |
|---|
| 14 | messages to that class/instance to be mirrored. A value of '*' |
|---|
| 15 | works as a "match-anything" wildcard for any of the fields. |
|---|
| 16 | |
|---|
| 17 | Twitter.par will also receive twitters and inject them into barnowl as |
|---|
| 18 | messages of type 'twitter'. It polls for normal messages once a |
|---|
| 19 | minute, and direct messages every other minute. To disable polling, |
|---|
| 20 | you can unset the 'twitter:poll' variable in BarnOwl. |
|---|
| 21 | |
|---|
| 22 | Twitter.par now supports other Twitter-compatible microblogging |
|---|
| 23 | services, like identi.ca. To enable this, set the 'service' parameter |
|---|
| 24 | in your config hash to the API URL of your service. You will likely |
|---|
| 25 | also need to set 'apihost' and 'apirealm'. See Net::Twitter or your |
|---|
| 26 | blogging service's documentation for more information. |
|---|
| 27 | |
|---|
| 28 | Twitter.par also supports using multiple Twitter and Twitter-compatible |
|---|
| 29 | microblogging accounts from the same instance. To enable this, add |
|---|
| 30 | additional hashes to your ~/.owl/twitter file (wrapped in a JSON list, |
|---|
| 31 | eg. [{"account_nickname":"twitter","user":"nelhage","password":"sekrit"}, |
|---|
| 32 | {"account_nickname":"identica","service":"http://identi.ca/api", |
|---|
| 33 | "user":"nelhage","password":"sekriter"}] |
|---|
| 34 | |
|---|
| 35 | By default, public messages (excluding at-replies) are sent to all |
|---|
| 36 | accounts listed except those with publish_tweets set to false. |
|---|
| 37 | |
|---|
| 38 | There are several additional account-specific parameters that control the |
|---|
| 39 | behavior of Twitter.par when using multiple accounts: |
|---|
| 40 | |
|---|
| 41 | * account_nickname (string, required if multiple accounts are in use) |
|---|
| 42 | Specify a short name by which you can refer to the account, eg. |
|---|
| 43 | "identica" (eg. :twitter-direct nelhage identica would send a direct |
|---|
| 44 | message to @nelhage on identi.ca from your account nicknamed "identica"). |
|---|
| 45 | * default_sender (boolean, default false) |
|---|
| 46 | If true, direct messages and at-replies you send without specifying an |
|---|
| 47 | account will be sent using this account. If no account has this parameter, |
|---|
| 48 | such messages will be sent using the first account listed. |
|---|
| 49 | * poll_for_tweets (boolean, default true) |
|---|
| 50 | If true, tweets sent by your friends on this account will be displayed |
|---|
| 51 | in your BarnOwl message list. |
|---|
| 52 | * poll_for_dms (boolean, default true) |
|---|
| 53 | If true, Direct Messages sent to you by your friends on this account |
|---|
| 54 | will be displayed in your BarnOwl message list. |
|---|
| 55 | * publish_tweets (boolean, default true) |
|---|
| 56 | If true, tweets you send without specifying an account (either with the |
|---|
| 57 | :twitter command or mirrored from a zephyr class) will be published to |
|---|
| 58 | this account. |
|---|
