SimpleCrossChat Plugin - Technical Documentation
Overview:
SimpleCrossChat is an advanced cross-server communication plugin for Minecraft servers running Spigot 1.21. It uses MQTT brokers to broadcast global chat messages, enabling seamless communication across multiple servers.
Key Technical Features:
- Cross-Server Communication: Utilizes MQTT protocols to send global chat messages between servers.
- Lightweight Messaging: Efficient messaging system designed to minimize server load.
- Customizable Configuration: Fine-tune server names, broker settings, and message formats in the `options.yml` file.
- Flexible Broker Options: Use public brokers like `test.mosquitto.org` (default) or host your own for enhanced security.
- Encryption: Messages are encrypted using `AES/CBC/PKCS5Padding` for basic security, but private brokers are recommended for secure communication.
Setup Instructions:
1.
Install the plugin:
Place the SimpleCrossChat JAR file in your server's
plugins folder.
2.
Restart your server:
The plugin will initialize automatically with default settings.
3.
Configure the plugin (optional):
Open the `options.yml` file located in the `plugins/simplecrosschat` folder.
Update the following fields: name, format, broker, id and key!
4.
Restart/Reload the server: Apply your configuration changes.
Important Technical Notes:
-
No Channels: All global chat messages are sent to the broker and distributed to all connected servers. Messages could be intercepted on public brokers, so private hosting is recommended.
-
Default Broker: The plugin uses `test.mosquitto.org` as a default broker, which is for testing purposes only. It is insecure for long-term use.
-
Encryption Limitations: While the plugin uses encryption, public brokers do not guarantee message privacy. Always opt for private brokers when possible.
-
Message Scope: Only global chat messages are broadcasted. Private messages, commands, and plugin-generated messages are not shared. Ensure players understand this behavior.
Performance Considerations:
- Delays: Global messages may experience slight delays due to broker processing and distribution.
- Load: High message volume can impact server performance, especially when using public brokers.
Disclaimer:
This plugin is provided as-is, and the developer is not liable for any privacy concerns, misuse, or legal implications. Please refer to the latest disclaimer on the
GitHub repository for the most up-to-date information. Server owners are responsible for secure and compliant usage of the plugin.
Ready to enhance communication? Download SimpleCrossChat now!