stow/oh-my-zsh/.oh-my-zsh/plugins/emotty/README.md

   1 # emotty plugin
   2
   3 This plugin returns an emoji for the current $TTY number so it can be used
   4 in a prompt.
   5
   6 To use it, add emotty to the plugins array in your zshrc file:
   7 ```
   8 plugins=(... emotty)
   9 ```
  10
  11 **NOTE:** it requires the [emoji plugin](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/emoji).
  12
  13 ## Usage
  14
  15 The function `emotty` displays an emoji from the current character set (default: `emoji`), based
  16 on the number associated to the `$TTY`.
  17
  18 There are different sets of emoji characters available, to choose a different
  19 set, set `$emotty_set` to the name of the set you would like to use, e.g.:
  20 ```
  21 emotty_set=nature
  22 ```
  23
  24 ### Character Sets
  25
  26 - emoji
  27 - loral
  28 - love
  29 - nature
  30 - stellar
  31 - zodiac
  32
  33 Use the `display_emotty` function to list the emojis in the current character set, or
  34 the character set passed as the first argument. For example:
  35
  36 ```
  37 $ display_emotty zodiac
  38 <list of all the emojis in the zodiac character set>
  39 ```