You are viewing a potentially older version of this package. View all versions.
cjayride-CustomLoadingScreens-0.9.7 icon

CustomLoadingScreens

Fork of aedenthorn/CustomLoadingScreens. Customize loading screens and tip screens. Updated for Valheim 1.0.21.

Date uploaded 2 weeks ago
Version 0.9.7
Download link cjayride-CustomLoadingScreens-0.9.7.zip
Downloads 83
Dependency string cjayride-CustomLoadingScreens-0.9.7

This mod requires the following mods to function

denikson-BepInExPack_Valheim-5.4.2360 icon
denikson-BepInExPack_Valheim

BepInEx pack for Valheim. Preconfigured with the correct entry point for mods and preferred defaults for the community.

Preferred version: 5.4.2360

README

CustomLoadingScreens

Updated for Valheim 1.0.21

A fork of aedenthorn/CustomLoadingScreens

ThunderStore | GitHub

Custom Loading Screens and Tips

Use your own images as custom loading screens.

Recommended image size: 1920x1080

Setup

  • Launch the game once, to generate the config file and default image folder.

Configuration

DEFAULT IMAGE FOLDER:

Thunderstore / Gale / r2modman unpack the zip into one mod folder under BepInEx plugins, for example:

BepInEx\plugins\cjayride-CustomLoadingScreens\

That folder contains CustomLoadingScreens.dll, manifest.json, and a CustomLoadingScreens subfolder with the bundled .png / .jpg files and tips.txt. You can also put images next to the DLL in the same mod folder.

The zip itself is flat (no plugins folder inside the archive).

  • Optionally, specify another directory inside the BepInEx folder (see config file).

EDIT CONFIG FILE:

config\cjayride.CustomLoadingScreens.cfg

  • Example: You can also specify a directory in the config folder to save your images: config\mypack\CustomLoadingScreens

  • You can specify any directory path inside the BepInEx folder.

Known Issues

  • On dedicated servers, if DifferentSpawnScreen / DifferentSpawnTip are disabled, the same image picked at game launch is reused for death respawn and portal travel until you restart the client.

Contact

  • 𝕏: x.com/cjayride

  • Discord: discord.gg/cjayride (find me at the top of the user list) "cjayride"

  • Twitch: twitch.tv/cjayride

AI Generated

This code was not AI Generated, however, AI was used to verify that it works with the new version of the game.

CHANGELOG

v0.9.20

  • Portal trips now pick a different image each time. Rotation was random and allowed repeats; the third trip in a row could keep the previous sprite. Each portal now excludes the last file and always re-rolls (not only when DifferentSpawnScreen is on).
  • Removed portal/tip debug probes and per-frame log spam.

v0.9.19

  • Norse tips were hidden under the custom portal image. The 0.9.18 raise put the tip last under Loading, then ApplyToLoadingImage called SetAsLastSibling on Hud.m_loadingImage every portal frame and painted the full-screen sprite over the tip. HUD loading images no longer steal last-sibling; the tip branch is raised after the sprite is applied. Probe NRE (p.parent at the canvas root) is fixed.

v0.9.18

  • Tip should now paint: ordering + honest probe. The trip-start probe (0.9.16/0.9.17) fired BEFORE the per-frame fixes, so its activeInHierarchy=False only described vanilla's leftover state - it proved nothing about what you see, and it exposed two blockers: the tip's parent GameObject Loading is disabled at trip start (vanilla enables it only on the spawn path), and a LoadingBlack CanvasGroup above it is mid-fade (alpha 0.03). Fixes: the trip loop activates the tip's disabled ancestors (0.9.17) AND, at trip start, moves the tip's chain last beneath its deepest common ancestor with the full-screen image - a canvas paints in a depth-first sibling walk, so an image branch walked after the tip's paints its full-screen sprite OVER the text. New 1 Hz mid-trip probe reports the live truth: hierarchy, CanvasGroup alphas above the label, sibling index vs the image, text color/size/rect.

v0.9.17

  • Tips on portal screens, take 2 (the probe caught it): the tip label's parent was off. The 0.9.16 probe proved the label is enabled WITH the tip text on it, but its ancestor GameObject Loading is disabled during a portal trip (vanilla enables that branch only in SetupLoadScreen, the spawn/respawn path): Portal tip: ... chain self:True <Loading>False <LoadingBlack>True .... Enabling the label alone can never show it. The trip loop now activates the tip's disabled ancestors up to the canvas root (a handful of activeSelf checks per frame, only while a trip lasts).

v0.9.16

  • Valheim tips now show on portal loading screens. The tip label (Hud.m_loadingTip) is enabled by vanilla only in SetupLoadScreen, which runs on the spawn/respawn path - during a portal trip its GameObject is disabled, so the fork's tip text was being set on an invisible object (the exact same disease the loading image had in v0.9.10). The trip loop now enables the label each frame (one flag check), keeps it click-through, and the random tip from tips.txt paints at the bottom of the screen - portal, spawn, and respawn all show tips.
  • The layering probe (Screen raised: …) is removed - the canvas test came back clean.

v0.9.15

  • Hijack fixed (0.9.14 regression): the solid black screen at the server-password prompt. The layer raise also fired on the menu's loading-screen setup moment / panel alpha, and during the world-load the black loading panel is active - raising the whole HUD canvas above everything covered the login UI in black. The raise is now gated on a portal trip only (portalLoading - true exactly when a local player exists AND is teleporting, never in a menu). Spawn/respawn/login keep vanilla layering; the XP-card + status-squares problem only exists during portals, and that's where the raise lives now.

v0.9.14

  • The probe caught the real bug: Unity stores a canvas sortingOrder as int16, so raising to 100000 WRAPPED to -31072 (log: Screen raised: root=HUD order=-31072) - the loading screen went BELOW everything, which is exactly why most of the UI stayed visible through portals. The raise now clamps to the legal maximum 32767.
  • The probe also showed the panel is a LOW sibling of the HUD canvas root, so the XP card (SeneaLHudLayout_SlotXp) and everything under hudroot/hotbar paint after it in the canvas depth-first walk. The loading panel is now REPARENTED to the canvas root as the LAST child for the duration of the screen (paints after every HUD element), and restored to its original parent + sibling index the frame the screen fades.
  • The XP card's nested canvas (order 401) loses to the raised root (32767), so the card is covered without touching HudLayout. The raise moment logs the panel's new position + any canvas above the raised root (expected: above: nothing).

v0.9.13

  • Layering redone (the 0.9.12 override was ignored by Unity, and it broke rendering). overrideSorting on a nested canvas is only honored when the parent canvas is Screen Space - Camera/World; the vanilla HUD canvas is Screen Space - Overlay, so the nested canvas did nothing (UI stayed visible through the portal screen) and the extra Canvas component broke the loading image's own rendering (the server-password screen showed no image for a while, with world objects visible that were never visible before). It is removed - no components are added to any HUD object now.
  • What the screen does instead, for the duration of any loading screen (portal, spawn, respawn): the loading panel's branch is moved last at every level up to the canvas root - a canvas renders as a depth-first walk, so being last one level down was not enough to beat the XP card and status squares living under a sibling branch - and the root canvas's sortingOrder is raised to 100000, which overlay canvases DO honor, above SeneaL UI (28000-31000) and CompactStatusSquares. Restored exactly when the screen fades (the order, not the sibling order, which is harmless at alpha 0).
  • Gate fixed to the loading panel's real alpha: IsHudLoadingVisible also reports the loading image object, which stays enabled after a trip, so raising on that flag would have pinned the whole HUD canvas above the inventory forever.
  • Enter/exit edges only - no per-frame UI work, FPS-safe.

v0.9.12

  • The loading screen now paints over EVERYTHING - our XP bar, CompactStatusSquares, SeneaL UI panels: all of it. The loading screen lives on the vanilla HUD canvas (order 400), so any UI in that canvas later in the hierarchy (the XP card) and every mod canvas with a higher order drew on top of it. While a loading screen shows (portal, spawn, respawn), the loading node gets a nested Canvas with overrideSorting at a top order and is moved last in its parent - a single edge-apply when the screen appears, handed back when it fades, zero per-frame cost.
  • Portal probe logging removed (CanvasGroup chain + canvas ladder): both causes they hunted are fixed (disabled image object, canvas layering). The per-second Portal state: lines and the trip-start ladder are gone.

v0.9.11

  • New config knob PortalLoadingScreen (default true): portal teleports show the custom loading screen, controlled separately from the spawn screen. Set it to false to get vanilla's portal travelling animation back - spawn/respawn screens keep working.

v0.9.10

  • Fixed: the portal screen never appeared at all. The 0.9.9 ladder probe proved it: during a portal trip the loading CanvasGroup is at alpha 1.00 on the HUD canvas, yet the custom image reported chain=NOT-inHierarchy - the Hud.m_loadingImage GameObject is switched OFF, and vanilla never enables it (it only toggles the progress panels). So the sprite, the group fade, and the panel were all working behind a disabled image object: you saw plain black, never the art. The image object is now enabled when the sprite is applied AND every frame of the portal trip, so the loading screen paints over the world exactly like the spawn screen.

v0.9.9

  • Deeper portal probe (diagnostics only): the 0.9.8 log proved the loading CanvasGroup sits at alpha 1.000, active, with the custom image enabled during the whole trip - yet the world was still visible, so something above it draws over the screen. Every trip-start now logs the visible-canvas ladder (top canvas first) and the loading screen's own canvas, and each per-second line adds the loading image's activeInHierarchy chain, every parent CanvasGroup alpha, and its canvas order. Next report names what covers the screen.

v0.9.8

  • Portal loading screens now actually COVER the screen. Enabling the spawn panel and setting the custom sprite was not enough: the panel lives inside Hud.m_loadingScreen, a CanvasGroup whose alpha vanilla only raises for the initial load / respawn. During a portal trip that group stayed transparent, so the work was applied behind a see-through layer and the world stayed visible - character hanging mid-air at the portal. The group is now forced active with alpha 1 every frame of the trip (after vanilla's own fade, so it wins), click-through, and handed back untouched when the trip ends so the arrival fade is vanilla's.
  • One self-reporting log line per second during a portal trip only (group alpha, panel states, sprite) to pin down layering issues in the log.

v0.9.7

  • Show custom loading screens during portal teleports (swap in spawn-style panel instead of vanilla portal animation UI)
  • Re-pick spawn/portal image and tip when a new portal trip starts (when DifferentSpawnScreen / DifferentSpawnTip are enabled)

v0.9.6

  • Fix spawn loading screen never applying when Valheim fast-load leaves m_haveSetupLoadScreen already true
  • Write directly to Hud.m_loadingImage again (removed overlay-only path); restore FejdStartup Bkg clone
  • Re-apply custom sprite while the loading overlay is visible if the game resets it
  • Startup warmup decode log for easier troubleshooting
  • Release zip uses forward-slash entry paths only (Hexium / strict ZIP validators)

v0.9.5

  • Thunderstore zip layout: flat mod root (CustomLoadingScreens.dll at archive root, not under plugins/)

v0.9.4

  • Fixed missing screens when images sit next to the DLL (Thunderstore/Gale layout) instead of only in an empty CustomLoadingScreens subfolder
  • Do not treat an empty image folder as a valid content path
  • Restored texture decode (removed Apply that could blank Unity 6 textures)
  • Log how many images/tips were found at startup

v0.9.3

  • Version bump for Thunderstore (0.9.2 was already published there); same build as v0.9.2

v0.9.2

  • Verified Harmony patches against Valheim 1.0.21 (Unity 6000.0.75f1)
  • Load only the chosen screenshot textures (small LRU cache, non-readable GPU textures)
  • Skip dedicated-server / headless init
  • Reuse overlay Image instances instead of cloning every handshake
  • Cheap early-out on Hud.UpdateBlackScreen after the spawn screen is applied
  • Null-safe HUD lookups using m_loadingScreen when present
  • Bumped BepInExPack_Valheim dependency to 5.4.2360

v0.9.1

  • Fixed Harmony patch on ZNet.RPC_ClientHandshake for Valheim 1.0

v0.9.0

  • Updated for Valheim 1.0
  • Bumped BepInExPack_Valheim dependency to 5.4.2350

v0.8.0

  • Removed terminal reload
  • Added compatibility for v0.217.46

v0.7.1

  • Fixed issue with missing assembly MonoMod

v0.7.0

  • Two changes (commits) by "aedenthorn" on Aug 25, 2023 and Oct 6, 2023
  • Keeps the cjayride changes from previous versions

v0.5.2

  • Fixed issue with default filepath in config file
  • Renamed config file to cjayride.CustomLoadingScreens
  • Added free images and viking quotes you can use (or not)

v0.5.1

  • Update for cjaycraft modpack
  • Re-added two configuration parameters to the configuration file: PathToImagesFolder and PathToTipsFolder --- This is to allow for easier customization with modpacks

v0.5.0

  • Fix for mistlands update

v0.4.2

  • Changed default image folder
  • Can now specify an image directory path in either plugins folder or config folder -- anywhere inside the BepInEx folder!
  • Received report on Discord that mod wasn't working. Make sure you generate the image folder and place your images in the folder before launching the game. The game will load these images into the game during startup.