/// SUPPORTED THIRD-PARTY PLUGIN

Image Library

Free guide for configuring this third-party plugin in the Hub. To install it, use its plugin page or official source.

Version: 2.0.67
Framework: oxide
Main file: oxide/config/ImageLibrary.json

Configure →Plugin page →Official source ↗

Prepare your file

Check the installed version
This guide describes Image Library 2.0.67. Use the same version in the configurator.
Get the settings
Click Import, then From my server. Select the files and confirm loading them. Selecting a server does not replace the open document. You can also import files from this device or a configuration from My projects.
Edit and send
Adjust settings, fix errors, then use Send to transfer files to the selected server. A conflict blocks sending until you choose how to resolve it. You can still export only the files you need.

Server transfers have private backups. Save keeps your work in My projects; it does not send anything to the server. A download also lets you resume without a server connection.

Settings for this version

General 6

Store player avatars: On / off · required
Download and retain Steam avatars for plugins requesting them. A Steam API key is required; without it, no avatars are fetched. Enabling this increases external requests and stored images.
JSON path
Avatars - Store player avatars
Steam API key: Text · required
Steam Web API key used for Workshop skin and avatar lookups. Treat it as a secret.
JSON path
Steam API key (get one here https://steamcommunity.com/dev/apikey)
Item icon base URL: Text · required
Change the source of item icons supplied to other plugins. Image Library appends the item short name and .png to this address: keep the trailing /. An unavailable source can prevent icons from displaying.
JSON path
URL to web folder containing all item icons
Show download progress: On / off · required
Print image load progress to the server console.
JSON path
Progress - Show download progress in console
Progress update interval: Whole number · required
Space out image-storage progress messages in the console, in seconds. This does not slow downloads; it only applies when progress logging is enabled.
JSON path
Progress - Time between update notifications
User images: JSON value · required
Preload named images that other plugins can retrieve from Image Library. Each name maps to a direct image address; empty entries are ignored. Review external destinations before adding a large list.
JSON path
User Images - Manually define images to be loaded

Configuration version 3

Major version: Whole number · required
Internal configuration format marker. Keep the value supplied for this plugin version.
JSON path
Version → Major
Minor version: Whole number · required
Internal configuration format marker. Keep the value supplied for this plugin version.
JSON path
Version → Minor
Patch version: Whole number · required
Internal configuration format marker. Keep the value supplied for this plugin version.
JSON path
Version → Patch

Plugin instructions

Image Library 2.0.67

Image Library downloads and stores images for other Rust plugins. It has no required plugin dependency, but it is commonly installed because another plugin depends on its API. Run it on Oxide.

Configuration

Avatars - Store player avatars enables avatar downloads; this increases external requests and stored image data.
Steam API key (get one here https://steamcommunity.com/dev/apikey) enables Steam Workshop skin and avatar lookups. Keep the key private and do not include a real key in shared examples.
URL to web folder containing all item icons selects the item-icon source. An unavailable or untrusted endpoint can break or replace downloaded imagery.
Progress - Show download progress in console controls progress logging. Progress - Time between update notifications controls its interval; very frequent reporting may add console noise.
User Images - Manually define images to be loaded is a dynamic name-to-URL map. It stays lossless in JSON; every entry can cause a remote download, so review destinations and list size.
Version.Major, Version.Minor, and Version.Patch are maintained by the plugin. Leave them at 2.0.67; older markers may trigger migration and replacement of settings.

Target file: oxide/config/ImageLibrary.json. Image data files and download queues are outside this configuration bundle.

Install the files

With a connected server, click Send in the configurator. The result shows whether the files were sent and the plugin reloaded. Without RCON, reload the plugin from your server panel after sending.

Without a connected server: Keep a copy of the current files. Place each export in the folder shown before export, or follow the paths in the ZIP. Do not put data or translation files in the config folder.

Follow the plugin instructions above for dependencies and reloading. Exporting does not connect the site to your server.

Configuration and transfer guide →