Skip to content

Emojis

JDA-Commands supports using emoji aliases for Unicode and application emojis in all places where localization is done implicitly.

This is done after placeholder resolution and localization took place.

JDA-Commands emoji aliases are very similar to the ones used by the discord client. They follow the same format :emoji_name: for both Unicode and application emojis. Setting the skintone like :emoji_name::skin-tone-5: is supported too.

Please note that the emoji aliases are resolved after localization takes place, so you can also use them in your localization messages regardless of the used Localizer!

Escaping the colon :

Normally it shouldn't be necessary to escape the colons in messages (that shouldn't be an emoji alias), but in case any troubles occur you can just prefix it with \ (in java \\) to escape it.

Unicode emojis

If you want to avoid annoying encoding issues with hardcoded Unicode emojis, you can just use the known discord client aliases in JDA-Commands too.

We're using the amazing JEmoji library to resolve Unicode discord aliases. If something doesn't feel right with the used aliases/emojis please reach out to them :)

Example

@Command("example")
public void onCommand(CommandEvent event) {
    event.reply("Hi :smiley:");
}

results in the message Hi 😀 displayed to the user.

Application emojis

Application emojis can be used exactly the same as Unicode emojis in messages with the custom emoji name as the alias. If an application emoji is called the same as a Unicode emoji alias, the application emoji takes precedence.

Warning

JDA-Commands fetches and caches all application emojis upon startup. Therefore, JDA-Commands has to be restarted if changes are made to them.

Example

@Command("example")
public void onCommand(CommandEvent event) {
    event.reply("Hi :my_custom_emoji:");
}

results in the message Hi <you custom emoji here> displayed to the user.

Automatic application emojis registration

Adding application emojis manually in the webinterface is an annoying task, but for your luck JDA-Commands comes with tools to register your emojis automatically upon startup. Please note that we cannot unregister application emojis due to api limits.

Similar to how ClassFinders work, JDA-Commands uses EmojiSources to load your application emojis from different places. Per default there are 3 types of EmojiSources:

If no EmojiSources are set by the user in the JDA-Commands Builder, the resource directory emojis will be searched for application emojis per default.

Example

If your resource directory looks like: 

emojis/
    laughing.gif
    hola.png

then JDA-Commands will register the application emojis "laughting" and "hola" upon startup.

If you want to use custom EmojiSources just take a look here