warpling / Macmoji

Slack/GitHub/Trello emoji for your mac! 😁 💥 💻
MIT License
1.72k stars 71 forks source link

How Macmoji works 😁

Installing Macmoji: as easy as 🔢

Psst! Upgrading from a previous version of Macmoji? Read this first.

  1. Download emojiSubstitutions.plist (make sure it has the extension .plist)
  2. Open System Preferences and navigate to Keyboard > Text
  3. Drag the emojiSubstitutions.plist to the list of substitutions to add them
  4. Type something like :boom: or :blackbox: and hit Space after! 💥⬛️

Gif instructions:

How to "install" Macmoji

Other Installations

Thanks to the fantastic work of rael9 Macmoji now has a script for generating other template files (Maestro, Alfred, etc) from the latest emoji substitutions list. If you add emoji substitutions to the base .plist simply run python2 scripts/update-output.py (python3 will fail) from the scripts directory and the various outputs based on the templates in templates/* will be generated and placed in the base directory. Creating new templates is easy and highly encouraged!

Keyboard Maestro Version

If you'd prefer to use Keyboard Maestro to handle the substitutions, import the emojis-km6.kmmacros file in the Keyboard Maestro Editor.

(This macro was created and tested using version 6. It has not been tested with other versions.)

Alfred Version

If you'd prefer to import these shortcuts with Alfred as Snippets just drag the .alfredsnippets into Alfred's Snippet preferences!

Install Script (Deprecated)

There used to be a CLI for installing Macmoji but it was brittle and tended to break with every other Mac OS version. I wasn't able to get it working for Big Sur and the drag/drop installation still works quite well so that is the only way to install it at this time!

FAQ

🤔 Can I change/remove substitutions?

Yep! Macmoji substitutions are ordinary text substitutions. Double click an entry to change it; highlight and hit delete to remove it. To highlight multiple substitutions select one and then while holding Shift select another. You can always add your own too of course!

Some fun recommendations:

replace with
ehh ¯\_(ツ)_/¯
tflip (╯°□°)╯︵ ┻━┻
eml your@email.com

💩 Why the colons?

Well it's what Slack/GitHub/Trello does and it prevents macOS's autocomplete from being too aggressive when you're just trying to type normal sentences like, "ghost bananas are cool." 👻🍌🆒

🖐🏽 What about skin tones?

Type your skin-tonable emoji, then type :skin-tone-3: (any number 1-5) to add the skintone. They should combine!

😱 I have suggestions and mistakes to point out!

Let me know in the issues orrr file a pull request!

😯 Can I back-up or share my substitutions?

Yep! Highlight and drag out the ones you want to back-up or share and you'll get a neat little .plist. Drag them back in and only the unique ones will be added.

Known Problems

😫 Macmoji isn't working in Chrome

Yeah it's a bummer. Chrome bypasses the system's autocomplete (and a few other things), but a passable work around is to open Spotlight (Cmd + Space) type your emojis there, copy, paste, and you're good to go! 👍

😫 The substitutions are showing up on my iPhone in weird ways…

Keyboard text substitutions sync across iCloud. I haven't found a way to disable it short of removing the substitutions and iOS seems to ignore colons 🤕. I will update this if I learn of a solution.

😠 Sometimes it just stops working in some applications

No clue. Beats me. Have a hunch why? I'd love to hear it!

Change Log

Looking to update to the latest release? The best way to update is to remove all previously added substitutions, then drag in the .plist again (hold Shift to select all the colon clad substitutions). Tip: You can always back-up substitutions by selecting and dragging them out of the list!

Date Commit Changes
May 18th, 2021 998d55e ❤️‍🔥😶‍🌫️😵‍💫😮‍💨 Add iOS 14.5 Emojis (Thanks camlloyd!)
May 18th, 2021 23f4301 Changed plist to use camelCase, and updated README
May 18th, 2019 6cdb706 Changed underscores to hyphens
April 25th, 2019 6dca474 ♾️ Add a few missing emoji
April 9, 2019 22884a5 🇨🇳🇧🇷🇦🇺 Add country flags
November 16, 2018 3ce4c43 🤯🧠🦅 Add Unicode 9.0-11.0 emoji (Huge thanks to camlloyd)
March 12, 2017 9bcbb39 🎩 Add Alfred snippets. (Thanks valrus!)
July 15, 2016 9bcbb39 🤖 Add templating script and Keyboard Maestro version!
July 12, 2016 2872b66 📞☎️ Add shortcut for call, and telephone
July 11, 2016 781926c Added Keyboard Maestro macro version.
July 8, 2016 e7225c2 🐴🍷🙎🖖 Add shortcut for mustang, wine, pouting, and spock.
July 8, 2016 2f84c61 ⚽⚾️⛄⛅ Fix mismatched shortcuts for soccer, baseball, snowman, and partially_sunny.