Image Library

Über Image Library

Die Image Library ist ein Plugin, das andere Plugins nutzen können, um Bilder für die Benutzeroberfläche zu speichern und zu verwalten.
Allein hat das Plugin keinen praktischen Nutzen.

Installation

Füg das Plugin in den Order Plugins ein, dieser wird gefunden unter oxide\plugins oder carbon\plugins
Download: Image Library

Konsolenbefehle

• refreshallimages: Ruft alle Item-Symbol-URLs ab (einschließlich Workshop-Bilder) und speichert sie. Wenn die Konfiguration "Images - Nur herunterladen, wenn erforderlich" auf true gesetzt ist, werden auch alle Icons in der Dateispeicherung heruntergeladen.
• cancelstorage: Beendet alle ausstehenden Datei-Downloads.

Konfiguration

Die Einstellungen und Optionen können in der ImageLibrary-Datei im Konfigurationsverzeichnis angepasst werden. Zur Vermeidung von Formatierungsproblemen und Syntaxfehlern wird die Verwendung eines Editors und Validierers empfohlen.

{
  "Avatars - Store player avatars": true,
  "Steam API key (get one here https://steamcommunity.com/dev/apikey)": "",
  "Progress - Show download progress in console": true,
  "Progress - Time between update notifications": 20,
  "User Images - Manually define images to be loaded": {},
  "Version": {
    "Major": 2,
    "Minor": 0,
    "Patch": 47
  }
}

Konfigurationsoptionen

• "Avatare - Spieleravatare speichern": Lädt Spieleravatarbilder herunter (einige Plugins benötigen dies).
• "Fortschritt - Downloadfortschritt in Konsole anzeigen": Zeigt den Fortschritt der Ladeaufträge in der Konsole an.
• "Fortschritt - Zeit zwischen Update-Benachrichtigungen": Zeitintervall zwischen Fortschrittsaktualisierungen.
• "Benutzerbilder - Manuell festgelegte Bilder zum Laden": Benutzerdefinierte Bilder, die heruntergeladen werden sollen (einige Plugins benötigen dies).
• "Steam API Schlüssel (hier erhältlich: https://steamcommunity.com/dev/apikey)": Erforderlich für den Download von Skin-Bildern aus dem Workshop.

Setup und Unterstützung für genehmigte und Workshop-Skins
Um Zugriff auf genehmigte und Steam Workshop Skin-Icons zu ermöglichen, muss ein gültiger API-Schlüssel bereitgestellt werden. Diese Schlüssel sind an dein Steam-Konto gebunden und haben ein Limit von 100.000 API-Aufrufen pro Tag.
Um deinen Steam API-Schlüssel zu erhalten, besuche -> https://steamcommunity.com/dev/apikey

Kopiere und füge deinen Steam API-Schlüssel in das entsprechende Feld in deiner Konfiguration ein.

Entwickler-API

• AddImage(string url, string imageName, ulong imageId, Action callback = null): Fügt ein einzelnes Bild über eine URL hinzu (erstellt keine Ladeanforderung).
• AddImageData(string imageName, byte[] array, ulong imageId, Action callback = null): Fügt das Bild mit Rohbilddaten in einem byte[] der Dateispeicherung hinzu (erstellt keine Ladeanforderung).
• ForceFullDownload(string title): Erzwingt den Download aller verfügbaren Bilder (nicht empfohlen).
• GetImage(string imageName, ulong imageId = 0, bool returnUrl = false): Ruft die ID eines gespeicherten Bildes ab. Wenn "returnUrl" auf true gesetzt ist, gibt das Plugin die URL des Bildes zurück, falls es noch nicht gespeichert wurde.
• GetImageList(string name): Gibt eine Liste der verfügbaren Skin-IDs für das angeforderte Element zurück.
• GetSkinInfo(string name, ulong id): Gibt die Skin-Daten für Workshop-Elemente zurück.
• HasImage(string imageName, ulong imageId): Gibt true zurück, wenn das angegebene Bild in der Speicherung vorhanden ist.
• IsReady(): Gibt true zurück, wenn keine ausstehenden Ladeaufträge vorhanden sind.
• ImportImageList(string title, Dictionary<string, string> imageList, ulong imageId = 0, bool replace = false, Action callback = null): Erstellt eine neue Ladeanforderung und lädt eine Liste von Bildern herunter.
• ImportImageData(string title, Dictionary<string, byte[]> imageList, ulong imageId = 0, bool replace = false, Action callback = null): Ähnlich wie oben, jedoch zum Massenimport von Rohbilddaten in einem byte[].
• LoadImageList(string title, List<KeyValuePair<string, ulong>> imageList, Action callback = null): Lädt fehlende Item-Icons aus der angegebenen Liste.

Hinweis: Die Methoden zum Importieren und Laden von Bildern unterstützen einen optionalen Callback-Parameter, der eine Funktion aufruft, wenn der Ladevorgang abgeschlossen ist.

Importieren von Workshop-Skins aus deinem Plugin

Der Import von Skins aus dem Workshop erfolgt durch Aufruf der Methode "LoadImageList". Diese Methode findet und lädt Item-Icons für dein Plugin. LoadImageList durchsucht die Liste der bereitgestellten Item-Skin-IDs und übermittelt alle, die noch nicht vom Spiel implementiert wurden, an die Steam API, um das Icon zu finden.

Diese Methode sollte mit einem spezifizierten Callback aufgerufen werden. Dein Plugin sollte NICHT aktiviert werden, bevor dieser Callback aufgerufen wurde!

Für ein Beispiel zur Verwendung dieser Methode siehe ServerRewards.

Was ist eine Ladeanforderung?

Eine Ladeanforderung ist eine Reihe von Bildern, die ein Plugin zum Herunterladen anfordert.
Zum Beispiel erstellt ServerRewards bei der Generierung der Benutzeroberfläche eine Ladeanforderung, die das Herunterladen jedes Icons im Geschäft verlangt.
Alle Item-Icons, die noch nicht gespeichert wurden, werden in dieser Ladeanforderung zur Verarbeitung in die Warteschlange gestellt.
Der Benutzer kann dann den Fortschritt dieser Ladeanforderung über RCon in der Konsole verfolgen.
Dadurch werden lange Warteschlangen von Elementen in kleinere Kategorien aufgeteilt, um die Optimierung zu verbessern und doppelte Bild-Downloads zu verhindern.

Plugin
https://umod.org/plugins/image-library

Angaben erfolgen ohne Gewähr auf Vollständigkeit, Richtigkeit und Aktualität.
Original-Tutorial des Plugins Image Library von k1lly0u