Emoji

By default, Swarm uses a font to provide Emoji images. Swarm can make use of Emoji images from the Gemoji project. Gemoji provides support for more Emojis and works on more browsers and platforms than the font Swarm normally uses.

Note

By default, Gemoji is only supplied with a small number of custom emojis. For instructions on adding more emojis to Gemoji, see the documentation for the Gemoji project.

Due to licensing issues, Gemoji cannot be distributed with Swarm. You can use the Gemoji images after following these steps:

  1. Download the latest release (currently 3.0.0) of the Gemoji project from their releases page.

  2. Unpack the release archive into SWARM_ROOT/public/vendor.

    After unpacking, you should see a new folder: SWARM_ROOT/public/vendor/gemoji-3.0.0.

    3.0.0 represents the version of Gemoji, which may differ if you downloaded a different or newer release.

    Tip

    By default, Gemoji is stored in the SWARM_ROOT/public/vendor/gemoji directory.

    If the emoji_path configurable has been changed: unpack the Gemoji release archive into the directory specified in the emoji_path configurable. Modify the commands in the following steps to match that directory.

  3. Rename the new folder, default location shown in the example below:

    $ cd SWARM_ROOT/public/vendor
    $ mv gemoji-3.0.0 gemoji

    Replace 3.0.0 in the above command if you have downloaded a different or newer release of Gemoji.

  4. Ensure that the new images are readable.

    $ cd SWARM_ROOT/public/vendor
    $ chmod -R +r gemoji

Swarm detects and uses Gemoji images automatically.