Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jsumners/alfred-emoji

Alfred workflow for searching and copying emoji
https://github.com/jsumners/alfred-emoji

Last synced: 3 days ago
JSON representation

Alfred workflow for searching and copying emoji

Awesome Lists containing this project

README

        

# alfred-emoji

[![Build Status](https://travis-ci.org/jsumners/alfred-emoji.svg?branch=master)](https://travis-ci.org/jsumners/alfred-emoji)

An [Alfred workflow][alfred] that makes it easy to search for emoji and copy
them to the clipboard ๐Ÿค˜.

![screenshot](images/screenshot.png)

> ## Note About Available Emoji
>
> The workflow is built against the latest available macOS within the GitHub
> continuous integration infrastructure. This means some emoji may be missing
> until the GitHub infrastructure is updated. It also means that some emoji
> may be present in the workflow that do not exist on your system if your
> system is running an earlier version of macOS.
>
> If this is not desired, follow the instructions below for generating the
> workflow on your own system.

## Installing the Workflow

[Download the provided Alfred workflow][releases].

Notice: This workflow relies on JXA (JavaScript for Automation) that is built
into macOS.

## Usage

```
emoji [query]
```

Press return (โ†ต): **Copy the symbol** of the selected emoji (e.g. ๐Ÿคฃ) to
your clipboard.

Press alt+return (โŒฅโ†ต): **Copy the code** of the selected emoji)
(e.g. `:rofl:`) to your clipboard.

Press ctrl+return (โŒƒโ†ต): **Copy the codepoint** **of** the selected emoji)
(e.g. `U+1F923`) to your clipboard.

Press shift+return (โ‡งโ†ต): **Copy the default symbol** of the selected emoji)
(e.g. ๐Ÿคฃ) to your clipboard without skin tone modifier.

Press cmd+return (โŒ˜โ†ต): **Paste the symbol** of the selected
emoji (e.g. ๐Ÿคฃ) directly to your frontmost application.

### Set skin tone

To change the emoji skin tone for supported emoji set the `skin_tone` environment variable in Alfred:

![screenshot skin tone settings](images/screenshot-skin-tone-setting.png)

Options:
- No value => ๐Ÿ‘
- `0` => ๐Ÿ‘๐Ÿป
- `1` => ๐Ÿ‘๐Ÿผ
- `2` => ๐Ÿ‘๐Ÿฝ
- `3` => ๐Ÿ‘๐Ÿพ
- `4` => ๐Ÿ‘๐Ÿฟ
- `random` => ๐Ÿ‘๐Ÿป | ๐Ÿ‘๐Ÿผ | ๐Ÿ‘๐Ÿฝ | ๐Ÿ‘๐Ÿพ | ๐Ÿ‘๐Ÿฟ

After setting skin tone you can still quickly copy the default emoji with the shift modifier.

## Automatic Updates

This workflow will automatically check for updates at most once per day. If a
new release is found, it automatically downloads and installs the latest
version of the workflow. All downloads come directly from official [GitHub
releases][releases].

## Optional Hotkey and Snippet Triggers

Trigger the workflow with either a custom hotkey or a custom snippet.

## Building the Workflow

1. Clone this repository
2. `npm install`
3. `npm run build`

## Loading the Workflow into Alfred

1. `npm run load`

## Inspiration

This is based on the original work by [Carlos Galdino][carlos]. His project
seems to be unmaintained (some emoji don't copy and some newer are missing).
Whereas his project is based on the Ruby language, this one is based on
JavaScript.

## Other

* [Associated Alfred Forum Post][alfredforum]
* [Emoji Keyword Library][emojilib]

## License

[MIT License](http://jsumners.mit-license.org/)

[alfred]: https://alfredapp.com/
[carlos]: https://github.com/carlosgaldino/alfred-emoji-workflow/
[releases]: https://github.com/jsumners/alfred-emoji/releases
[alfredforum]: https://www.alfredforum.com/topic/11126-alfred-emoji-search-emojis-by-name-or-keyword/
[emojilib]: https://github.com/muan/emojilib