Mibew/emoji-plugin
1
0
Fork 0
mirror of https://github.com/Mibew/emoji-plugin.git synced 2025-10-31 10:31:06 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity
Emojis in messages for everyone!
16 Commits 1 Branch 2 Tags 32 KiB
PHP 51.9%
JavaScript 39.5%
CSS 8.6%
ae85a1914e
Go to file
Dmitriy Simushev ae85a1914e Use "pageAdd*" events from the Events class
2014-10-20 08:36:26 +00:00
css Initial commit 2014-09-17 13:24:13 +00:00
js Add "ignore_emoticons" option 2014-09-26 09:58:30 +00:00
.bowerrc Rename "componets" directory to "vendor" 2014-10-16 09:47:31 +00:00
.gitignore Rename "componets" directory to "vendor" 2014-10-16 09:47:31 +00:00
bower.json Move bower dependencies away from dev section 2014-10-16 10:07:20 +00:00
gulpfile.js Rename "componets" directory to "vendor" 2014-10-16 09:47:31 +00:00
LICENSE Initial commit 2014-09-17 13:24:13 +00:00
package.json Update npm modules version 2014-10-16 10:38:12 +00:00
Plugin.php Use "pageAdd*" events from the Events class 2014-10-20 08:36:26 +00:00
README.md Add "ignore_emoticons" option 2014-09-26 09:58:30 +00:00

README.md

Mibew Emoji plugin

It replaces emojis codes with images in chat messages. The full list of supported emojis can be found at http://www.emoji-cheat-sheet.com/

Emoticons like :-) and ;D are also supported.

Installation

  1. Get the archive with the plugin sources. At the moment the only option is to build the plugin from sources.
  2. Untar/unzip the plugin's archive.
  3. Put files of the plugins to the <Mibew root>/plugins folder.
  4. Add plugins definition to "plugins" structure in "<Mibew root>/configs/config.yml". If the "plugins" stucture looks like plugins: [] it will become:
plugins:
    -
        name: "Mibew:Emoji"
        config: # Plugin's configurations are described below
            ignore_emoticons: false

Plugin's configurations

The plugin can be configured with values in "<Mibew root>/configs/config.yml" file.

config.ignore_emoticons

Type: Boolean

Default: false

If set to true, the plugin only converts :emoji: and ignore emoticons like :-) and ;D. This value is optional and can be skipped.

Build from sources

There are several actions one should do before use the latest version of the plugin from the repository:

  1. Obtain a copy of the repository using git clone, download button, or another way.
  2. Install node.js and npm.
  3. Install Gulp.
  4. Install npm dependencies using npm install.
  5. Run Gulp to build the sources using gulp default.

Finally .tar.gz and .zip archives of the ready-to-use Plugin will be available in release directory.

License

Apache License 2.0