diff options
| author | Tom Feist <shabble@metavore.org> | 2011-09-23 03:27:15 +0000 | 
|---|---|---|
| committer | Tom Feist <shabble@metavore.org> | 2011-09-23 03:27:15 +0000 | 
| commit | d338bbdff4ab176ff6be6a3a53d2eb7b8f79ec4b (patch) | |
| tree | 4831f01e2c024e94408ff9f1a84075e6e02cb88d | |
| parent | Actually really truly fixed the urls this time. Honest. (diff) | |
| download | irssi-scripts-d338bbdff4ab176ff6be6a3a53d2eb7b8f79ec4b.tar.gz irssi-scripts-d338bbdff4ab176ff6be6a3a53d2eb7b8f79ec4b.zip | |
If these links don't work I'm going to move to the country and live in the woods.
Diffstat (limited to '')
| -rw-r--r-- | README.md | 167 | 
1 files changed, 87 insertions, 80 deletions
| @@ -1,7 +1,7 @@  # Shabble's Irssi Scripts -This repository contains a collection of scripts I have written or adapted from -others to improve my (and your!) irssi using experience. +This repository contains a collection of scripts and things I have written or +adapted from others to improve my (and maybe your!) Irssi using experience.  ## What's In Here @@ -11,104 +11,111 @@ each their own repository as might be sensible, they're all stuffed in here.  The following is a brief list of the interesting scripts, and why you might want  to use them. -* [`auto-server/`](tree/master/auto-server) -- provides a `/join+` command -  which allows you to join channels on servers to which you're not currently -  connected, as long as you've got everything set up correctly in your +* [`auto-server/`](irssi-scripts/tree/master/auto-server) -- provides a `/join+` +  command which allows you to join channels on servers to which you're not +  currently connected, as long as you've got everything set up correctly in your    `/channels` and `/networks` config. -* [`history-search/`](tree/master/history-search) -- an improved version of -  [@coekie](/coekie/irssi-scripts/blob/master/history_search.pl)'s original -  history_search, it behaves a lot more like the standard Readline incremental -  search over your recent command history. +* [`history-search/`](irssi-scripts/tree/master/history-search) -- an improved +  version of [@coekie](/coekie/irssi-scripts/blob/master/history_search.pl)'s +  original history_search, it behaves a lot more like the standard Readline +  incremental search over your recent command history. -* [`ido-mode/`](tree/master/ido-mode) -- A window switching mode best described -  as "The bastard lovechild of emacs ido-mode and window_switcher.pl".  It -  supports flexible matching of channel names, filtering by active windows, +* [`ido-mode/`](irssi-scripts/tree/master/ido-mode) -- A window switching mode +  best described as "The bastard lovechild of Emacs +  [ido-mode](http://www.emacswiki.org/emacs/InteractivelyDoThings) and +  [window_switcher.pl](http://scripts.irssi.org/html/window_switcher.pl.html)". +  It supports flexible matching of channel names, filtering by active windows,    servers, and more. See the script comments for details. -* [`feature-tests/`](tree/master/feature-tests) has a bunch of different little -  scripts written to test certain aspects of Irssi behaviour.  None of them are -  likely to be particularly useful unless you're looking for simple examples of -  various things on which to build.  Some of the ones which might actually be -  useful are: - - * [`key_test.pl`](tree/master/feature-tests/key_test.pl) - decodes and prints -   keyboard inputs from the `gui key pressed` signal.  Useful for checking what -   keycode a particular combo generates. - - * [`template.pl`](tree/master/feature-tests/template.pl) - A basic outline of a -   script to use as a starting point for others. - - * [`pipes.pl`](tree/master/feature-tests/pipes.pl) A barebones template for a -   script which uses forking and pipes to handle async tasks in the background -   without hanging Irssi. -   -* [`modules/`](tree/master/modules) contains a few half-baked attempts at -  loadable modules for Irssi, none of which do very much at the moment.  They -  might be useful as templates for your own modules, however. -   -* [`no-key-modes/`](tree/master/no-key-modes) provides an additional expando -  `$M_nopass` which you can add to your theme to provide channel modes, but -  without showing the channel key.  This is probably less useful since someone -  pointed me at `/set chanmode_expando_strip` which has much the same effect. -   -* [`patches/`](tree/master/patches) contains a few patches for the irssi -  source, probably out of date by now, which do various things. The easiest way -  to figure out what is to read them, unless I get bored and document them -  sometime. -   -* [`prompt_info/`](tree/master/prompt_info) was the original "How can I put -  dynamic status crap into my prompt string" script.  This has since been -  superceded by the far nicer `uberprompt.pl` which also lives in that dir. +* [`feature-tests/`](irssi-scripts/tree/master/feature-tests) has a bunch of +  different little scripts written to test certain aspects of Irssi behaviour. +  None of them are likely to be particularly useful unless you're looking for +  simple examples of various things on which to build.  Some of the ones which +  might actually be useful are: + + * [`key_test.pl`](irssi-scripts/tree/master/feature-tests/key_test.pl) - +   decodes and prints keyboard inputs from the `gui key pressed` signal.  Useful +   for checking what keycode a particular combo generates. + + * [`template.pl`](irssi-scripts/tree/master/feature-tests/template.pl) - A +   basic outline of a script to use as a starting point for others. + + * [`pipes.pl`](irssi-scripts/tree/master/feature-tests/pipes.pl) A barebones +   template for a script which uses forking and pipes to handle async tasks in +   the background without hanging Irssi. +   +* [`modules/`](irssi-scripts/tree/master/modules) contains a few half-baked +  attempts at loadable modules for Irssi, none of which do very much at the +  moment.  They might be useful as templates for your own modules, however. +   +* [`no-key-modes/`](irssi-scripts/tree/master/no-key-modes) provides an +  additional expando `$M_nopass` which you can add to your theme to provide +  channel modes, but without showing the channel key.  This is probably less +  useful since someone pointed me at `/set chanmode_expando_strip` which has +  much the same effect. +   +* [`patches/`](irssi-scripts/tree/master/patches) contains a few patches for the +  irssi source, probably out of date by now, which do various things. The +  easiest way to figure out what is to read them, unless I get bored and +  document them sometime. +   +* [`prompt_info/`](irssi-scripts/tree/master/prompt_info) was the original "How +  can I put dynamic status crap into my prompt string" script.  This has since +  been superceded by the far nicer `uberprompt.pl` which also lives in that dir.    Many of my other scripts require uberprompt as a way to provide part of their    user interface. -* [`sb-position/`](tree/master/sb-position) gives you an additional status bar -  item which indicates approximately how far you are scrolled in a given window -  buffer, in terms of pages and percentage.  It is configurable as the comments -  in the script explain. +* [`sb-position/`](irssi-scripts/tree/master/sb-position) gives you an +  additional status bar item which indicates approximately how far you are +  scrolled in a given window buffer, in terms of pages and percentage.  It is +  configurable as the comments in the script explain. -* [`scrolled-reminder/`](tree/master/scrolled-reminder) is a script that tries -  to prevent one of the more common accidental IRC screwups -- replying to a -  conversation that happened hours ago because you didn't notice you were -  scrolled up in the history buffer.  If you try to send a message whilst -  scrolled, it'll warn you and check you really want to first. +* [`scrolled-reminder/`](irssi-scripts/tree/master/scrolled-reminder) is a +  script that tries to prevent one of the more common accidental IRC screwups -- +  replying to a conversation that happened hours ago because you didn't notice +  you were scrolled up in the history buffer.  If you try to send a message +  whilst scrolled, it'll warn you and check you really want to first. -* [`quit-notify/`](tree/master/quit-notify) is based on a script by -  vague@#irssi/Freenode.  It is most useful when you are ignoring +* [`quit-notify/`](irssi-scripts/tree/master/quit-notify) is based on a script +  by vague@#irssi/Freenode.  It is most useful when you are ignoring    joins/parts/quits from a channel, and hence don't realise when the person you    are responding to has left.  If they have (or if you prefix your message with    a nonexistent nick), the script will ask you to confirm that you want to send    the message, much like `scrolled_reminder`. -* [`undo/`](tree/master/undo) contains 2 scripts, `undo.pl` and +* [`undo/`](irssi-scripts/tree/master/undo) contains 2 scripts, `undo.pl` and    `kill-ring.pl`. See their header for further documentation. + +  *Still undergoing heavy development, and not really ready for public usage.* + -* [`testing/`](tree/master/testing) is a Perl framework external to Irssi (ie: -  not a script) that will ultimately allow you to write unit tests for your -  scripts, and run them in a real irssi instance, and check that they behave -  correctly.   +* [`testing/`](irssi-scripts/tree/master/testing) is a Perl framework external +  to Irssi (ie: not a script) that will ultimately allow you to write unit tests +  for your scripts, and run them in a real irssi instance, and check that they +  behave correctly.    *Still undergoing heavy development, and not really ready for public usage.* -* [`throttled-autojoin/`](tree/master/throttled-autojoin) doesn't work. It's -  meant to allow people with huuuuuuge numbers of autojoin channels and servers -  to connect slowly, so as not to time themselves out when reconnecting. Mostly -  dead. +* [`throttled-autojoin/`](irssi-scripts/tree/master/throttled-autojoin) doesn't +  work. It's meant to allow people with huuuuuuge numbers of autojoin channels +  and servers to connect slowly, so as not to time themselves out when +  reconnecting. Mostly dead. -* [`tinyurl-tabcomplete/`](tree/master/tinyurl-tabcomplete) is a script which -  lets you hit tab following anything that looks like a URL to replace it with a -  tinyurl'd version.  Handy if you regularly paste Google-maps links or other -  massive horrible links. +* [`tinyurl-tabcomplete/`](irssi-scripts/tree/master/tinyurl-tabcomplete) is a +  script which lets you hit tab following anything that looks like a URL to +  replace it with a tinyurl'd version.  Handy if you regularly paste Google-maps +  links or other massive horrible links. -* [`url_hilight/`](tree/master/url_hilight) I can't remember what this one -  does. Suggestions & ideas welcome. +* [`url_hilight/`](irssi-scripts/tree/master/url_hilight) I can't remember what +  this one does. Suggestions & ideas welcome. -* [`vim-mode/`](tree/master/vim-mode) The most exciting (and by far the -  largest) script here. Gives vim-addicted users a way to use most of their -  finger-memory in Irssi.  Still under active development, features and -  bug-requests welcome.  Also supported in #irssi_vim on Freenode. +* [`vim-mode/`](irssi-scripts/tree/master/vim-mode) The most exciting (and by +  far the largest) script here. Gives vim-addicted users a way to use most of +  their finger-memory in Irssi.  Still under active development, features and +  bug-requests welcome.  Also supported in +  [#irssi_vim on Freenode](irc://irc.freenode.org/#irssi_vim).  ## Documentation @@ -126,7 +133,7 @@ file, and will probably refuse to load without it.  ## Reminders for myself  *Not for public consumption. This section contains text known to the State of -California to cause madness, rabies, or other reproductive harm.* +California to cause madness, rabies, or reproductive harm.*  ### Todo Lists @@ -139,14 +146,14 @@ reminder. I'll go create an issue for it Right Now!  {-append, -remove} $param $value`. Bit like a general purpose version of  [`hide.pl`](http://scripts.irssi.org/html/hide.pl.html) -* Finish work on [`foreach-guard`](tree/master/foreach-guard) +* Finish work on [`foreach-guard`](irssi-scripts/tree/master/foreach-guard) -* Finish (Well, start) something in [`colour-popup`](tree/master/colour-popup) +* Finish (Well, start) something in [`colour-popup`](irssi-scripts/tree/master/colour-popup)   to make an actual popup  * Revisit some of the cracked-out ideas for colour/format overlays -* Go back and clean up [`irssi-vim`](tree/master/irssi-vim) like I promised to +* Go back and clean up [`irssi-vim`](irssi-scripts/tree/master/irssi-vim) like I promised to    everyone ages and ages ago. Also do the features thing.  * Actually fix all the [issues](https://github.com/shabble/irssi-scripts/issues) | 
