Custom Emoji

by LouisHong

2,618 installs

alert

animated

chat

clan

custom

emoji

emote

gif

icon

image

message

notification

png

reaction

sound

text

twitch

GitHub ↗

Add custom emoji and animated GIFs to your chat!

Documentation

!icon Custom Emoji

Custom emojis for OSRS.

!plugin-showcase

Getting Started

The plugin does not come with built-in emojis. You have a few options:

Use the built-in GitHub downloader to fetch emoji packs directly (see GitHub Integration below)
Manually download from a known repository on github and install to your emojis folder

Known repositories:

TheLouisHong/custom-emoji-repository - Has a good baseline of commonly used static emoji. [link]
mooncord-emojis/emojis - Has a ton of (1000+) emoji both animated and static. Great option if you aren't picky about what emoji you want to see. [link]

Features

Emoji

The filename becomes the trigger for the emoji. For example, woow.png means typing woow in-game will display that image.

Supported formats: .png, .jpg, .gif

Location: .runelite/emojis/

You can organize emoji in subfolders for easier management.

#### Animated Emoji

!ezgif com-optimize (1)

GIF files are fully supported with frame-by-frame animation:

Animations play in chat messages and above player heads
Original GIF frame timing is preserved (probably)

#### Zero-Width Emoji

!Zerp-width-showcase

Zero-Width emoji are fully supported!

Zero-Width emoji filenames must end with 00. e.g. alert00.gif

Soundoji (Sound Emoji)

The filename becomes the trigger for the soundoji. For example, pipe.wav means pipe in-game will play that audio file.

Supported formats: .wav

Location: .runelite/soundojis/
Volume: Adjustable in plugin settings (0-100)

Sidebar Panel

An explorer-style emoji browser in the RuneLite sidebar that allows the user to configure settings for individual emoji:

#### Header Buttons:

!settings Settings - Open plugin configuration
!github Github - Opens a browser page to this repository
!folder Folder - Shows the ~/.runelite/emojis folder in a file explorer window

#### Navigation Buttons:

!back Back - Navigates to to the previous directory
!refresh Reload - Reload all emoji
!download Download - Fetch GitHub emoji pack
!resize Resize mode - Toggle resize configuration mode

!github GitHub Integration

Download emoji packs directly from GitHub repositories:

1. Open plugin settings !settings

2. Enter a repository in the Repository field using format: owner/repo or owner/repo/tree/branch.

- For example, a github repository with the url of https://github.com/realbillgates/osrs-emojis would instead be entered as realbillgates/osrs-emojis for the default branch or realbillgates/osrs-emojis/tree/large if you wanted to instead use the large branch.

3. Emoji are automatically downloaded and saved to .runelite/emojis/github-pack/

Click the !download download button in the sidebar panel to manually check for updates. The plugin tracks file changes and will sync additions, modifications, and deletions.

Note: Local emoji take priority over GitHub pack emoji. If you have a local emoji with the same trigger name, it will be used instead of the downloaded one.