-
Notifications
You must be signed in to change notification settings - Fork 12
Add Emojis
Home | Install | Emojis-image | Emojis-text | Add Emojis | Remove Emojis | Permissions | Change Log
Sections: Research | Contributing | Adding A Custom Emoji (Text or Image) | Adding A Collection (Text or Image) | Next Steps
- Before adding an image emoji, please research its origins as much as possible!
- We respect all artists wishes on use of their work. So if they have restrictions that can not be met, it will not be included here!
- If permission must be obtained before using an emoticon/emoji, please do so before submitting it here.
- I understand that most artists don't have the time to answer every message, so please be patient; or make your own and submit it!
- An emoticon/emoji will not be added to this main collection unless there is proof that the artist provides free non-commerical use in a post (see the permissions page), or have them write us, or forward an email from them to "stylishthemes.github" at "gmail.com". We will add that response to the permissions page.
- These instructions explain how to add custom emoji(s) to this main collection.
- Alternatively, you can add your own private collection by adding a "source" to the GitHub Custom Emoji Settings panel (instructions)
To add a text emoji to the existing "custom" collection, follow this pattern:
{
"text": "^\u203f^",
"name": "simple smile"
}- This is the text added when selecting an emoji.
- Ideally, use an escape sequence for special characters:
- One option is to use Google's Closure Compiler.
- Enter the text to convert like this:
var t = "^‿^", then "Compile" it. - Copy and use the resulting string:
var t = "^\u203f^".
-
Do not include the
~prefix.
- This text is used when searching within the autocomplete popup; search using text separated by commas.
- This text is also displayed while exploring the entire collection.
- If you so desire, use case sensitive text; and set the case sensitive option.
To add an image emoji to the existing "custom" collection, follow this pattern:
{
"url": "https://cloud.githubusercontent.com/...",
"labels": "happy cheer woot",
"source": "Name by Author - Source URL",
"license": "?",
"size": "50x50",
"text": "woot"
}A collection of emojis uses the first entry to store metadata. So when adding an emoji to an existing non-"custom" collection, you can use the following pattern. Usually, emojis in a collection fall under the same license, so only include a license entry if needed:
{
"url": "https://cloud.githubusercontent.com/...",
"labels": "collection name woot happy cheer",
"license": "optional, unless it's under a different license",
"name": "collection_name_woot"
}- Content loaded on to GitHub pages must adhere to GitHub's Content Security policy. Due to this limitation, all URLs used by this script must point to the GitHub cloud.
- To upload an image to GitHub's cloud, open any GitHub repository issue, or wiki page. Then drag and drop the emoji in the textarea. Once the upload has completed, it will be replaced by markdown pointing to the image.
- Copy the URL from the markdown into the custom "url" entry.
- For other methods of adding an image, please review the details contained in the GitHub Dark image page.
- Include easy to remember searchable labels.
- Also please include a category similar to the default emojis like "people", "nature", "symbols", "objects", etc.
- Separate each label using a space.
- When a user searches for an emote, only the content in the "labels" is included in the query.
- This is basically an entry to share the original emote name, author and source URL.
- The entry must at least include the source URL to make it easier to track down the its origin, in case the author requests we remove the emote.
- Include a license, if any is found. Otherwise add "?" or "unknown".
- When adding a known license, use the SPDX license identifier.
- Optional. Added for future use.
- This is the text added with the emoji.
-
Do not include the surrounding symbols; neither the
:_prefix nor the:suffix. - If adding emojis as plain text, this will be the name visible to users not using this custom emoji script, e.g.
:_superwoot:. - When adding the emojis as an image, this will be added to the title attribute so this name will be seen upon hovering the emoji.
[{
"name": "Custom Text Emojis",
"type": "text",
"source": "https://ascii.li/emoticons/happy",
"details": "Happy Text Emoticons",
"previewSize": "1em"
},{
"text": "^\u203f^",
"name": "simple smile"
}]- Name to be listed in the Emoji collection popup.
- Spaces are allowed.
- Required option needed to differeniate text from image emojis.
- Optional entry to show the source of the text emoji collection.
- Optional information related to the source of the text emoji.
- This preview size value is used in the collection popup list.
- The reason it is needed is because unicode text needs to be larger to make it easy to see, whereas the custom text emojis don't really need to be enlarged.
- Emoji text to be added to the textarea when a emoji is selected.
- Emoji name or key words used to find a specific emoji.
- The name does not have to be unique, but realize that currently, only 5 results will be shown in the autocomplete popup, so your emoji may not show up.
- Spaces are allowed.
A collection should always have the first entry that describes the collection followed by emoji entries. Extra entries are allowed and usually ignored by the script.
[{
"name" : "Uber Emojis",
"source": "http://uber-site.com/",
"copyright": "optional",
"license": "?"
},{
"url": "https://cloud.githubusercontent.com/assets/...1234.gif",
"labels": "first emoji name label1 label2",
"name": "first_emoji_name"
}]- Name to be listed in the Emoji collection popup.
- Spaces are allowed.
- List the source URL of the emoji collection. Please try to locate the original source, if possible.
- This entry is required in case the original author contacts us and requests we remove the emojis.
-
Copyrights are automatically applied to the artist's work, so if possible or found, please include the copyright.
-
The same goes with the license. If found, please include it.
-
Most of the work found on deviantart.com does not list a license, but you will find this note at the bottom of their emoticons page that sums up things nicely:
NOTE: Emoticons found at or in use by DeviantArt are not freely available for use by other websites. If you would like to use these emoticons or any of the others found at DeviantArt, you must contact the creator of each emoticon desired to obtain permission for use. Failure to obtain permission for off-site use of these emoticons represents a cause of legal action against you for each of the artists whose copyrights have been infringed upon.
-
If the art does have a limitation not allowing the image to be included, do not include it in the collection!
-
I am not a lawyer, so don't sue me bro!
- Content loaded on to GitHub pages must adhere to GitHub's Content Security policy. Due to this limitation, all URLs used by this script must point to the GitHub cloud.
- To upload an image to GitHub's cloud, open any GitHub repository issue, or wiki page. Then drag and drop the emoji in the textarea. Once the upload has completed, it will be replaced by markdown pointing to the image.
- Copy the URL into the custom entry.
- For other methods, please review the details of the GitHub Dark image page.
- Include the emoji name as well as descriptive words for the emoji image.
- These labels can be used while searching for emojis - see the inserting emojis method one section (third item) on the home page for more details.
- Give the emoji a unique name, if the name is not unique, the first named emoji from the loaded sources will be used instead.
- To not include spaces. The autocomplete script will not find the emoji!
- The default names all use an underscrore, but you are welcome to use any separator you desire (except a space).