Skip to content

Emoji (emoji)

Browse, search, and send emojis from a remote emoji source (as files / stickers), and view the emoji source's build information.

  • Config key: emoji
  • Source file: cogs/emoji.py

How It Works

On startup (on_ready), the module fetches the emoji list from base_url/emoji.json and caches the list of emoji names for search and autocomplete. When sending an emoji, the image is downloaded by name from base_url/<name> and sent as a file (requests go through the proxy configuration).

Commands

/e — Send an Emoji

Select and send an emoji from the emoji library.

ItemDescription
PermissionEveryone
Parametersname (emoji name, slash command has autocomplete)
  • When typing a slash command, candidates are fuzzy-matched against the current input, returning up to max_results candidates.
  • If the name is not in the library, "Invalid emoji name" is shown.

/emoji info — Emoji Library Info

View the emoji source's build information.

ItemDescription
PermissionEveryone

The returned information includes: build time, whether it was built on CF Pages, Commit ID / branch, emoji count, and the link to the emoji source emoji.json.

/emoji update — Update Emoji Library

Re-fetch the emoji list from the remote source and refresh the cache.

ItemDescription
PermissionAdmin
Audit✅ Recorded (emoji-update)

On success, returns the build time, Commit, and emoji count.

Configuration

yaml
emoji:
  enabled: false
  slash: true
  prefix: true
  base_url: "https://ghimg.siiway.top/emoji"
  max_results: 25
FieldTypeDefaultDescription
enabledboolfalseWhether to enable the emoji module
slashbooltrueWhether to register slash commands
prefixbooltrueWhether to register prefix commands
base_urlstrhttps://ghimg.siiway.top/emojiEmoji source base URL (no trailing /; the directory must contain emoji.json)
max_resultsint25Maximum number of search / autocomplete results (too large may cause call failures)

TIP

Emoji image requests use the top-level proxy configuration. If the remote source is unreachable, sending an emoji returns a fetch error.

Released under the MIT License