¶ Avatar Cache Configuration
This page explains the configuration options for the Avatar Cache system in STN Studios plugins.
The configuration file is located at plugins/DeluxeAnnounce/avatarCache.yml.
Note: After modifying this file, run
/acs clearcachein the server console or in-game to apply the changes.
¶ CACHE Section
- EXPIRATION-MINUTES (Long, default: 30)
Duration in minutes that cached avatars are kept before being refreshed automatically.
⚠️ Details:- This value is in minutes and determines how long all avatars stored in the cache are kept from the first time the cache is called.
- When the time expires, the cache will be cleared, and new avatars will be downloaded and stored again.
- Adjust this value based on how long players typically stay on your server. For example, if most players stay less than an hour, 30 minutes is a reasonable default.
EXPIRATION-MINUTES: 30
- MAXIMUM-SIZE (Integer, default: 1000)
Maximum number of avatars stored in the cache. Oldest entries are removed when this limit is exceeded.
⚠️ Details:- By default, 1000 avatars are stored, which does not use much RAM.
- This is a good value for large servers.
- You can adjust it according to your needs, but it is not recommended to change it unless you know what you are doing.
MAXIMUM-SIZE: 1000
¶ HTTP Section
-
CALL-TIMEOUT (Integer, seconds, default: 3)
Maximum time for an HTTP request to complete. -
CONNECT-TIMEOUT (Integer, seconds, default: 2)
Maximum time to establish a connection with the avatar server. -
READ-TIMEOUT (Integer, seconds, default: 2)
Maximum time to wait for a response after connecting.
¶ Re-download - Settings
¶ FILE LIMIT IN FOLDER (Integer, default: 300)
Determines the maximum number of avatar files allowed in the downloaded folder before cleanup occurs.
⚠️ Details:
- If the number of files exceeds this limit, older files will be deleted during the next cleanup or server restart.
- Helps prevent performance issues caused by too many cached images.
FILE-LIMIT-IN-FOLDER: 300
¶ PRELOAD THE IMAGES (Boolean, default: true)
Preloads all avatars in the images and downloaded folders into memory asynchronously when the plugin starts.
✅ Recommendation: Leave this as true for better performance and faster avatar display.
⚠️ Details:
This is linked to FILE-LIMIT-IN-FOLDER: only the images within the allowed limit are preloaded.
Preloading ensures avatars are available immediately without waiting for them to download during gameplay.
Does not block the server thread, as it runs asynchronously.
PRELOAD-THE-IMAGES: true
¶ FORCE-RE-DOWNLOAD (Boolean, default: false)
If true, avatars will be re-downloaded from the web even if they are already cached.
⚠️ Recommendation: Leave this as false (default).
¶ Behavior:
-
true→ Forces the avatar to be downloaded every time, regardless of whether it is already in the cache.- Useful if you want the latest skin to be applied immediately on every login.
- ⚠️ Warning: Setting this to
truemay duplicate events when players join the server because Deluxe Announce triggers its own avatar event. - Additionally, if using the latest version of SkinsRestorer, it also calls the
SkinApplyEventwhen a player joins, which can further duplicate actions and increase server load. - Be careful: this increases network requests and can put more load on the server.
-
false→ The avatar will only be downloaded if it is not present in the cache.- If the avatar already exists in cache, it will be used directly.
- ⚠️ If the avatar exists as a file but is not in cache because the cache expired or the cache reached its maximum size, the avatar will be downloaded again and added back into the cache.
- Once cached, it will remain until the cache expires (for example, every 30 minutes) or until the maximum cache size is reached (1000 images by default).
- This is more efficient, prevents duplicated events, and reduces unnecessary web requests.
Note: After changing this value in the configuration, run
/acs clearcacheto apply changes immediately.
FORCE-RE-DOWNLOAD: false
¶ RE DOWNLOAD THE IMAGE WHEN USING THE SKIN COMMAND (Boolean, default: true)
If true, avatars are re-downloaded specifically when the /skin command is executed, regardless of cache.
✅ Recommendation: Leave this as true so that when a player changes their skin using the command, the new skin is downloaded immediately and displayed correctly.
RE-DOWNLOAD-THE-IMAGE-WHEN-USING-THE-SKIN-COMMAND: true
¶ How to Apply Changes
- Save the
avatarCache.ymlfile. - Run
/acs clearcacheto reload the cache and apply changes.
⚠️ Failing to run
/acs clearcachemay prevent changes from taking effect.
¶ Tips
- Balance CACHE values with server RAM.
- Use reasonable HTTP timeouts to avoid delays.
- Use RE-DOWNLOAD options carefully to avoid high network usage.