Usage

Updated a day ago

Using Emojis

Shortcodes

Type a shortcode anywhere you can type text and it'll be replaced with the matching emoji sprite:

:wave:
:thumbsup:
:heart:

Shortcodes match the filename of the emoji PNG, without the extension or unicode suffix.

Pasting Unicode

If an emoji has a Unicode mapping defined in its filename, you can paste it directly from the web or an emoji picker and it'll be converted automatically.


Adding Custom Emojis

Drop any PNG file into the emojis/ folder inside the plugin directory: BepInEx/plugins/RichEmoji/emojis/myemoji.png

You can nest PNGs inside subfolders to keep them organized.

File Naming

Emoji Type Filename format
Basic wave.png
With Unicode mapping wave__1F44B.png
Multi-codepoint (e.g. flags, skin tones) wave_medium__1F44B-1F3FD.png

The __ (double underscore) separates the shortcode name from the Unicode codepoints. Codepoints are separated by - (hyphen). Without a Unicode mapping, the emoji can still be used via shortcode, but it won't respond to pasted Unicode.


Multiplayer

This mod is client-side only. Emojis will be converted to shortcodes wherever possible (e.g. :wave:), so:

  • Players with the mod will see the emoji rendered from their own pack. If they have a matching shortcode, they'll see their version of it, which may look different from yours if they have different emoji images.
  • Players without the mod OR without an emoji matching that shortcode will see the raw shortcode text.

Troubleshooting

Report bugs to r_on on Discord.

My emoji isn't showing up

  • Make sure the filename only contains letters, numbers, hyphens, and underscores before the __ separator
  • Check that the PNG is a valid RGBA image

Pasted Unicode isn't converting

  • The emoji needs a Unicode mapping in its filename (see File Naming above)
  • Some complex emoji sequences (e.g. multi-person skin tone combinations) may not be supported yet (you can report them to me; turns out Unicode emojis are pretty complicated)

Other players see shortcodes instead of emojis

  • They need the mod installed with a matching emoji (you can always share yours)
Pages