https://github.com/mineinabyss/emojy

Custom Emote plugin by @Boy0000
https://github.com/mineinabyss/emojy

papermc

Last synced: 3 months ago
JSON representation

Custom Emote plugin by @Boy0000

• Host: GitHub
• URL: https://github.com/mineinabyss/emojy
• Owner: MineInAbyss
• License: mit
• Created: 2022-10-04T21:49:38.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2025-04-19T19:34:56.000Z (about 1 year ago)
• Last Synced: 2025-04-19T21:27:46.342Z (about 1 year ago)
• Topics: papermc
• Language: Kotlin
• Homepage:
• Size: 432 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          


# Emojy

[![Java CI with Gradle](https://github.com/MineInAbyss/Emojy/actions/workflows/gradle-ci.yml/badge.svg)](https://github.com/MineInAbyss/Chatty/actions/workflows/gradle-ci.yml)

[![Maven](https://img.shields.io/maven-metadata/v?metadataUrl=https://repo.mineinabyss.com/releases/com/mineinabyss/emojy/maven-metadata.xml)](https://repo.mineinabyss.com/#/releases/com/mineinabyss/chatty)

[![Wiki](https://img.shields.io/badge/-Project%20Wiki-blueviolet?logo=Wikipedia&labelColor=gray)](https://github.com/MineInAbyss/Emojy/wiki)

[![Contribute](https://shields.io/badge/Contribute-e57be5?logo=github%20sponsors&style=flat&logoColor=white)](https://github.com/MineInAbyss/MineInAbyss/wiki/Setup-and-Contribution-Guide)



## Overview

Emojy is a plugin that lets you make custom emotes and gifs to use just about anywhere.\

It works by replacing `:id:` with the assigned unicode.\

Compared to a lot of other plugins this does not purely rely on the default font.\

This will prevent players from simply copying unicodes and spamming them in chat.

__Small feature-list:__

- Replace `:id:` in chat, books, signs, inventory titles, tablist, titles, subtitles & actionbars

- Support for GIFs with 2 different types:

  * **Obfuscation**: This is done by having every gif be its own font, but it has the downside of being in random order and way too fast

  * **Shader**: This is done by a core-shader which should show the GIF as normal 

- Automatically split gifs into images depending on specified framecount

- Automatically generate a resourcepack with all the emotes and gifs

Whilst this is primarily for emojis and gifs, it is also a useful tool for everything else related to unicodes.\

For example it lets you easily make custom menus which can be put in titles simply by doing `:id:`

## Requirements

- [Idofront Platform](https://github.com/MineInAbyss/Idofront)

## Recommended Plugins

- [Chatty](https://github.com/MineInAbyss/Chatty) - Highly customizable chat plugin with optional support for 1.19 Chat Signing

## Setup

1. Download the latest version of Emojy

2. Put it in `server/plugins` and start your server

3. Add your emotes to `emotes.yml` and gifs to `gifs.yml`, the bare minimum it needs is the `id: emoteid`

4. Add all your emote textures inside `/plugins/Emojy/textures` and gifs inside `/plugins/Emojy/gifs`

5. Restart your server or run `/emojy reload` to reload the config

6. Copy the generated resourcepack from `/plugins/Emojy/pack.zip` to your resourcepack folder