RUST Image Library v2.0.62

Image Library is a tool that other plugins can utilise to store and manage imagery for use in UI. On its own it serves no real purpose.

Console Commands​

refreshallimages - Retrieve's and stores all item icon URLs (include's workshop images). Will also download every icon to file storage if the config option "Images - Only download image's when required" is set to true

cancelstorage - This will cancel any pending file downloads

Configuration​

The settings and options can be configured in the ImageLibrary file under the config directory. The use of an editor and validator is recommended to avoid formatting issues and syntax errors.

Configuration Options​

"Avatars - Store player avatars": Downloads player's avatars image's (some plugins may require this)
"Progress - Show download progress in console": This option will show you progress of load orders in console
"Progress - Time between update notifications": The amount of time between progress updates
"User Images - Manually define images to be loaded": User specified images to be downloaded (some plugins may require this)
"Steam API key (get one here

Please, Log in or Register to view URLs content!

)": This is required to download skin images from the workshop

Setup Approved and Workshop skin support​

For ImageLibrary to be able to access approved and Steam Workshop skin icons you must provide a valid API key. These keys are registered to your Steam account and have a limit of 100,000 API calls per day.

To get your Steam API key visit ->

Once you have your Steam API key, copy and paste it in to the "Steam API key" entry in your config

Developer API​

Note: Image importing/loading methods have a optional callback parameter which will invoke a function when the load is complete

Importing Workshop Skins From Your Plugin​

Importing skins from the workshop can be done by calling the "LoadImageList" method.

This method is specifically designed to find and download item icons for your plugin. LoadImageList will sort through the list of item skin ID's you provide it, and any that are not already implemented by the game will be passed to Steams API to try and find the icon.

This method should be called with a callback specified and your plugin should NOT be enabled until that callback has been invoked!

For an example of using this method see ServerRewards

WTF is a load order?​

A load order is a set of images that a plugin requests to be downloaded. For example, in ServerRewards when the UI is being generated it creates a load order that requests every item in the store has its icon downloaded. Any of the item icons that have not yet been stored will be queued for processing in that load order. The user will then be able to view the progress of that load order in console via RCon. This breaks up mega queue lists of items into smaller categories for better optimisation and prevents doubling up on image downloads