Emoji is the ultimate collection of smileys and emoticons from Emoji Cheat Sheet for Grav.

About

Emoji is the ultimate of collection smileys and emoticons used for various famous applications like Github made available via the Emoji Cheat Sheet project. It includes more than 880 smileys and emotiocns, each one having its own textual representation as can been seen in the official Emoji Cheat Sheet.

Installation

To install this data pack, just download the zip version of this repository and unzip it under user/data/smileys. Then, rename the folder to emoji.

You should now have all the data pack files under

user/data/smileys/emoji

NOTE: This data pack is a modular component for Grav Smileys Plugin which requires Grav, Grav Smileys Plugin and a theme to be installed in order to operate.

Usage

To activate and use Emoji the best process is to copy the smileys.yaml file from the Grav Smileys Plugin into your users/config/plugins/ folder (create it if it doesn't exist), and set the smileys package option to

pack: emoji

You can then use any of the below smiley acronyms in your pages and Grav Smileys Plugin will automatically convert them to their icon graphic file equivalent. As an example

I love you :heart:

will then transform to

I love you ❤️

Contents

By default Emoji supports all smileys from the Emoji cheat sheet (e.g. ❤️ and 😃). It comes pre-configured with each smiley entry having the format

<your-smiley-file-without-extension>:
  enabled: true | false
  acronyms: "<your space separated acronyms e.g. :-) :)>"
  description: "<your description>"

In other words, smilies can be disabled separately by setting enabled: false or modified by setting your own description and/or smiley acronyms.

Contributing

You can contribute at any time! Before opening any issue, please search for existing issues and review the guidelines for contributing.

After that please note:

• If you find a bug, would like to make a feature request or suggest an improvement, please open a new issue. If you have any interesting ideas for additions to the syntax please do suggest them as well!
• Feature requests are more likely to get attention if you include a clearly described use case.
• If you wish to submit a pull request, please make again sure that your request match the guidelines for contributing and that you keep track of adding unit tests for any new or changed functionality.

If you directly want to contribute an addition to Emoji, be it a new smiley/emoticon or a package for an IM client, please open an issue on the original page https://github.com/arvida/emoji-cheat-sheet.com

Support and donations

If you like my project, feel free to support me via or by sending me some bitcoins to 1HQdy5aBzNKNvqspiLvcmzigCq7doGfLM4.

Thanks!

License

Copyright (c) 2015 Benjamin Regler. See also the list of contributors who participated in this project.

1. Grav Smileys Data Pack - Emoji is dual-licensed for use under the terms of the MIT or GPLv3 licenses.

   

2. Emoji (https://github.com/arvida/emoji-cheat-sheet.com) is licensed by their respective owners:

   • octocat, squirrel, shipit -- Copyright (c) 2012 GitHub Inc. All rights reserved.
   • bowtie -- Copyright (c) 2012 37signals, LLC. All rights reserved.
   • neckbeard -- Copyright (c) 2012 Jamie Dihiansan. Creative Commons Attribution 3.0 Unported
   • feelsgood, finnadie, goberserk, godmode, hurtrealbad, rage 1-4, suspect -- Copyright (c) 2012 id Software. All rights reserved.
   • trollface -- Copyright (c) 2012 whynne@deviantart. All rights reserved.
   • All other emoji images -- Copyright (c) 2012 Apple Inc. All rights reserved.