Skip to content

About

Timberborn mod for draggable straight and winding staircases with terrain-adaptive platforms.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

1 Commit

Folders and files

Repository files navigation

Draggable Stairs

Timberborn 1.1, version 0.4.3. Requires Harmony 2.4.1+.

Spiral (rotating) stairs

Select the game's Spiral Stairs tool and rotate/flip the first stair to choose the turn. Drag diagonally from the starting tile to the opposite corner of that turn's 2x2 footprint. One drag places four connected spiral stairs at starting heights Z, Z+1, Z+2, Z+3, followed by a platform landing over the starting square at walking height Z+4. The footprint follows the selected stair's upper exit and flip direction. Drag farther to enlarge the rectangle: its four corners remain spiral stairs, with straight stairs filling every intervening edge tile. Each piece rises one level. A 3x3 perimeter rises 8 levels; a 4x3 perimeter rises 10. The landing above the first square matches that total rise. The interior stays empty. Locked spiral and straight stairs can be previewed and unlocked on mouse release. Clicking or dragging along only one edge places a single spiral stair.

For example, with the default rotation and no flip (grid coordinates):

     third stair Z+2    fourth stair Z+3
     second stair Z+1   first stair Z / landing Z+4

Start the next drag on that landing, retaining the same rotation and flip, to build the next winding level directly above the previous one. Repeat level by level.

Supports adapt to terrain and existing finished or planned structures. The mod prefers the tallest unlocked platforms that fit, minimizing the support stack. It selects single, double, or triple platforms according to clearance. A platform spanning a stair uses at least two levels, preserving both its lower entrance and upper exit. This also works over straight stairs. Unlocked platform types are preferred.

Unlocking while designing

Designing does not require researching the stair or platform first. If unlocked platforms can support the route, the planner uses those. Otherwise it previews the additional pieces needed to complete the physically possible sections, minimizing the number of new building types to unlock (then their total science cost). Obstacles still produce gaps, without prompting for research that cannot resolve them.

On mouse release, the game shows its normal unlock confirmation for each required type. The complete preview stays frozen until the prompts finish. Accepting all of them commits construction as one undo operation; declining, lacking science, or exiting the tool leaves no construction queued. As with ordinary game research, unlocks already accepted remain researched even if a later prompt is declined. The site is revalidated before committing in case something changed during the dialogs.

For equally efficient support stacks, taller platforms are placed at the bottom, with shorter remainder pieces above. For example, height 7 uses 3+3+1 from bottom to top. Clearance takes precedence: a column may use short-long-short when existing stairs or other obstructions require it. The planner checks each combination before choosing it; it never rearranges validated platforms into an obstruction. This applies to straight, spiral, and mixed rectangular staircases.

For spiral drags, colliding stairs or an unavailable support chain are skipped while independent valid pieces are placed. If only the top of a column is blocked, its reachable lower platforms are retained. A blocked finishing landing does not cancel the four stairs. Existing compatible supports are reused. Skipped stairs can leave gaps in the route; the preview reports skipped stairs/landings. The mod does not demolish or replace existing structures. Each drag remains one undo operation.

Straight stairs

Enhances the existing Stairs tool. Select Stairs, rotate using the usual game controls, then hold the build mouse button and drag along the stairs' axis. Drag toward the upper exit to ascend, or toward the lower entrance to descend. Release to queue construction. Sideways cursor movement is ignored. Clicking still places one staircase.

On flat ground, an ascending four-tile drag needs supports of height 0, 1, 2, and 3. Straight stairs now use the same tallest-unlocked-platform selection as spiral stairs, so this uses one single, one double, and one triple when all are unlocked and fit. Lower terrain adds support height; higher terrain reduces it. Existing solid buildings and planned platforms can provide support. The initial stair's picked height anchors the slope: each following stair rises or falls exactly one level.

Placeable stairs and supports appear in the preview. Blocked top pieces are skipped while reachable lower platforms are retained, matching spiral drags; later stairs keep their original heights, leaving gaps where obstacles occur. The drag can be built whenever at least one piece is placeable. The mod does not remove terrain or demolish buildings. Stairs need two cells of vertical clearance. Necessary missing unlocks are confirmed on release. The warning area reports the number of stairs and platforms; the normal building information section still describes one stair.

Uses ordinary faction stairs and platforms with normal material costs and construction rules. One drag is one undo operation. No custom save components, buildings, models, or game assemblies are packaged; existing structures remain usable without this mod.

Install

Extract dist/DraggableStairs-0.4.3.zip into your Timberborn Mods folder (normally Documents/Timberborn/Mods). The layout should be:

Mods/DraggableStairs/version-1.1/manifest.json
Mods/DraggableStairs/version-1.1/DraggableStairs.dll

Enable Harmony and Draggable Stairs in the game's mod manager and restart Timberborn.

Build and verification

Run ./build.ps1 using .NET SDK 8. Pass -TimberbornPath, -HarmonyPath, or -DotnetPath to override paths. The build can reuse the local SDK from the sibling Mushrooms project. No NuGet packages or network restore are required.

The build runs straight and spiral geometry regressions, 500 randomized terrain cases, and checks every Harmony patch's target method, injected fields, and parameter types against the installed game DLLs. Spiral tests use collision masks and navigation edges read from the installed Folktails and Iron Teeth blueprints. They cover all rotations/flips, four stacked levels, clearance over both kinds of stairs, blocked/duplicate pieces, terrain, and height limits. These checks do not execute Unity or replace an in-game smoke test.

In-game smoke test

  • Folktails and Iron Teeth: drag four stairs over flat ground; expect six platforms total.
  • Repeat across a depression and a rise; check that the stair slope remains continuous.
  • Test all four rotations and backward dragging from an elevated start.
  • Start from a solid roof or platform; verify existing supports are reused.
  • Drag into a tree, building, high terrain, or map ceiling; confirm blocked columns are skipped and remaining stairs can be placed.
  • Cancel a drag, switch tools, undo a completed drag, then save and reload.
  • Verify construction costs, builder access, and beavers walking the completed staircase.
  • Spiral stairs: drag the 2x2 footprint in both flip directions; verify four connected stairs and the landing at +4. Repeat from that landing to reach +8 and +12.
  • Check that double/triple platforms over straight and spiral stairs preserve both exits.
  • Block only the finishing landing, then only one stair; verify the remaining pieces still place. Repeat over planned construction and existing stairs.

Spiral dragging and winding geometry in 0.2.0 are confirmed working in-game by the user. Version 0.4.3 passes 273 automated checks, including mixed rectangles, all rotations and flips, edge connections, raised landings, and stacked mixed levels. The native multi-unlock prompt flow needs in-game confirmation. Straight drags are limited to 64 stairs and 2048 total pieces; spiral drags build one rectangular winding level at a time (up to 64 stairs; larger cursor drags are clamped). Both modes limit total pieces to 2048. Vanilla Folktails and Iron Teeth are targeted. Other factions require compatible Stairs.*/WoodenStairs.*/SpiralStairs.* and platform tools. Leaf Coats names, geometry, and navigation edges were checked against its installed assets.

Version 0.4.3 keeps lower supports under blocked stairs or upper platforms, including winding landings. It can shorten the final support to fit below an obstruction; it never adds unsupported pieces above the gap.

License

MIT, copyright 2026 bednarpe. This license covers this mod's source and documentation; Timberborn and third-party dependencies retain their own licenses.

About

Timberborn mod for draggable straight and winding staircases with terrain-adaptive platforms.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages