Skip to content

Latest commit

 

History

History
52 lines (36 loc) · 2.62 KB

README.md

File metadata and controls

52 lines (36 loc) · 2.62 KB

Zalgolize

npm status build status dependency status coverage status

H̸̡̪̯ͨ͊̽̅̾̎Ȩ̬̩̾͛ͪ̈́̀́͘ ̶̧̨̱̹̭̯ͧ̾ͬC̷̙̲̝͖ͭ̏ͥͮ͟Oͮ͏̮̪̝͍M̲̖͊̒ͪͩͬ̚̚͜Ȇ̴̟̟͙̞ͩ͌͝S̨̥̫͎̭ͯ̿̔̀ͅ.

This is a uniform-clustered zalgolizer. It picks up to a specified number of symbols from each subarray of souls at uniform randomness (with probability p), or picks from it no symbols at all (with probability 1-p).

The probability lets you specify how clustered you want the symbols (p=1 ⇒ completely uniform distribution, p=0.5 ⇒ on average half the letters get nothing, the rest are uniformly distributed)

The different soul types contain symbols that go above, in the middle of, or underneath the text respectively.

Some examples

var zalgo = require('zalgolize');
zalgo('default zalgolization'); // p=.2, maxPicks = [5, 3, 5]
'd̠̤̟̰efauḻt z͂̈al̊̚g͈oli̷za̪͉t̽̅i̘̪̫̼on'

zalgo('less clustered zalgolization', 0.7, [2, 1, 2]);
'l̠̇es̞̏s ̌cl̟usṯer͑eͦd ̲z̮̅aḻ̽g̞o̮l͉̉iza̐t̄iͅỏ͖n͖'

zalgo('intense, clustered zalgolization', 0.2, [10, 5, 10])
'i̛̩͖̤̯̮͠ͅn̷͟t͢en̝͎͇͙̭sͧͤͨ̓͗̾e͑̐ͫ̒ͨ̓ͮ̏̑, c̓lů͚̺̦̰̪͓͐ͯ̈ster͍̤͖͗͌̇ͨͦͥ̚é͜d̨̡͘͞ za̋ͬͫlgͧ̏ͧ̃ͫͭͯ̈̆ol̲͕̳͓͍̯̠i̢͢z̙ation͡'

A windows command line is impenetrable by zalgo and will display question marks instead.

Finally, if you would like to sanitize / attempt to exorcise such a string, you can take the difference with the characters available via the exported souls function. Note, due to quirk with handling these characters in javascript, this may prove very difficult.

CLI

Simple command line usage is available if you globally install the module:

zalgolize we are in the beam
w̫̠ȇͭ̆̒͛ are ̷̨̰̃̆͐̾̅i͐̅̓n ̨͡the̪ͥ̍͑ ͫ̑̄b̫̲̙͕eam
cat README | zalgolize
cowsay -f sodomized-sheep $(lsb_release -ds) | zalgolize -p 0.1 | lolcat

More information is available on the man page.

License

MIT-Licensed. See LICENSE file for details.