seanprashad/slackmoji

Table of Contents

• Sets
  • Blob
  • Blob-Sign
  • Froge
  • Gopha
  • Llama
  • Meow
  • Parrots
  • Party
  • Pokemon
  • Scrabble
  • Shiblob
• Uploading Emoji to Slack
• Contributing New Emoji/Emoji Sets
• Common Errors
• Getting Help
• Credits

Sets

See below for previews from each individual set:

Blob

Blob-Sign

Froge

Froggie

Gopha

Llama

Meow

Parrots

Party

Pokemon

Scrabble

Shiblob

Uploading Emoji to Slack

1. Clone or download this repository to your local machine. If you have downloaded the .zip file, unzip it using a third-party or built-in tool made for extracting archives.

2. Follow one of the options below to begin uploading emoji:

   Option 1: Chrome extension

   1. Open Chrome and browse to:

      chrome://extensions
      

   2. Click on the Load unpacked button and select the extension folder from within this repository

   3. Navigate to $slackWorkspaceURL/customize/emoji, where $slackWorkspaceURL is the URL of the Slack workspace

      Note: 20 emoji will be uploaded per minute - be patient!

      Note: This extension has been adapted from the Neutral Face Emoji Tool and now lives here!

   Option 2: CLI

   1. Install slack-emoji-upload

   2. Get an xoxs-* Slack token following these instructions. (The team/email/password approach doesn't work, but token should)

   3. Stick the token in a variable, to keep it out of your shell history:

      read -s TOKEN $GENERATED_SLACK_TOKEN
      

   4. Change to the directory you want to import emoji from

   5. Run the following command, ensuring to substitute the name of your Slack workspace. The xargs prevents an open-files bug with an upload speed of one emoji every 4 seconds, or 15 per minute (20 max as per Slack rate limits):

      ls -1 | xargs -n 20 slack-emoji-upload -team $YOUR_SLACK_TEAM -token $GENERATED_SLACK_TOKEN -rate-limit 4s
      

Contributing New Emoji/Emoji Sets

Contributions are always welcome! In your pull request, please make sure to do the following:

1. Create a new folder with a name that reflects the theme of the emoji you are adding, or use an existing one if applicable
2. Ensure each emoji is under 100 KB in size and of a .png, .jpg, or .gif extension
3. Ensure that each emoji is prefixed with the theme plus a hyphen, ie. gopha-xxx - this will allow users in Slack to easily search for gopha- and view all emoji for that set
4. Run node generate-readme.js to generate/update README's for all of the newly added emoji!

Getting Help

If you ever have questions or need assistance, please open a GitHub issue best describing the problem!

Common Errors

• Gifs over 100 KB will result in an upload error - use Ezgif.com to resize images under 100 KB
• Emoji which conflict with reserved emoji names will result in a error_bad_name_i18n error

Credits

All emoji were sourced from the following repositories/websites:

• Blob folder: https://blobs.gg
• Gopha folder: https://github.com/tenntenn/gopher-stickers
• Llama folder: https://www.weibo.com/huiro, https://www.deviantart.com/jerikuto
• Meow folder: https://blobs.gg
• Parrots folder: https://github.com/jmhobbs/cultofthepartyparrot.com
• Party folder: https://github.com/aendrew/party-everything
• Pokemon folder: https://blobs.gg
• Scrabble folder: https://slackmojis.com
• Shiblob folder: https://blobs.gg