Window Storage Lib [Legacy]

Window Storage Lib

Library for my window storage mods - can be used by modders to make their own as well

Requirements & Important Info

Features

Animations

• • Animations can be called absolutely anything.
• • Uses animationShapePath to define animations from a separate shape file, which can hold multiple animations.
• • You can use isWindow to animate things without actually changing the open/closed state.

Slot, Frame, & Collision Groups

• • slotGroups now have their own dedicated section in the JSON.
• • Supports any number of slot groups, with a max of 7 slots per group. You can now use asymmetrical counts per group (e.g., 3, 5, 4).
• • Transforms can be adjusted uniquely per group (spacing, startOffset, zCenter, yOffset, rotateY).
• • The selectionBoxes at the end of the JSON are used to determine the size and placement of item slots.
• • frameBoxGroups have their own JSON section. You can tie animations and boxes together for interactions using animOpen / animClose alongside openFrameBox and closedFrameBox.
• • Allows for multiple independent animations. You can also use isWindow: false to stop the open/closed state from changing.
• • Includes arrayed staticFrameBoxes for fixed elements that don't need animations.
• • collisionBoxGroups now have their own JSON section. Uses openCollisionBox and closedCollisionBox for animated parts, plus staticCollisionBoxes for normal static elements.

Opening & Closing

• • Includes a canOpen attribute so you can make window styles that stay closed.
• • FrameBoxGroups completely manage open/close interactions via selection boxes.
• • The open/closed toggle runs **Server-Side Only**, which allows linkedOpen to sync perfectly.
• • The linkedOpen attribute syncs stacked vertical windows so they toggle open together. Without it, stacked windows open independently.
• • Plays a nice "swoosh" sound whenever a window pane is toggled.
• • Breaking an open window will correctly drop its regular closed item variant.

Display, Stagger & Stacking

• • Tooltips show the current display mode per group, individual slot item interactions, and block placement options based on player direction.
• • Includes 4 stagger configurations (Straight, Alternating, Random, Fine Tune) along with slotGroup display interactions.
• • Snaps items directly to texture pixels for a cleaner look.
• • Allows item placement fine-tuning in real-time via the in-game TFEdit menu (onWindowStorageTransform).
• • Detects when a BEWindowStorageLib block is placed directly below. When stacked, it completely hides slot selection boxes and blocks item placement. Display mode info is also automatically hidden when fully stacked.
• • You can manually pick which slot groups hide when stacked using the stackingHideGroups attribute.
• • Add placeWith: "shape path" and pairedWith: "below" to your JSON to automatically lay down stacked multi-block structures. Great for linking animations with linkedOpen. For 2-high or 3-high layouts, you can pair shapes together so they are placed or broken as one. If it detects a block blocking the space above, it throws a warning and prevents placement.

Food Storage, Lighting & Weather

• • Food Storage: Integrates with vanilla food spoil rules. The spoil rate changes naturally based on whether the window is open or closed, and shows per-slot freshness info and ripening spot metrics directly in the tooltip.
• • Lighting: Placed items with LightHsv values project light, showing their level and color. Lighting updates only when the brightest value shifts (preventing constant flicker). The legacy ghost block lighting bug is also completely fixed.
• • Rain Sound: Simulates rain noise against window panes. Uses a single sound instance across all active window instances to preserve frame rates. Volume scales with real-time rainfall intensity and fades naturally. Can be disabled per style using disableRainSound. When windows are toggled open, it dynamically blends into ambient weather sound.

Controls & Stagger Modes

Interactions are designed to be smooth and intuitive. You can fully interact with slots even while holding items.

• •Right Click on FrameBox to interact with window states
• •Right Click on an empty slot with an item to place it
• •Right Click on a filled slot to retrieve your item
• •Wrench + Right Click on a slot with an item to rotate it anti-clockwise (remembers rotation when removed)
• •Wrench + Sprint + Right Click to rotate clockwise
• •Sneak + Sprint + Right Click on any slot to cycle display modes for that entire group
• •Sprint + Right Click on a slot in Random Mode to shuffle item depth
• •Sprint + Right Click on a slot in Fine Tune Mode to move the item forward
• •Sneak + Right Click on a slot in Fine Tune Mode Only to move the item backwards

Stagger Modes Explained

Stagger modes can be applied per group (Group 0, 1, and 2 are entirely independent). The current setup is shown via an in-game Info Box format (Display 1/2/3 : Mode)

• •Straight / Alternating: Clean, structured alignments
• •Random Mode: Changes depth naturally per group. Use interactions to shuffle
• •Fine Tune Mode: Adjust the precise depth of an item per individual slot
• •Smart Hiding: Automatically hides slot group info boxes, perish rates, and stagger modes when stacked on other BEWindowStorageLib windows

Config File Options

Settings are managed via Window Storage Lib. Should now automatically update the config file with the latest settings. I highly recommend installing Config Lib and Auto Config Lib to allow mod settings to be changed in game.

• •Universal Rain on Window Volume: Range 0 (Off) to 10 (Loud)
• •Universal Rain Sound Range: 1 to 64 blocks
• •Universal Animation Speed: 1 (Very Slow) to 5 (Very Fast)
• •Universal Slot Rotation Degrees: 5 to 90 degrees
• •Universal Slot Stagger Strength: 1 (Subtle) to 5 (Strong)
• •Room Safe Opening: False (Default): Standard functions, True: Rooms will stay insulated whether windows are open/closed - all windows need to be closed before changing to work properly

{
        "onWindowStorageTransformByType": {
            "*": {
                "translation": {
                    "x": 0.0,
                    "y": 0.00,
                    "z": 0.0
                },
                "rotation": {
                    "x": 0,
                    "y": 0,
                    "z": 0
                },
                "origin": {
                    "x": 0.5,
                    "y": 0.0,
                    "z": 0.5
                },
                "scale": 0.0
            }