Skip to content

Usage

Jump to bottom
Stephen White edited this page Sep 11, 2021 · 6 revisions

Usage

Directly using a Content Delivery Network

To access images, it's recommended to use the jsDeliver CDN. For item images, it's as simple as substituting the item ID in the following example.

When an image for the ID doesn't exist, the HTTP GET request will return a 404 error code.

Eaglefire image URL (item ID 4):

https://cdn.jsdelivr.net/gh/SilKsPlugins/UnturnedImages@images/vanilla/items/4.png

Blimp image URL (vehicle ID 189):

https://cdn.jsdelivr.net/gh/SilKsPlugins/UnturnedImages@images/vanilla/vehicles/189.png

Unturned Images Plugin

An OpenMod plugin for Unturned which adds a repository of images available to plugins for usage in UIs.

Purpose

This plugin contains services which other plugins can use to get image URLs for in-game assets. For more information, see the Usage section.

These image URLs can be used in different applications, but mainly in-game UIs.

Configuration

Default configuration (contains comment-based documentation):

# Default repositories for different in-game asset categories.
# If no override specifies a different repository, it will attempt to use the default repository.
DefaultRepositories:
  # The default repository for item images.
  Items: "https://cdn.jsdelivr.net/gh/SilKsPlugins/UnturnedIcons@images/vanilla/items/{ItemId}.png"
  # The default repository for vehicle images.
  Vehicles: "https://cdn.jsdelivr.net/gh/SilKsPlugins/UnturnedIcons@images/vanilla/vehicles/{VehicleId}.png"

# Repository overrides for item images. Simply specify an ID, or list of IDs and their repository.
# Remove the # before lines to uncomment them and have it work with the config.
# Priority is based on which line is first. For example, if all lines below were uncommented,
# the image URL for the item with an ID of 46001 would be https://cdn.jsdelivr.net/gh/SilKsPlugins/UnturnedIcons@images/modded/other2/items/{ItemId}.png
ItemOverrides:
#- Id: 46000 # The ID of the override.
#  Repository: "https://cdn.jsdelivr.net/gh/SilKsPlugins/UnturnedIcons@images/modded/other/items/{ItemId}.png" # The repository of the override.
#- Id: "46001-47000" # A range of IDs can be specified as well. You can specify multiple IDs using ranges. and multiple ranges by separating them with commas (',') or semi-colons (';').
#  Repository: "https://cdn.jsdelivr.net/gh/SilKsPlugins/UnturnedIcons@images/modded/other2/items/{ItemId}.png"
#- Id: "46001-47000;48000-49000;50023" # A range of IDs can be specified as well. You can specify multiple ranges/IDs by separating them with commas (',') or semi-colons (';').
#  Repository: "https://cdn.jsdelivr.net/gh/SilKsPlugins/UnturnedIcons@images/modded/other3/items/{ItemId}.png"

# Repository overrides for vehicle images. Simply specify an ID, or list of IDs and their repository.
# See the comments in the above ItemOverrides config for more information on configuring this.
VehicleOverrides:
#- Id: 46000 # The ID of the override.
#  Repository: "https://cdn.jsdelivr.net/gh/SilKsPlugins/UnturnedIcons@images/modded/other/vehicle/{VehicleId}.png" # The repository of the override.

Usage

Developers can include this plugin library in their plugins simply by adding the package to their project references and ensuring the plugin is installed on their server endpoints.

Install via Microsoft Visual Studio's Package Manager Console:

Install-Package SilK.UnturnedImages

Install via the .NET CLI:

dotnet add package SilK.UnturnedImages

After the plugin's library has been added to your project, you can retrieve one of the following services using dependency-injection:

  • IItemImageDirectoryAsync - An asynchronous item image directory.
  • IItemImageDirectorySync - A synchronous item image directory.
Clone this wiki locally