udpClientLED
A RaspberryPi based LED notification for minecraft servers (Java).
This programme works in conjunction with udpServerLED.
It is based on the original piLED plugin and runs identical hardware.
Overview
udpClientLED/udpServerLED is a traffic light based minecraft server notification system using a RaspberryPi. You will need a RaspberryPi which is connected to the physical hardware described in this guide in addition to an external minecraft server. If you are running the minecraft server on the same RaspberryPi then you need the original standalone piLED plugin form the link on the left.
System overview of both parts.
udpServerLED is a standalone java application that runs on a RaspberryPi. udpClientLED runs as a standard Minecraft plugin on your Minecraft server.
The rest of this guide refers to the client side running on the PC which is running the Minecraft server.
How to use
If you are not interested in playing with the code then just download the latest .jar file from the releases link. After downloading, copy it to your minecraft server plugins folder and follow the hardware guide for the raspberryPi part on the udpServerLED link.
Upon first run the plugin will write a config.yml to its subdirectory in your plugins folder. You will need to change the IP address to the one used by your RaspberryPi. This can be done in one of 2 ways.
- Edit the file directly then either restart the server or use the command (must be OP level)
updateUDPConfig
- Use the console command
setUDPIPAddress [IPAdress]
If you want to play with the source code then download the whole project from the links on the left. It was built in Eclipse using the Maven framework.
Detailed configuration
The plugin has 3 parameters that can all be controlled by the either editing the config.yml file or console commands as described below.
- setUDPIPAdress [IPAddress], sets the IP Address of the RasberryPi where the udpServerLED application is running. Default 127.0.0.1. New value will be ignored if not valid for the network. If the target is valid and reachable but not running, the udpServerLED the user will be warned but the parameter will still be set.
- setUDPTimeout [milliseconds], sets length of time the plugin will wait for a reply from a newly defined server before giving up. Default 5000 or 5 seconds. If negative or non-integer the new value will be ignored.
- setUDPShortTimeout [milliseconds], sets length of time the plugin will wait for a reply from a previously known good server. Default 500 or 0.5 seconds. If negative or non-integer the new value will be ignored.
- listUDPConfig, shows current status of 3 parameters above.
- updateUDPConfig, attempts to load new parameters from config.yml after it has been manually edited. If the new parameters are not valid then the the plugin reverts to the previous ones.
It should be noted that restarting the server after manually editing config.yml will have broadly the same effect except that in the case of an error it will revert to the defaults not the last known good value. For this reason it is recommended to either use the console commands to change parameters or use updateUDPConfig if manually editing.
Authors and Contributors
I wrote this, it's my first proper code for well over twenty years (Excel macros notwithstanding) and probably the same for electronics that wasn't work related. Any sugestions for improvements to the code are welcome, contact me on GitHub. It's been fun perhaps with the exception of my woeful attempts to understand Git merges!