/// SUPPORTED THIRD-PARTY PLUGIN

Image Library

Free guide for configuring this third-party plugin in the Hub. Install the plugin separately from its official source.

Version: 2.0.65
Framework: oxide
Target file: oxide/config/ImageLibrary.json

Open configurator →View configuration page →View the official source ↗

Prepare your file

Check the installed version
This guide describes Image Library 2.0.65. Use the same version in the configurator.
Import your configuration
Open the configurator and import your current JSON. For a new installation, you can start from the provided example.
Edit and download
Adjust the settings, fix reported errors, and download the JSON. Keep a copy of your old file before replacing it.

Your configuration is not saved on the site. Keep the exported file; you can import it again later.

Settings for this version

General 6

Store player avatars: On / off · required
Download and store player avatar 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
Base web folder used to retrieve item icons.
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
Time between console progress notifications.
JSON path
Progress - Time between update notifications
User images: JSON value · required
Associate each image name with its source URL. Names already present in an imported file are preserved.
JSON path
User Images - Manually define images to be loaded

Configuration version 3

Major: Whole number · required
Internal configuration format marker. Keep the value supplied for this plugin version.
JSON path
Version → Major
Minor: Whole number · required
Internal configuration format marker. Keep the value supplied for this plugin version.
JSON path
Version → Minor
Patch: 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.65

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.65; 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 file

After keeping a copy of the previous file, place the exported JSON at this location on your server:

oxide/config/ImageLibrary.json

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