README.md 937 Bytes
Newer Older
Kirill's avatar
Kirill committed
1
2
3
4
5
6
7
8
9
10
# emotty plugin

This plugin returns an emoji for the current $TTY number so it can be used
in a prompt.

To use it, add emotty to the plugins array in your zshrc file:
```
plugins=(... emotty)
```

11
**NOTE:** it requires the [emoji plugin](https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/emoji).
Kirill's avatar
Kirill committed
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

## Usage

The function `emotty` displays an emoji from the current character set (default: `emoji`), based
on the number associated to the `$TTY`.

There are different sets of emoji characters available, to choose a different
set, set `$emotty_set` to the name of the set you would like to use, e.g.:
```
emotty_set=nature
```

### Character Sets

- emoji
- loral
- love
- nature
- stellar
- zodiac

Use the `display_emotty` function to list the emojis in the current character set, or
the character set passed as the first argument. For example:

```
$ display_emotty zodiac
<list of all the emojis in the zodiac character set>
```