coldsunera / sockbot-emoji

Emoji plugin for SockBot

#SockBot Emoji

Emoji plugin for SockBot version 2.11.0 or later; automatically replaces Unicode emoji with Discourse emoji in a user's posts.

##Usage

No special syntax is required; simply post as normal.

##Developers

SockBot Emoji is developed by SockDrawer developer RaceProUK.

##Installation

The preferred method of installation is via NPM; simply run this command within the SockBot installation folder:

npm install sockbot-emoji

Other methods of installation are possible e.g. cloning the git repository, but only installation via NPM is supported.

###Post Install Setup

If you installed via NPM skip this step as NPM has already installed all necessary dependencies. Otherwise you will need to run the following command in the folder where you installed SockBot Emoji:

npm install

##Configuration

SockBot Emoji requires no special configuration; all that is needed is a single line in the SockBot configuration file.

YAML example:

---
core:
  username: username
  password: password
  owner: owner
plugins:
  sockbot-emoji: true

JSON example:

{
  "core": {
    "username": "username",
    "password": "password",
    "owner": "owner"
  },
  "plugins": {
    "sockbot-emoji": true
  }
}

Note that these examples assume an NPM-based installation; other installation methods may require the path to Emoji.js (without file extension) be specified explicitly.

YAML example:

---
core:
  username: username
  password: password
  owner: owner
plugins:
  '../path/to/Emoji': true

JSON example:

{
  "core": {
    "username": "username",
    "password": "password",
    "owner": "owner"
  },
  "plugins": {
    "../path/to/Emoji": true
  }
}

##Special Thanks

For creating SockBot and just generally being awesome: Accalia de Elementia