Jinx/velocity-custom-server-icon
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

feat: add README.md

Browse Source
This commit is contained in:
Leo
2026-05-07 14:34:48 +02:00
parent ee7e3909f3
commit 6ae2334ffa
1 changed files with 7 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md Normal file
View File

@@ -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`