README

   1 This is a collection of filters to do all sorts of strange things to text.
   2 B1ff, the Swedish Chef, and an eleet filter are included.
   3
   4 Since the original versions of some of these filters have copyright
   5 problems, I have done a "clean room" re-implementation of the original lex
   6 filters in perl. I did this without looking at the original code to the
   7 filters at all, I simply observed their output and drew my own conclusions,
   8 and wrote my own code. Then I compared the output of the original and new
   9 filters when ran on large bodies of text, and fixed the things I had
  10 missed.
  11
  12 Here are the results of my investigations of how the filters work:
  13
  14 eleet:
  15         This is the simplest filter to figure out. The letters a-z of
  16         the alphabet are replaced with the following letters:
  17                 4 b c d 3 f g h 1 j |< l /\/\ /\/ 0 p q r 5 + u \/ \/\/ >< y z
  18         Note that the equivalent translation is done on upper-case letters.
  19
  20 fudd:
  21
  22         This one is trivial too. A few transpositions happen differently if
  23         the letter is at the end of the word or not, and I think I found
  24         all the transpositions with only a few paragraphs of sample output.
  25         The only weird thing is that 'n.' is changed to "n, uh-hah-hah-hah."
  26         (Works well with sentances ending in "gun." ..)
  27
  28 chef:
  29         Personally my favorite filter. This took a bit of work to figure
  30         out, and I doubt I have everything correct. Note that due to a bug
  31         or an odd feature of the original program, it doesn't seem to think
  32         that the first letter of the first word is really the first letter
  33         of a word and so some of the words below don't trigger for that first
  34         word. I did not emulate this behavior because I think it's probably a
  35         bug.
  36
  37         The word "bork" is never changed, no matter what any of these
  38         rules may say. Neither is "Bork".
  39
  40         The following translations only happen to letters that are the first
  41         letter of a word of at least 2 letters in size:
  42                 o -> oo
  43                 O -> Oo
  44
  45         These happen to letters that are not the last letter of a word:
  46                 a -> e
  47                 A -> e
  48
  49         These translations only happen if the letter is not the first letter
  50         of a word:
  51                 f -> ff
  52                 i -> ee (but only the first `i' per word)
  53                 o -> u
  54                 u -> oo
  55
  56         These translations always happen:
  57                 v -> f
  58                 V -> F
  59                 w -> v
  60                 W -> V
  61                 an -> un
  62                 An -> Un
  63                 au -> oo
  64                 Au -> Oo
  65
  66         Any occurrence of "e" at the end of a word is changed to "e-a".
  67
  68         Any occurrence of "e" and the beginning of a word is changed to "i".
  69         Same with capitals.
  70
  71         Any occurrence of "the" is changed to "zee", any occurrence of
  72         "The", to "Zee".
  73
  74         Any occurrence of "tion" in a word, to "shun".
  75
  76         Any "th" at the end of a word is changed to "t".
  77
  78         Any "en" at the end of a word is changed to "ee".
  79
  80         Any "ow" at the end of a word is changed to "oo".
  81
  82         And of course, after any `.', `?', or `!' that is at the end of a
  83         line, the Chef prints out a new line, and then the famous
  84         "Bork Bork Bork!", and then another newline.
  85
  86         Known bugs in this implementation:
  87                 - says "frunch", not "french".
  88                 - still quite buggy in general.
  89
  90 b1ff:
  91         Unlike the other filters, b1ff does not try to be an exact duplicate
  92         of its predecessor.
  93
  94         After upper-casing everything, b1ff does some word and sub-word
  95         substitutions, most of them misspellings.
  96
  97         B1ff also changes punctuation - All commas become periods; all
  98         semicolons, commas. Question and exclamation marks are changed to
  99         things like "!!!!1!" and "?!?!?!". It looks like the original filter
 100         decided how long a sequence to print based on the text input before
 101         the end of sentence. I took a simpler route and just randomized it.
 102
 103 Written by Joey Hess <joey@kitenet.net>