Skip to content

Commit 22d23a2

Browse files
author
Legitimoose
committed
add more pictures to README.md
1 parent 33eefcd commit 22d23a2

File tree

3 files changed

+7
-5
lines changed

3 files changed

+7
-5
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,12 @@
11
# EmojiTab
2-
32
<img src="images/EmojiTab-banner.gif" alt="EmojiTab banner" width="400"/>
43

54
A Paper plugin to add emoji shortcodes to Minecraft, with tab completion. :thumbsup:
65

76
Here's a demo of the plugin in action:<br>
87
![Demo](images/EmojiTab-demo.gif)
98

10-
119
## Table of Contents
12-
1310
- [Background](#background)
1411
- [How does it work?](#how-does-it-work)
1512
- [Installation](#installation)
@@ -28,6 +25,8 @@ The players all appear to have no name, and have a gray skin to blend in with th
2825

2926
To keep these fake players from appearing above _real_ players they are added to a fake scoreboard team called ``zzzzzzzzz_emoji_tab``.
3027

28+
<img src="images/player-list.png" alt="Player list full of gray blank players" width="500"/>
29+
3130
#### Compatibility
3231
EmojiTab should be compatible with all other chat/player list plugins. This is because everything is sent via packets, so none of the players/teams exist on the server. You'll notice that if you run ``/team list``, the team for sorting does not show up. On the backend, this means even if a player is looking at a custom plugin scoreboard, the team's sorting will still be in effect. If you run into any compatibility issues with other plugins, let me know!
3332

@@ -53,6 +52,8 @@ This plugin depends on [ProtocolLib](https://ci.dmulloy2.net/job/ProtocolLib/) f
5352

5453
``/emoji`` - Shortcut for ``/emoji list``
5554

55+
<img src="images/hover-event.png" alt="Screenshot showing /emoji" width="250"/>
56+
5657
### Config
5758
EmojiTab has two config files. ``config.yml`` is for plugin-wide configuration settings. ``emojis.yml`` is where you define your own emojis.
5859

@@ -88,6 +89,8 @@ By default, ``emojis.yml`` is populated with [many of the characters](https://mi
8889
An emoji can be one character ``βš”`` or multiple ``(γƒŽΰ² η›Šΰ² )γƒŽε½‘β”»β”β”»``. Custom characters can be added using a resource pack with a custom font.
8990
9091
``name`` is what you type in chat to make the emoji appear. ``aliases`` is any number of alternate names for the same emoji.
92+
93+
NOTE: The combined length of ``name`` and ``emoji-wrapping`` (found in config.yml) cannot exceed 16 characters. This is a hard limit in Minecraft, and any emoji shortcodes longer than 16 characters will be truncated (you'll get a warning in the console, too.)
9194
```yaml
9295
emojis:
9396
βš”:
@@ -206,8 +209,7 @@ emojis:
206209
name: check_box
207210
(γƒŽΰ² η›Šΰ² )γƒŽε½‘β”»β”β”»:
208211
name: table_flip
209-
210212
```
211213
212214
## Contributing
213-
PRs welcome! If you have any questions, you can usually find me in my [Discord server](https://discord.gg/6d6RBxAkMx).
215+
PRs welcome! The source code is pretty well documented. If you have any questions, you can usually find me in my [Discord server](https://discord.gg/6d6RBxAkMx).

β€Žimages/hover-event.pngβ€Ž

26.1 KB
Loading

β€Žimages/player-list.pngβ€Ž

418 KB
Loading

0 commit comments

Comments
Β (0)