Custom Emojis

This page explains how to add custom emojis for your AthenaBot plugin.

---

1. Emoji Folder

Upload your emoji files to: /plugins/<plugin_name>/src/emojis/. Only files in this folder are considered for plugin emoji installation.

ㅤ

2. Required File Format

(!) Only .png files are supported.

Every emoji file name must follow this format: <id>.png

Examples:

• 10001.png
• 902344551.png
• 748203994512.png

ㅤ

3. ID Rules

The <id> part of the file name must follow all of these rules:

• Must be a number.
• Must be greater than 10000.
• Must be unique across all plugins.

If the ID is invalid, the emoji will not be installed.

ㅤ

4. Collision and Overwrite Behavior

(!) Emojis cannot be overwritten.

(!) If your emoji ID matches an emoji ID from another plugin, your emoji will be skipped and not installed.

To avoid collisions with other plugin developers, always use long numeric IDs.

ㅤ

5. Using Your Uploaded Emojis

After uploading your custom emojis, refer to the Emoji API documentation to learn how to use them in embeds, buttons, and messages.

When using the placeholder format %custom_emoji_<number>%, the <number> is the chosen ID from your emoji filename (<id>.png).