Compare commits

..

No commits in common. "trunk" and "v0.1.16" have entirely different histories.

3 changed files with 278 additions and 47 deletions

View file

@ -19,14 +19,19 @@ const FFMPEG_BUILDS_URL := "https://github.com/BtbN/FFmpeg-Builds/releases/downl
const CONNECT_POLL_DELAY_MS := 50 const CONNECT_POLL_DELAY_MS := 50
const READ_POLL_DELAY_MS := 10 const READ_POLL_DELAY_MS := 10
const LOG_URL_MAX_LEN := 80 const LOG_URL_MAX_LEN := 80
const SETTING_SECTION := "plugin.artprovider"
const SETTING_ANIMATED_GIFS := "animated_gifs"
const GIF_DEFAULT_FRAME_DELAY_MS := 100
const CACHE_DIR := "images" const CACHE_DIR := "images"
const BANNER_CACHE_DIR := "banners"
const GIF_STATIC_DIR := "gif_static"
@export var use_caching: bool = true @export var use_caching: bool = true
var http_image := HTTPImageFetcher.new() var http_image := HTTPImageFetcher.new()
var _meta_cache_dir := "itch_art" var _meta_cache_dir := "itch_art"
var _enriched_meta: Dictionary = {} var _enriched_meta: Dictionary = {}
var settings_manager := load("res://core/global/settings_manager.tres") as SettingsManager
var _animated_texture_cache: Dictionary = {}
var _last_animated_setting: bool = false
var _focused_animated_texture: AnimatedTexture = null
var layout_map: Dictionary = { var layout_map: Dictionary = {
LAYOUT.GRID_PORTRAIT: "-portrait", LAYOUT.GRID_PORTRAIT: "-portrait",
@ -41,8 +46,7 @@ var _ffmpeg_bin: String = ""
func _init() -> void: func _init() -> void:
super() super()
var globalized := ProjectSettings.globalize_path(BOXART_DIR) DirAccess.make_dir_recursive_absolute(ProjectSettings.globalize_path(BOXART_DIR))
DirAccess.make_dir_recursive_absolute(globalized)
provider_id = "itch" provider_id = "itch"
logger_name = "BoxArtItch" logger_name = "BoxArtItch"
@ -50,23 +54,67 @@ func _init() -> void:
func _ready() -> void: func _ready() -> void:
super() super()
_enriched_meta = _load_enriched_meta() _enriched_meta = _load_enriched_meta()
logger.info("itch.io Art Provider loaded") _last_animated_setting = _is_animated_gifs_enabled()
logger.info("itch.io Art Provider loaded (animated_gifs=%s)" % str(_last_animated_setting))
add_child(http_image) add_child(http_image)
get_viewport().gui_focus_changed.connect(_on_focus_changed)
## Returns whether animated GIF covers are enabled in settings.
func _is_animated_gifs_enabled() -> bool:
return settings_manager.get_value(SETTING_SECTION, SETTING_ANIMATED_GIFS, false) as bool
## Handles focus changes across the UI. Pauses the previously focused
## card's AnimatedTexture and unpauses the newly focused one.
func _on_focus_changed(control: Control) -> void:
# Pause the previously focused animation.
if _focused_animated_texture != null:
if is_instance_valid(_focused_animated_texture):
_focused_animated_texture.pause = true
_focused_animated_texture = null
if control == null:
return
# Walk up the tree to find the GameCard parent.
var card: Control = control
while card != null:
if not is_instance_valid(card):
return
if card is GameCard:
break
card = card.get_parent()
if card == null:
return
# Check if the card's TextureRect has an AnimatedTexture.
var texture_rect := card.get_node_or_null("%TextureRect") as TextureRect
if texture_rect == null:
return
if texture_rect.texture is AnimatedTexture:
_focused_animated_texture = texture_rect.texture as AnimatedTexture
_focused_animated_texture.pause = false
## Strips HTML srcset artifacts from a URL. Butlerd sometimes passes through ## Strips HTML srcset artifacts from a URL. Butlerd sometimes passes through
## itch.io cover URLs with trailing srcset descriptors like " 1x, h" or " 2x". ## itch.io cover URLs with trailing srcset descriptors like " 1x, h" or " 2x".
## These cause HTTPImageFetcher to fail because the URL is no longer valid.
func _sanitize_url(url: String) -> String: func _sanitize_url(url: String) -> String:
if url.is_empty(): if url.is_empty():
return url return url
# Srcset descriptors are separated by spaces — take only the URL portion.
var clean: String = url.split(" ")[0] var clean: String = url.split(" ")[0]
# Validate that the cleaned URL ends with a known image extension.
var ext: String = clean.get_extension().to_lower() var ext: String = clean.get_extension().to_lower()
if ext not in IMAGE_EXTS: if ext not in IMAGE_EXTS:
logger.warn("Sanitized URL has unexpected extension '%s': %s" % [ext, clean.left(LOG_URL_MAX_LEN)]) logger.warn("Sanitized URL has unexpected extension '%s': %s" % [ext, clean.left(LOG_URL_MAX_LEN)])
return clean return clean
## Returns whether a URL points to a GIF image. ## Returns whether a URL points to a GIF image. Handles both clean URLs and
## URLs contaminated with srcset artifacts (e.g. "image.gif 1x, h").
func _is_gif_url(url: String) -> bool: func _is_gif_url(url: String) -> bool:
return _sanitize_url(url).to_lower().ends_with(".gif") return _sanitize_url(url).to_lower().ends_with(".gif")
@ -105,6 +153,7 @@ func _fetch_image_with_format_detection(url: String, cache_flags: int) -> Textur
if result != HTTPRequest.RESULT_SUCCESS or response_code != 200: if result != HTTPRequest.RESULT_SUCCESS or response_code != 200:
return null return null
# Detect actual format from Content-Type header.
var content_type := "" var content_type := ""
for h in headers: for h in headers:
if h.to_lower().begins_with("content-type:"): if h.to_lower().begins_with("content-type:"):
@ -120,6 +169,7 @@ func _fetch_image_with_format_detection(url: String, cache_flags: int) -> Textur
elif content_type.find("webp") != -1: elif content_type.find("webp") != -1:
err = image.load_webp_from_buffer(body) err = image.load_webp_from_buffer(body)
else: else:
# Unknown type — try PNG first, then JPEG.
err = image.load_png_from_buffer(body) err = image.load_png_from_buffer(body)
if err != OK: if err != OK:
err = image.load_jpg_from_buffer(body) err = image.load_jpg_from_buffer(body)
@ -163,6 +213,7 @@ func get_boxart(item: LibraryItem, kind: LAYOUT) -> Texture2D:
if use_caching: if use_caching:
cache_flags = Cache.FLAGS.LOAD | Cache.FLAGS.SAVE cache_flags = Cache.FLAGS.LOAD | Cache.FLAGS.SAVE
# Banner: combine two screenshots side-by-side when available.
if kind == LAYOUT.BANNER and screenshots.size() >= 2: if kind == LAYOUT.BANNER and screenshots.size() >= 2:
return await _fetch_banner_textures(item, screenshots, cache_flags) return await _fetch_banner_textures(item, screenshots, cache_flags)
@ -179,11 +230,13 @@ func get_boxart(item: LibraryItem, kind: LAYOUT) -> Texture2D:
## Enriches game metadata by scraping the itch.io page for screenshots. ## Enriches game metadata by scraping the itch.io page for screenshots.
## Uses cached results when available.
func _enrich_metadata(game: Dictionary, game_id: int, title: String) -> Dictionary: func _enrich_metadata(game: Dictionary, game_id: int, title: String) -> Dictionary:
var meta: Dictionary = _enriched_meta.get(game_id, {}) var meta: Dictionary = _enriched_meta.get(game_id, {})
if meta.is_empty() and game.has("url"): if meta.is_empty() and game.has("url"):
logger.info("Enriching metadata for: %s (url=%s)" % [title, game.get("url", "")]) logger.info("Enriching metadata for: %s (url=%s)" % [title, game.get("url", "")])
meta = await _fetch_game_page_metadata(game) meta = await _fetch_game_page_metadata(game)
# Cache both successes and failures to avoid repeated requests.
_enriched_meta[game_id] = meta _enriched_meta[game_id] = meta
_save_enriched_meta(game_id, meta) _save_enriched_meta(game_id, meta)
if meta.is_empty(): if meta.is_empty():
@ -198,23 +251,14 @@ func _enrich_metadata(game: Dictionary, game_id: int, title: String) -> Dictiona
## Fetches two screenshots and combines them side-by-side for banner layout. ## Fetches two screenshots and combines them side-by-side for banner layout.
## Falls back to individual screenshots if the combine fails.
func _fetch_banner_textures(item: LibraryItem, screenshots: Array, cache_flags: int) -> Texture2D: func _fetch_banner_textures(item: LibraryItem, screenshots: Array, cache_flags: int) -> Texture2D:
var banner_key: String = screenshots[0] + "||" + screenshots[1]
if cache_flags & Cache.FLAGS.LOAD and Cache.is_cached(BANNER_CACHE_DIR, banner_key):
var cached := Cache.get_image(BANNER_CACHE_DIR, banner_key)
if cached != null:
logger.info("Banner: loaded cached stitched banner for %s" % item.name)
return cached
logger.info("Fetching itch.io banner (2 screenshots) for: " + item.name) logger.info("Fetching itch.io banner (2 screenshots) for: " + item.name)
var tex_a := await _fetch_image(screenshots[0], cache_flags) var tex_a := await _fetch_image(screenshots[0], cache_flags)
var tex_b := await _fetch_image(screenshots[1], cache_flags) var tex_b := await _fetch_image(screenshots[1], cache_flags)
if tex_a != null and tex_b != null: if tex_a != null and tex_b != null:
var stitched := _combine_side_by_side(tex_a, tex_b) return _combine_side_by_side(tex_a, tex_b)
if cache_flags & Cache.FLAGS.SAVE and stitched != null: # Banner combine failed — fall back to single-image path.
Cache.save_image(BANNER_CACHE_DIR, banner_key, stitched)
return stitched
logger.warn("Banner screenshot fetch failed: tex_a=%s tex_b=%s" % [str(tex_a != null), str(tex_b != null)]) logger.warn("Banner screenshot fetch failed: tex_a=%s tex_b=%s" % [str(tex_a != null), str(tex_b != null)])
if tex_a != null: if tex_a != null:
return tex_a return tex_a
@ -248,6 +292,7 @@ func _url_for_layout(kind: LAYOUT, cover_url: String, screenshots: Array) -> Str
LAYOUT.GRID_LANDSCAPE: LAYOUT.GRID_LANDSCAPE:
return screenshots[0] if not screenshots.is_empty() else cover_url return screenshots[0] if not screenshots.is_empty() else cover_url
LAYOUT.BANNER: LAYOUT.BANNER:
# Single screenshot fallback (two-screenshot case handled in get_boxart).
return screenshots[0] if not screenshots.is_empty() else cover_url return screenshots[0] if not screenshots.is_empty() else cover_url
return "" return ""
@ -263,21 +308,25 @@ func _best_portrait_url(game: Dictionary, _screenshots: Array) -> String:
## Ensures an ffmpeg binary is available. Checks the system PATH first, ## Ensures an ffmpeg binary is available. Checks the system PATH first,
## then falls back to a bundled copy under user://boxart/itch/. ## then falls back to a bundled copy under user://boxart/itch/. Downloads
## the static build on first use if neither is found.
func _ensure_ffmpeg() -> String: func _ensure_ffmpeg() -> String:
if not _ffmpeg_bin.is_empty(): if not _ffmpeg_bin.is_empty():
return _ffmpeg_bin return _ffmpeg_bin
# 1. Check system PATH by probing directly.
var probe: Array = [] var probe: Array = []
OS.execute("ffmpeg", ["-version"], probe, true) OS.execute("ffmpeg", ["-version"], probe, true)
if probe.size() > 0 and probe[0].find("ffmpeg version") != -1: if probe.size() > 0 and probe[0].find("ffmpeg version") != -1:
_ffmpeg_bin = "ffmpeg" _ffmpeg_bin = "ffmpeg"
logger.info("Using system ffmpeg") logger.info("Using system ffmpeg")
return _ffmpeg_bin return _ffmpeg_bin
# 2. Check bundled location.
var bundled: String = ProjectSettings.globalize_path(BOXART_DIR) + "/ffmpeg" var bundled: String = ProjectSettings.globalize_path(BOXART_DIR) + "/ffmpeg"
if FileAccess.file_exists(bundled): if FileAccess.file_exists(bundled):
_ffmpeg_bin = bundled _ffmpeg_bin = bundled
logger.info("Using bundled ffmpeg: " + _ffmpeg_bin) logger.info("Using bundled ffmpeg: " + _ffmpeg_bin)
return _ffmpeg_bin return _ffmpeg_bin
# 3. Download.
logger.info("ffmpeg not found — downloading static build") logger.info("ffmpeg not found — downloading static build")
if await _install_ffmpeg(): if await _install_ffmpeg():
_ffmpeg_bin = ProjectSettings.globalize_path(BOXART_DIR) + "/ffmpeg" _ffmpeg_bin = ProjectSettings.globalize_path(BOXART_DIR) + "/ffmpeg"
@ -286,7 +335,9 @@ func _ensure_ffmpeg() -> String:
return "" return ""
## Downloads a static ffmpeg build. ## Downloads a static ffmpeg build. Detects the platform and architecture
## the same way the itch plugin's butler installer does, then fetches
## the matching BtbN pre-built binary.
func _install_ffmpeg() -> bool: func _install_ffmpeg() -> bool:
var os_name := _detect_os() var os_name := _detect_os()
var arch_name := _detect_arch() var arch_name := _detect_arch()
@ -297,6 +348,7 @@ func _install_ffmpeg() -> bool:
return _extract_ffmpeg(body, os_name) return _extract_ffmpeg(body, os_name)
## Detects the current OS as a short name for ffmpeg builds.
func _detect_os() -> String: func _detect_os() -> String:
if OS.get_name() == "Windows": if OS.get_name() == "Windows":
return "win" return "win"
@ -305,6 +357,7 @@ func _detect_os() -> String:
return "linux" return "linux"
## Detects the CPU architecture as a short name for ffmpeg builds.
func _detect_arch() -> String: func _detect_arch() -> String:
if Engine.has_method("get_architecture_name"): if Engine.has_method("get_architecture_name"):
var arch: String = Engine.get_architecture_name() var arch: String = Engine.get_architecture_name()
@ -313,6 +366,7 @@ func _detect_arch() -> String:
return "64" return "64"
## Builds the download URL for the ffmpeg archive matching the given platform.
func _build_ffmpeg_url(os_name: String, arch_name: String) -> String: func _build_ffmpeg_url(os_name: String, arch_name: String) -> String:
var platform_slug := os_name + arch_name var platform_slug := os_name + arch_name
var archive_name := "ffmpeg-master-latest-%s-gpl" % platform_slug var archive_name := "ffmpeg-master-latest-%s-gpl" % platform_slug
@ -323,7 +377,7 @@ func _build_ffmpeg_url(os_name: String, arch_name: String) -> String:
## Downloads bytes from a URL. Returns empty PackedByteArray on failure. ## Downloads bytes from a URL. Returns empty PackedByteArray on failure.
func _download_url_bytes(url: String) -> PackedByteArray: func _download_url_bytes(url: String) -> PackedByteArray:
var http := HTTPRequest.new() var http := HTTPRequest.new()
http.timeout = HTTP_TIMEOUT_MS / 1000.0 http.timeout = HTTP_TIMEOUT_MS / 1000.0 # HTTPRequest uses seconds.
add_child.call_deferred(http) add_child.call_deferred(http)
await http.ready await http.ready
@ -373,44 +427,53 @@ func _extract_ffmpeg(body: PackedByteArray, os_name: String) -> bool:
return true return true
## Unified image fetch. GIFs go through ffmpeg for first-frame extraction. ## Unified image fetch that routes GIF URLs through ffmpeg and non-GIF URLs
## Non-GIF URLs go through HTTPImageFetcher, with a format-detection ## through the normal HTTPImageFetcher path. Checks the animated GIF setting
## fallback for .jpg URLs that are actually served as PNG by itch.zone. ## on each call so toggling takes effect immediately.
func _fetch_image(url: String, cache_flags: int) -> Texture2D: func _fetch_image(url: String, cache_flags: int) -> Texture2D:
if _is_gif_url(url): if _is_gif_url(url):
# Invalidate cache when the animated setting changes.
var animated: bool = _is_animated_gifs_enabled()
if animated != _last_animated_setting:
_animated_texture_cache.clear()
_last_animated_setting = animated
logger.info("Animated GIF setting changed to %s — cache cleared" % str(animated))
return await _fetch_gif_as_texture(url, cache_flags) return await _fetch_gif_as_texture(url, cache_flags)
# HTTPImageFetcher uses the URL extension to pick the decoder, but
# itch.zone often serves PNG data for .jpg URLs. If the normal fetch
# fails for a .jpg/.jpeg URL, retry by detecting the actual format.
var texture := await http_image.fetch(url, cache_flags) var texture := await http_image.fetch(url, cache_flags)
if texture == null and _is_jpg_url(url): if texture == null and _is_jpg_url(url):
texture = await _fetch_image_with_format_detection(url, cache_flags) texture = await _fetch_image_with_format_detection(url, cache_flags)
return texture return texture
## Downloads a GIF and extracts the first frame as a static ImageTexture. ## Downloads a GIF and converts it to a Godot texture. When animated GIFs
## Results are cached on disk under user://boxart/itch/gif_static/<hash>.png ## are enabled, extracts all frames and returns an AnimatedTexture (paused
## and in memory for the session. ## by default — the focus handler unpauses it). Otherwise extracts only
## the first frame and returns a static ImageTexture.
## Results are cached in _animated_texture_cache keyed by URL.
func _fetch_gif_as_texture(url: String, cache_flags: int) -> Texture2D: func _fetch_gif_as_texture(url: String, cache_flags: int) -> Texture2D:
var globalized_dir := ProjectSettings.globalize_path(BOXART_DIR) # Return cached result if available.
DirAccess.make_dir_recursive_absolute(globalized_dir + "/" + GIF_STATIC_DIR) if _animated_texture_cache.has(url):
var url_hash := url.sha256_text().left(16) return _animated_texture_cache[url]
var cached_png := globalized_dir + "/" + GIF_STATIC_DIR + "/" + url_hash + ".png"
# Check disk cache.
if cache_flags & Cache.FLAGS.LOAD and FileAccess.file_exists(cached_png):
var image := Image.load_from_file(cached_png)
if image != null:
logger.info("GIF fetch: loaded cached static frame for %s" % url.left(LOG_URL_MAX_LEN))
return ImageTexture.create_from_image(image)
var animated: bool = _is_animated_gifs_enabled()
var ffmpeg_bin := await _ensure_ffmpeg() var ffmpeg_bin := await _ensure_ffmpeg()
if ffmpeg_bin.is_empty(): if ffmpeg_bin.is_empty():
return null return null
var globalized_dir := ProjectSettings.globalize_path(BOXART_DIR)
var url_hash := url.sha256_text().left(16)
var gif_path := globalized_dir + "/_tmp_%s.gif" % url_hash var gif_path := globalized_dir + "/_tmp_%s.gif" % url_hash
var frames_dir := globalized_dir + "/_tmp_%s_frames" % url_hash
var body := await _download_url_bytes(url) # Download the GIF bytes via HTTPClient.
var body := await _download_gif_bytes(url)
if body.is_empty(): if body.is_empty():
return null return null
# Write GIF to temp file.
var gif_file := FileAccess.open(gif_path, FileAccess.WRITE) var gif_file := FileAccess.open(gif_path, FileAccess.WRITE)
if gif_file == null: if gif_file == null:
logger.warn("GIF fetch: cannot write temp gif") logger.warn("GIF fetch: cannot write temp gif")
@ -418,22 +481,45 @@ func _fetch_gif_as_texture(url: String, cache_flags: int) -> Texture2D:
gif_file.store_buffer(body) gif_file.store_buffer(body)
gif_file.close() gif_file.close()
# Extract first frame via ffmpeg. var result: Texture2D
if animated:
result = await _build_animated_gif_texture(ffmpeg_bin, gif_path, frames_dir, body, url)
else:
result = await _build_static_gif_texture(ffmpeg_bin, gif_path, globalized_dir + "/_tmp_%s.png" % url_hash, url)
# Clean up.
DirAccess.remove_absolute(gif_path)
# Cache the result.
if result != null:
_animated_texture_cache[url] = result
return result
## Downloads GIF bytes from the given URL. Returns empty PackedByteArray on failure.
func _download_gif_bytes(url: String) -> PackedByteArray:
return await _download_url_bytes(url)
## Extracts the first frame of a GIF using ffmpeg. Returns a static ImageTexture.
func _build_static_gif_texture(ffmpeg_bin: String, gif_path: String, png_path: String, url: String) -> Texture2D:
var ffmpeg_args: PackedStringArray = [ var ffmpeg_args: PackedStringArray = [
"-y", "-i", gif_path, "-y", "-i", gif_path,
"-frames:v", "1", "-frames:v", "1",
"-f", "image2", cached_png, "-f", "image2", png_path,
] ]
var ret: Array = [] var ret: Array = []
OS.execute(ffmpeg_bin, ffmpeg_args, ret) OS.execute(ffmpeg_bin, ffmpeg_args, ret)
DirAccess.remove_absolute(gif_path) if not FileAccess.file_exists(png_path):
if not FileAccess.file_exists(cached_png):
logger.warn("GIF fetch: ffmpeg did not produce output for %s" % url.left(LOG_URL_MAX_LEN)) logger.warn("GIF fetch: ffmpeg did not produce output for %s" % url.left(LOG_URL_MAX_LEN))
return null return null
var image := Image.load_from_file(cached_png) var image := Image.load_from_file(png_path)
DirAccess.remove_absolute(png_path)
if image == null: if image == null:
logger.warn("GIF fetch: failed to load extracted PNG") logger.warn("GIF fetch: failed to load extracted PNG")
return null return null
@ -442,13 +528,150 @@ func _fetch_gif_as_texture(url: String, cache_flags: int) -> Texture2D:
return ImageTexture.create_from_image(image) return ImageTexture.create_from_image(image)
## Extracts all frames from a GIF using ffmpeg and builds an AnimatedTexture.
## The animation is paused by default — the focus handler unpauses it.
func _build_animated_gif_texture(ffmpeg_bin: String, gif_path: String, frames_dir: String, gif_bytes: PackedByteArray, url: String) -> AnimatedTexture:
var delays: Array = _parse_gif_frame_delays(gif_bytes)
var frame_files: PackedStringArray = _extract_gif_frames(ffmpeg_bin, gif_path, frames_dir)
if frame_files.is_empty():
return null
return _assemble_animated_texture(frame_files, frames_dir, delays, url)
## Extracts all frames from a GIF file using ffmpeg. Returns sorted frame filenames.
func _extract_gif_frames(ffmpeg_bin: String, gif_path: String, frames_dir: String) -> PackedStringArray:
DirAccess.make_dir_recursive_absolute(frames_dir)
var ffmpeg_args: PackedStringArray = [
"-y", "-i", gif_path,
"-vsync", "0",
frames_dir + "/frame_%04d.png",
]
var ret: Array = []
OS.execute(ffmpeg_bin, ffmpeg_args, ret)
var dir := DirAccess.open(frames_dir)
if dir == null:
logger.warn("GIF fetch: cannot open frames dir")
return PackedStringArray()
dir.list_dir_begin()
var frame_files: PackedStringArray = []
var fname := dir.get_next()
while fname != "":
if fname.begins_with("frame_") and fname.ends_with(".png"):
frame_files.append(fname)
fname = dir.get_next()
dir.list_dir_end()
frame_files.sort()
return frame_files
## Loads extracted frame images and assembles them into an AnimatedTexture.
func _assemble_animated_texture(frame_files: PackedStringArray, frames_dir: String, delays: Array, url: String) -> AnimatedTexture:
var anim_tex := AnimatedTexture.new()
anim_tex.frames_count = frame_files.size()
anim_tex.pause = true # Start paused — focus handler unpauses.
for i in frame_files.size():
var frame_path := frames_dir + "/" + frame_files[i]
var image := Image.load_from_file(frame_path)
DirAccess.remove_absolute(frame_path)
if image == null:
logger.warn("GIF fetch: failed to load frame %d" % i)
continue
anim_tex.set_frame_texture(i, ImageTexture.create_from_image(image))
var delay_ms: int = delays[i] if i < delays.size() else GIF_DEFAULT_FRAME_DELAY_MS
anim_tex.set_frame_delay(i, delay_ms / 1000.0) # AnimatedTexture uses seconds.
DirAccess.remove_absolute(frames_dir)
logger.info("GIF fetch: built AnimatedTexture with %d frames from %s" % [frame_files.size(), url.left(LOG_URL_MAX_LEN)])
return anim_tex
## Parses frame delays from a GIF89a binary. Returns an array of delays
## in milliseconds, one per frame. Falls back to GIF_DEFAULT_FRAME_DELAY_MS
## for frames without a Graphics Control Extension.
func _parse_gif_frame_delays(data: PackedByteArray) -> Array:
var delays: Array = []
if data.size() < 13:
return delays
var pos := _skip_gif_header(data)
while pos < data.size() - 1:
var byte: int = data[pos]
if byte == 0x21:
var result: Array = _parse_gif_extension(data, pos)
if result[0] >= 0:
delays.append(result[0])
pos = result[1]
elif byte == 0x2C:
pos = _skip_gif_image_descriptor(data, pos)
elif byte == 0x3B:
break
else:
pos += 1
return delays
## Skips the GIF header, Logical Screen Descriptor, and Global Color Table.
## Returns the byte offset past all header data.
func _skip_gif_header(data: PackedByteArray) -> int:
if data.size() < 13:
return data.size()
var pos := 13 # Header (6) + Logical Screen Descriptor (7).
var packed_byte: int = data[10]
if packed_byte & 0x80 != 0:
var gct_size := 3 * (1 << ((packed_byte & 0x07) + 1))
pos += gct_size
return pos
## Parses an extension block starting at `pos`. Returns [delay_ms, new_pos].
## If the extension is not a Graphics Control Extension, returns [-1, new_pos].
func _parse_gif_extension(data: PackedByteArray, pos: int) -> Array:
if pos + 2 >= data.size():
return [-1, data.size()]
var label: int = data[pos + 1]
var delay_ms := -1
if label == 0xF9 and pos + 5 < data.size():
var delay_cs: int = data[pos + 4] | (data[pos + 5] << 8)
delay_ms = delay_cs * 10 if delay_cs > 0 else GIF_DEFAULT_FRAME_DELAY_MS
pos += 2
while pos < data.size():
var block_size: int = data[pos]
pos += 1
if block_size == 0:
break
pos += block_size
return [delay_ms, pos]
## Skips an image descriptor and its associated data at `pos`.
func _skip_gif_image_descriptor(data: PackedByteArray, pos: int) -> int:
pos += 10
var img_packed: int = data[pos - 1]
if img_packed & 0x80 != 0:
var lct_size := 3 * (1 << ((img_packed & 0x07) + 1))
pos += lct_size
pos += 1 # LZW Minimum Code Size.
while pos < data.size():
var block_size: int = data[pos]
pos += 1
if block_size == 0:
break
pos += block_size
return pos
## Combines two textures side-by-side into a single banner image. ## Combines two textures side-by-side into a single banner image.
## Both images are scaled to the same height, then placed left and right.
func _combine_side_by_side(left: Texture2D, right: Texture2D) -> Texture2D: func _combine_side_by_side(left: Texture2D, right: Texture2D) -> Texture2D:
var img_a := left.get_image() var img_a := left.get_image()
var img_b := right.get_image() var img_b := right.get_image()
if img_a == null or img_b == null: if img_a == null or img_b == null:
return left return left
# Scale both to the same height (use the taller one).
var target_h: int = max(img_a.get_height(), img_b.get_height()) var target_h: int = max(img_a.get_height(), img_b.get_height())
if img_a.get_height() != target_h: if img_a.get_height() != target_h:
var scale: float = float(target_h) / float(img_a.get_height()) var scale: float = float(target_h) / float(img_a.get_height())
@ -464,7 +687,8 @@ func _combine_side_by_side(left: Texture2D, right: Texture2D) -> Texture2D:
return ImageTexture.create_from_image(combined) return ImageTexture.create_from_image(combined)
## Scrapes the itch.io game page for screenshots. ## Scrapes the itch.io game page for screenshots. The itch.io API does not
## expose screenshots, so the page HTML is the only source.
func _fetch_game_page_metadata(game: Dictionary) -> Dictionary: func _fetch_game_page_metadata(game: Dictionary) -> Dictionary:
var page_url: String = game.get("url", "") var page_url: String = game.get("url", "")
if page_url.is_empty(): if page_url.is_empty():
@ -485,10 +709,12 @@ func _fetch_game_page_metadata(game: Dictionary) -> Dictionary:
return _extract_screenshots_from_html(html, page_url) return _extract_screenshots_from_html(html, page_url)
## Returns true if the HTML contains a Cloudflare challenge page.
func _is_cloudflare_challenge(html: String) -> bool: func _is_cloudflare_challenge(html: String) -> bool:
return html.find("challenge-platform") != -1 or html.find("cf-browser-verification") != -1 return html.find("challenge-platform") != -1 or html.find("cf-browser-verification") != -1
## Extracts screenshot URLs from the itch.io page HTML using regex.
func _extract_screenshots_from_html(html: String, page_url: String) -> Dictionary: func _extract_screenshots_from_html(html: String, page_url: String) -> Dictionary:
var shot_re := RegEx.new() var shot_re := RegEx.new()
shot_re.compile(SCREENSHOT_REGEX_PATTERN) shot_re.compile(SCREENSHOT_REGEX_PATTERN)

View file

@ -6,6 +6,7 @@ extends Plugin
## Requires the itch.io library plugin to populate LibraryItem metadata. ## Requires the itch.io library plugin to populate LibraryItem metadata.
var icon := preload("res://plugins/itch-artprovider/assets/itch.svg") var icon := preload("res://plugins/itch-artprovider/assets/itch.svg")
var _settings_scene := load("res://plugins/itch-artprovider/core/artprovider_settings.tscn") as PackedScene
func _ready() -> void: func _ready() -> void:
@ -13,3 +14,7 @@ func _ready() -> void:
var boxart_provider: BoxArtProvider = load("res://plugins/itch-artprovider/core/boxart_itch.tscn").instantiate() var boxart_provider: BoxArtProvider = load("res://plugins/itch-artprovider/core/boxart_itch.tscn").instantiate()
add_child(boxart_provider) add_child(boxart_provider)
logger.info("itch.io Art Provider loaded") logger.info("itch.io Art Provider loaded")
func get_settings_menu() -> Control:
return _settings_scene.instantiate()

View file

@ -1,7 +1,7 @@
{ {
"plugin.id": "itch-artprovider", "plugin.id": "itch-artprovider",
"plugin.name": "itch.io Art Provider", "plugin.name": "itch.io Art Provider",
"plugin.version": "0.1.20", "plugin.version": "0.1.14",
"plugin.min-api-version": "1.1.0", "plugin.min-api-version": "1.1.0",
"plugin.link": "https://forge.thergic.ar/jose/itchio-opengamepadui-artprovider-plugin", "plugin.link": "https://forge.thergic.ar/jose/itchio-opengamepadui-artprovider-plugin",
"plugin.source": "https://forge.thergic.ar/jose/itchio-opengamepadui-artprovider-plugin", "plugin.source": "https://forge.thergic.ar/jose/itchio-opengamepadui-artprovider-plugin",