feat: add README.md

2026-05-07 14:34:48 +02:00
1 changed files with 7 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,7 @@
+# Custom Server Icons for Velocity Hostnames
+## Usage:
+- Launch proxy with the plugin once so the data directory gets created or create the directory `custom-server-icon` in the `plugins` folder manually
+- Put server icons as png with 64x64 pixels size into the data directory.
+- Rename the icons to `<hostname>.png` example: `mc.leohabrom.com.png`.
+- The forced hosts should now display their custom icons accordingly.
+- To reload the icons from the directory without restarting, use the command `/reload-icons`