README.markdown
1# oysttyer
2
3The official fork and replacement for what was once [Floodgap's TTYtter](http://www.floodgap.com/software/ttytter/).
4
5In order to get Cameron Kaiser's blessing, we've had to change the name, take out a new API key and keep the Floodgap Free Software License.
6
7**The master branch will be pretty much what I'm running, but that doesn't mean I've not managed to break it in someway**; Tagged releases (i.e. X.X.X) are intended to be stable. The mirror branch reflects all the historical official TTYtter updates.
8
9See the [oysttyer User Guide](http://oysttyer.github.io/docs/userGuide.html) for usage information.
10
11## Switching from TTYtter
12
131. You have to re-authorise (you can't use your `.ttytterkey`) as we have a new API key
142. Move/rename your `.ttytterc` file to `.oysttyerrc`
153. If you use the `ttytteristas` pref it is now called `oysttyeristas`
164. Read the Changelog to see what's new since TTYtter 2.1
17
18I think that's it?
19
20### Launching Oysttyer
21
22Depending on how you obtain oysttyer the file could already be executable so you can launch it directly (`./oysttyer.pl`) as long as the shebang matches your path to Perl or you alter the shebang so it does. However, it's probably a lot easier just to do:
23
24 perl oysttyer.pl
25
26### Using your own oauthkey and oauthsecret
27
28Since the transition from TTYtter, Twitter seem to be in the habit of muzzling us (their word for blocking write access). This is done at the oysttyer oauthkey/secret level so affects all users. As a (hopefully) temporary work-around until we can resolve this issue permanently with Twitter you can register our own app (You can call it whatever, but if you are stuck for a name call it "oysttyer-<your twitter handle>") and specify the `oauthkey` and `oauthsecret` in the `.oysttyerrc` file:
29
30 oauthkey=xxXxxXxxXXXXXxXxxxXXXxxXX
31 oauthsecret=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
32
33Be sure to avoid trailing whitespace in your key/secret. You will, of course, have to re-authorise and get a new token. I suggest taking advantage of the existing keyfile functionality in oysttyer to do this. **Important**: If you are using you own oauthkey and oauthsecret to get a new token then that token will only work with your own oauthkey and oauthsecret. Tokens are not interchangeable between oauthkeys and oauthsecrets.
34
35### New functionality since TTYtter 2.1
36
37Until we catch up with the documentation, check out the changelog and commitlog, etc.
38
39### Notes to extension developers
40
411. The `TTYtter_VERSION`, `TTYtter_PATCH_VERSION` and `TTYtter_RC_NUMBER` variables are now `oysttyer_VERSION`, `oysttyer_PATCH_VERSION` and `oysttyer_RC_NUMBER`.
422. User-agent string has changed to `oysttyer/$oysttyer_VERSION`.
43
44## Recommendations
45
46I strongly suggest, although it is by no means compulsory, tracking @oysttyer and #oysttyer as that way you become connected to a global support network.
47
48Also, check out some available extensions:
49
50* [oysttyer-profile](https://github.com/oysttyer/oysttyer-profile) update your profile information from within oysttyer
51* [oysttyer-deshortify](https://github.com/oysttyer/oysttyer-deshortify) gets rid of shortlinks and displays final URLs
52* [oysttyer-multigeo](https://github.com/oysttyer/oysttyer-multigeo) for all your geographical location needs
53
54