PawPub

User Tools

Site Tools

You are here: PawPub documentation » Semi-official extensions » Custom Emojis (very rough draft)
extension:custom-emojis

Table of Contents

Custom Emojis (very rough draft)

The Custom Emojis extension allows users to create and publish “emoji packs,” which are sets of small images that can then be included inline in notes (- and other locations??? bio, display name?). Emoji packs and the emojis contained within are identified by a globally unique ID (what kind? uuid?? does it even need this???) along with the usual object URI, allowing them to be cloned to multiple instances if desired without duplication (though this is not necessary, and a user from any instance can use emojis from any other instance).

Schema for emoji packs

These are extension objects.

  • type: “extension”
  • self: uri required
  • extension: “https://pawpub.entities.org.uk/extension/custom-emojis”
  • packId: string required1)
  • name: string required
  • description: string required
  • creator: uri(actor) required2)
  • created: timestamp required
  • modified: timestamp optional
  • originalUri: uri(extension) optional3)
  • icon: string optional4)
  • emojis: array(object) required
    • shortcode: string required5)
    • description: string optional6)
    • href: uri required [URI to the image]
    • keywords: array(string) optional default=[]7)

Schema for inline emojis in notes

TODO

1)
Must not be changed when cloning the pack
2)
Even if the pack has been cloned this should still refer to the original creator
3)
Used to specify where the pack originally came from, if it was cloned
4)
Refers to the shortcode of one of the emojis in the pack, to be used as an icon or thumbnail for the pack itself. If unset, an arbitrary emoji from the pack should be chosen.
5)
Should be human readable but quicker to type than the description
6)
Used as a text alternative when the image cannot be displayed
7)
Alternative names that may be typed in to search for this emoji, for example if the shortcode was “fox_sad” the keywords might include “unhappy”, “cry”, etc.
extension/custom-emojis.txt · Last modified: by winter