You are viewing a potentially older version of this package. View all versions.
orax-XRays-0.1.0 icon

XRays

X-Ray: hide the terrain, the water, whole categories of objects or a single object under the cursor to see through them.

Date uploaded 2 weeks ago
Version 0.1.0
Download link orax-XRays-0.1.0.zip
Downloads 84
Dependency string orax-XRays-0.1.0

This mod requires the following mods to function

ValheimModding-Jotunn-2.30.2 icon
ValheimModding-Jotunn

Jötunn (/ˈjɔːtʊn/, 'giant'), the Valheim Library was created with the goal of making the lives of mod developers easier. It enables you to create mods for Valheim using an abstracted API so you can focus on the actual content creation.

Preferred version: 2.30.2
denikson-BepInExPack_Valheim-5.4.2351 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.2351

README

Hides the terrain, the water, the clouds, the mist or world elements so you can see through them: trees, rocks, resources, build pieces, creatures, ground items, etc.

Demo

Images

Video

https://youtu.be/JYvS0azG44U

Usage

Open the GUI with F8 (configurable) or click on XRAYS on the new Pause menu entry.

Notes: The categories (Build pieces, Creatures, Crops, Grass, etc.) aim to classify in-game elements. However, some items may end up in the wrong category or might not be assigned to any category at all.

Installation

Client-side only — nothing to install on the server.

With a mod manager (recommended)

Install the mod with Vortex or Gale.

Manually

  1. Install BepInExPack for Valheim and Jötunn.
  2. Copy XRays.dll and orax.XRays.names.yaml into Steam\steamapps\common\Valheim\BepInEx\plugins\.

Configuration

All options live in BepInEx\config\orax.XRays.cfg (created on the first launch, also editable in game through the Configuration Manager — a separate mod, its window opens with F1).

The name rules file

What a category claims by name — the substrings, the prefixes and the regular expressions matched against the name of a game object, and the names it gives away to another category — lives in a file of its own and in that file only: the code holds no name rule at all. The mod ships it as BepInEx\plugins\orax.XRays.names.yaml, looked for there, then beside its own assembly, then in BepInEx\scripts, and copies it into BepInEx\config at launch; the copy of BepInEx\config is the file read, and read again every time it changes while the game runs. Which file it is, is the Files → Name rules file option of the table above.

A file holding a couple of categories could look like this:

version: 0.1.0
ores:
  nameContains:
    - "_copper"
    - "silver"
  nameMatches:
    - "^giant_(ribs|skull|sword)"
rocks:
  nameExcludes:
    - "_copper"
    - "silver"

The five lists of a category, every one of them matched against the object name:

List What it does
nameContains case-insensitive substrings the category claims
nameStartsWith case-insensitive prefixes it claims
nameMatches regular expressions it claims, searched in the name (^ and $ anchor a pattern covering the whole name)
nameExcludes case-insensitive substrings given away to another category, which is how the ore veins are kept out of the rocks
nameExcludesMatches regular expressions given away the same way

The file is the only source: a list it does not carry is empty, and a category it does not carry has no name rule at all. Categories are named by their key — trees, ores, rocks, pickable, build, creatures, items, plants, spawners, clutter, locations — and a key naming none of them is written to the log, it is usually a typo.

A list belongs to one category only: telling ores what it claims does not keep rocks from claiming the very same names, so both sides have to be written — which is what nameExcludes is for.

Write the values between single quotes: nothing is escaped in them, so a regular expression keeps its backslash, '^Rock_\d+$' written once. Between double quotes a backslash has to be written twice ("^Rock_\\d+$"), and "\d" is a parse error; a value written without quotes at all is read literally too, but a # inside it starts a comment and cuts it short. The name matched is the raw name of the game object, Rock_3(Clone) included when the game clones one.

Misc.

GitHub repositories of my Valheim mods: https://github.com/orax-Valheim-mods/

CHANGELOG

Changelog

0.1.0 - 2026-10-30

Added

  • Add infos under the cursor
  • Add an option to log the under-the-cursor info
  • Add a Hide all button to the panel
  • Add a Hide player option
  • Add a Hide HUD option
  • Add a reveal / restore toggle with a button and a hotkey
  • Add a scrollbar and a vertical size option for the panel
  • Add the YamlDotNet reference and ship its assembly
  • Add the name rules file of the mod
  • Add a timing log of the reconcile pass
  • Add options for the wait between two sweeps
  • Add an option to switch the mod off completely
  • Add an XRays entry to the pause menu
  • Add .prettierrc.json for code formatting

Changed

  • Init
  • Show the game types behind the category under the cursor
  • Reformat the sources to the editorconfig rules
  • Also match category objects by name so the small trees belong to Trees
  • Extend the tree name rules and leave the typed objects to their component
  • Hide the real grass, the distant sea and the clouds
  • Close the panel with the escape key
  • Hide the plain boulders with the Rocks / ore category
  • Group every panel option into a single list
  • Hide the swimming fish with the Creatures category
  • Drop the Hide prefix from the option labels
  • Lay the world layer options out on one compact line
  • Shorten the panel title to XRays
  • Catch the dungeon entrances with a Locations category
  • Hide the ambient birds with the Creatures category
  • Remember the panel setup between launches
  • Tighten the space under the panel title
  • One single label for the remember row
  • Mist option to hide the fog
  • Default panel height of 700
  • Panel key in a General section, named Show/hide panel
  • Hotkeys recorded as key combinations
  • Hotkeys section renamed to Show/hide hotkeys
  • Pick category in the General section
  • General section renamed to General hotkeys
  • Close hotkey renamed to Close GUI and moved
  • Show/hide hotkeys start as Not set
  • Comments describe the current code only
  • Panel hotkeys named after the control panel
  • Panel options listed in alphabetical order
  • Little box describing the element under the mouse
  • Split Rocks / ore into Rocks and Ores
  • Drop a duplicated panel comment and a dead label line
  • README.md
  • Show tooltips option in the panel and the Display config section
  • Claim the giant corpse pieces with Ores
  • Name rules can be regular expressions
  • Disclose in both READMEs that the mod was generated by AI
  • Read the category name rules from a YAML file
  • Document the name rules file
  • Ship the name rules file with the mod
  • Copy the name rules file of the mod into the config folder
  • Keep the name rules only in the YAML file
  • Document where the name rules live
  • Collect the children of a hidden root once every ten passes
  • Set the default panel height to 750
  • Turn the remember setup toggle into a save button
  • Replace the remember button with save and restore buttons
  • Move the Show tooltips row five pixels down
  • Lower the Show tooltips row by another five pixels
  • Generate changelog and upload release to GitHub in post-build script
  • Update icon and manifest.json
  • Call the reusable workflows from orax-modding/publish
  • Enforce LF line endings via .gitattributes and .editorconfig
  • Align on BepInExPack 5.4.2351
  • Drop the UnityEngine.ProfilerModule reference (MSB3245)
  • Use 7-Zip instead of .NET compression for release archives
  • Align the upload callers with the publish template
  • Update README.md

Fixed

  • Only log the cursor info while the panel is open
  • Log the cursor info only while the panel is visible on screen
  • Give the under-the-cursor text one more line
  • Close the panel with Escape whatever the update order
  • Keep the Trees category out of the grass
  • Put the nests, piles and holes in the Spawners category
  • Count every hidden object in the panel summary line
  • Take the enemy bars away with the Creatures category
  • Hide every cloud of the environment, not only its top level
  • Claim Mistlands rocks and cliffs under Rocks / ore
  • Describe the BepInEx shortcut rules correctly
  • Drop the reveal setup when Show all runs
  • Drop the Spawner example the game claims by component
  • List the same mist layers in the panel, the config and the README
  • Document the name the component category hands over
  • Drop a panel that stops half-built
  • README, the little box delay and the config window key
  • Call the CreatureSpawner group the spawners
  • Bring the dev guide back in line with the mod
  • Skip the idle work of the timing log and of the enemy bars
  • Cut the panel refresh cost while the panel is open
  • Trace the pause menu entry click to find why it does nothing
  • Log the caller of Menu.Show and the menu-over-panel close
  • Measure the pause menu visibility around every Hide call
  • Keep the panel open while the clicked menu finishes closing
  • Declare the Jotunn dependency so BepInEx loads it first
  • Write forward slashes in release ZIP entry paths

Removed

  • Remove Unity project