Window Display - Patches

Makes items sit properly on a window sill, gives candles their flame,
and converts your old windows across

To see what has been patched, check the changelog

The library has been renamed - read before updating. This mod is unchanged in what it does, but the library it needs is now Universal Display Lib, and its mod id has changed from windowdisplaylib to universaldisplaylib.

Delete the old windowdisplaylib zip and install Universal Display Lib in its place. Do not keep both - two libraries claiming the same block classes means neither will load. Update this mod and Window Display at the same time, since both now ask for the new id.

Server owners: the library is needed on client and server alike, so everyone connecting has to update too. Anything that fetches mods by id wants universaldisplaylib from now on.

Your worlds are safe. No block codes changed and no recipes changed - including the conversion recipes below. Everything you have placed comes back exactly as you left it.

Required Mods

Required

You will want

This mod only supplies data. Window Display is what gives you the windows to put it on.

What It Does

Makes items fit

Most things already work on a window without any help. If the game has ever told it how to sit on a shelf, it inherits that and turns up at the right size on its own.

This mod is for the ones that do not. Two cases come up:

• •Items with no display data at all. These cannot be put on a window in the first place - the game simply refuses them. A lot of mod items fall in here, since their authors had no reason to think about shelves. A patch is what makes them placeable.
• •Items that are simply too big. Plenty of things are sized for a shelf or the ground and look ridiculous on a window ledge, or will not fit at all. These get scaled and measured to something that suits a sill.

Sizes are worked out from the actual model and then checked by eye in game, not guessed. Where an item family shares one entry - all the antlers, all the amulets - it is sized off the largest one so nothing overhangs.

Gives candles their flame

Put a candle or an oil lamp on a sill and it lights the room either way - that part is Universal Display Lib and needs nothing from here. What this mod adds is the flame and the smoke: the actual particles, burning where the item is, turning with it when you rotate it.

Without it a lit candle glows but has no visible flame, which looks odd once you notice it.

It has to be set per item, because nothing in the game says where a wick is - the offset is found by looking at it and nudging it until the flame sits right. So only things somebody has tuned will burn. That is deliberate: an untuned item putting its flame in the wrong place looks worse than no flame at all.

Converts your old windows

If you are moving over from Window Storage or Vanilla Pane Storage, this is the part you want.

• •Put an old window in the crafting grid on its own and you get the Window Display version back.
• •It keeps your wood and glass. An oak leaded window comes back as an oak leaded window.
• •Every old window has a route across, including the shelf and slab versions and both corner styles. Nothing is stranded.
• •It is one way, and closed windows only - which is what a broken window drops anyway, so in practice it is just what you are holding.
• •Shelf and slab versions come across as the plain window, since there is no direct equivalent. You lose the shelf, which is part of why it does not go back the other way.

The conversion recipes only appear if you actually have the old mod installed, so nothing clutters your handbook otherwise.

Safe To Install

• •You do not need any of the mods it patches. Every patch is gated on the mod it belongs to and is skipped quietly if you do not have it. No errors, no red lines in your log.
• •It adds to items rather than replacing what is there. If a mod author later adds their own shelf support, both sit side by side and nothing is trampled. That matters more than it sounds - the obvious way of writing these patches quietly deletes the game's own data.
• •Nothing here changes how an item behaves anywhere else. It only describes how it should look sitting on a window.
• •Safe to add or remove from an existing world at any time.

Requests Welcome

This mod is never really finished. If something you use will not go on a window, or goes on looking wrong, say so in the comments and I will take a look - it is usually a small job.

Useful things to include: the mod it comes from, the item, and a screenshot if it is a sizing problem rather than a "will not place at all" problem. I patch against the version I can install and test, so telling me which version you are on helps.

Known Issues

• •A few conversion recipes clash with the old mods' own. Both mods use a single item in the grid for some things, so with both installed the game can pick either one. Which you get depends on the cell you put the window in - the top left gives the conversion. It sorts itself out once you stop running the old mod.
• •Very long items display small. A walking stick is about four blocks long and every window is one block wide, so it has to shrink a fair way to fit at all. There is no size that is both in scale and placeable.
• •Some things are deliberately edge-window only. Backpacks and metal plates are too deep for an ordinary sill, so they are sized to go on the edge version instead. Flip the window with a wrench and they fit.
• •Liquid portions are not patched on purpose. Water, milk, tea and so on display as the container holding them, which is how the game treats them everywhere else. Patching them would leave a floating puddle on your windowsill.

Screenshots & GIFs

A note on how this was made. AI was used in the creation of this mod - in the code, the JSON, and the text on this page (Images were made by me). The design, the decisions and every test in game are mine, and the only game source it was ever pointed at is Vintage Story's public GitHub repositories. If something is wrong, it is mine to fix - report it and I will.