Skip to content

Updating plugin #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
NobleSkye wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Updating plugin #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
75955a4
Update README.md
NobleSkye Dec 18, 2024
e71a22c
Update README.md
NobleSkye Dec 18, 2024
c084467
Update README.md
NobleSkye Dec 18, 2024
3a31040
Update README.md
NobleSkye Dec 18, 2024
b4d8215
Update README.md
NobleSkye Dec 18, 2024
46d8a34
plugin updated 1.21.4 (missing tab complete)
NobleSkye Jun 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
158 changes: 158 additions & 0 deletions README-new.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
# EmojiTab - Minecraft 1.21.4+ Edition

A modern Minecraft Paper plugin that enables emoji tab completion by injecting fake players into the tab list. Players can type emoji shortcodes and press TAB to autocomplete them with actual emoji characters or unicode symbols.

## Features

- **Tab Completion**: Type `:cloud:` and press TAB to get `☁`
- **Unicode Support**: Full support for emoji characters and unicode symbols
- **Custom Emojis**: Add your own custom text shortcuts
- **Permissions**: Optional permission-based access control
- **Individual Permissions**: Grant specific emoji permissions per player
- **Modern Architecture**: Built for Minecraft 1.21.4+ with Paper API
- **ProtocolLib Integration**: Uses packet manipulation for seamless tab completion
- **Configurable**: Extensive configuration options
- **Performance Optimized**: Minimal impact on server performance

## Requirements

- **Minecraft 1.21.4+**
- **Paper Server** (Spigot/Bukkit not supported)
- **ProtocolLib 5.3.0+**
- **Java 21+**

## Installation

1. Download the latest release
2. Install ProtocolLib if not already installed
3. Place the plugin JAR in your `plugins/` folder
4. Restart your server
5. Configure `plugins/EmojiTab/config.yml` and `plugins/EmojiTab/emojis.yml` as needed

## How It Works

The plugin creates fake players in the tab list with names matching emoji shortcodes. When players type a shortcode and press TAB, Minecraft's built-in tab completion suggests these fake player names. The plugin then replaces the shortcodes with actual emoji characters in chat messages.

## Configuration

### config.yml
```yaml
# Character(s) to wrap around emoji shortcodes
emoji-wrapping: ":"

# Require emoji.use permission
use-permissions: false

# Require individual emoji permissions (emoji.use.<name>)
individual-permissions: false

# Show detailed loading info
verbose: false

# Custom skin data from mineskin.org
custom-texture-data: ""
custom-texture-signature: ""
```

### emojis.yml
```yaml
emojis:
😀:
name: grinning
aliases: [smile, happy]
☁:
name: cloud
aliases: cloudy
"[CUSTOM]":
name: custom
aliases: special
```

## Commands

- `/emoji list [page]` - Show available emojis
- `/emoji toggle` - Toggle emoji tab completion for yourself
- `/emoji reload` - Reload plugin configuration (admin)
- `/emoji help` - Show help information

## Permissions

- `emoji.use` - Use emojis in chat (default: true)
- `emoji.admin` - Access admin commands (default: op)
- `emoji.reload` - Reload configuration (default: op)
- `emoji.toggle` - Toggle own emoji display (default: true)
- `emoji.use.<name>` - Use specific emoji (when individual-permissions is enabled)

## Usage Examples

1. Type `:cloud:` and press TAB → Completes to `:cloud:`
2. Send the message → Plugin converts `:cloud:` to `☁` in chat
3. Other players see the emoji character in your message

## Custom Emojis

You can add custom text shortcuts:

```yaml
emojis:
"[ADMIN]":
name: admin
aliases: [staff, mod]
"★":
name: star
aliases: [special, vip]
```

## API for Developers

The plugin provides an API for other plugins to interact with:

```kotlin
// Get the plugin instance
val emojiTab = Bukkit.getPluginManager().getPlugin("EmojiTab") as EmojiTab

// Transform a message with emojis
val transformedMessage = emojiTab.emojifier.emojifyMessage(originalMessage, player)

// Check if player has emojis disabled
val disabled = Settings.getEmojiDisabled(player)
```

## Building from Source

```bash
git clone https://github.com/your-repo/EmojiTab
cd EmojiTab
mvn clean package
```

The compiled JAR will be in the `target/` directory.

## Differences from Original

This version has been completely rewritten for Minecraft 1.21.4+ with the following improvements:

- **Modern Paper API**: Uses latest Paper APIs and Adventure components
- **Updated Dependencies**: ProtocolLib 5.3.0+, Kotlin 2.0+, Java 21+
- **Better Packet Handling**: Updated for 1.21.4 packet changes
- **Improved Performance**: More efficient packet generation and handling
- **Enhanced Commands**: Better command interface with pagination and hover effects
- **Extended Configuration**: More configuration options and emoji definitions
- **Code Quality**: Complete rewrite with better architecture and error handling

## Support

For issues, feature requests, or questions:
- GitHub Issues: [Create an issue](https://github.com/your-repo/EmojiTab/issues)
- Discord: [Your Discord Server](https://discord.gg/your-server)

## License

This project is licensed under the MIT License - see the LICENSE file for details.

## Credits

- Original EmojiTab by Legitimoose
- Updated for 1.21.4+ by [Your Name]
- ProtocolLib by dmulloy2
- Paper Team for the excellent server software
141 changes: 141 additions & 0 deletions pom-new.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>com.github.remynfv</groupId>
<artifactId>EmojiTab</artifactId>
<version>2.0.0</version>
<packaging>jar</packaging>

<name>EmojiTab</name>
<description>A plugin for tab completing emojis and unicode characters!</description>

<properties>
<java.version>21</java.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<kotlin.version>2.0.21</kotlin.version>
<minecraft.version>1.21.4</minecraft.version>
</properties>

<build>
<sourceDirectory>src/main/kotlin</sourceDirectory>
<testSourceDirectory>src/test/kotlin</testSourceDirectory>

<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>3.6.0</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
<configuration>
<createDependencyReducedPom>false</createDependencyReducedPom>
<relocations>
<relocation>
<pattern>kotlin</pattern>
<shadedPattern>com.github.remynfv.emojitab.libs.kotlin</shadedPattern>
</relocation>
</relocations>
</configuration>
</execution>
</executions>
</plugin>

<plugin>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-maven-plugin</artifactId>
<version>${kotlin.version}</version>
<executions>
<execution>
<id>compile</id>
<phase>compile</phase>
<goals>
<goal>compile</goal>
</goals>
</execution>
<execution>
<id>test-compile</id>
<phase>test-compile</phase>
<goals>
<goal>test-compile</goal>
</goals>
</execution>
</executions>
<configuration>
<jvmTarget>21</jvmTarget>
</configuration>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.13.0</version>
<configuration>
<source>${java.version}</source>
<target>${java.version}</target>
</configuration>
</plugin>
</plugins>

<resources>
<resource>
<directory>src/main/resources</directory>
<filtering>true</filtering>
</resource>
</resources>
</build>

<repositories>
<repository>
<id>papermc-repo</id>
<url>https://repo.papermc.io/repository/maven-public/</url>
</repository>
<repository>
<id>sonatype</id>
<url>https://oss.sonatype.org/content/groups/public/</url>
</repository>
<repository>
<id>dmulloy2-repo</id>
<url>https://repo.dmulloy2.net/repository/public/</url>
</repository>
</repositories>

<dependencies>
<!-- Paper API -->
<dependency>
<groupId>io.papermc.paper</groupId>
<artifactId>paper-api</artifactId>
<version>${minecraft.version}-R0.1-SNAPSHOT</version>
<scope>provided</scope>
</dependency>

<!-- ProtocolLib -->
<dependency>
<groupId>com.comphenix.protocol</groupId>
<artifactId>ProtocolLib</artifactId>
<version>5.3.0</version>
<scope>provided</scope>
</dependency>

<!-- Kotlin Standard Library -->
<dependency>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-stdlib</artifactId>
<version>${kotlin.version}</version>
</dependency>

<!-- Kotlin Test -->
<dependency>
<groupId>org.jetbrains.kotlin</groupId>
<artifactId>kotlin-test</artifactId>
<version>${kotlin.version}</version>
<scope>test</scope>
</dependency>
</dependencies>
</project>
Loading