Skip to content

Add machine-toggle tool #1590

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Bumber64 wants to merge 2 commits into
base: master
Choose a base branch
from
+404 −341
Open

Add machine-toggle tool #1590

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f38e020
Add `machine-toggle` tool
Bumber64 May 25, 2026
8579680
Rename machine-toggle to machine-toggle.lua
Bumber64 May 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions changelog.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,14 @@ Template for new versions:
# Future

## New Tools
- `machine-toggle`: interface for toggling gear assemblies, as well as pressure plates (previously in `trackstop`) (available only if ``armok`` tools are shown)

## New Features

## Fixes

## Misc Improvements
- `trackstop`: ``pressureplate`` overlay moved to `machine-toggle` as an ``armok`` tool

## Removed

Expand Down
21 changes: 21 additions & 0 deletions docs/machine-toggle.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
machine-toggle
==============

.. dfhack-tool::
:summary: Overlay to modify pressure plates and gear assemblies after construction.
:tags: fort armok buildings interface

This script provides 2 overlays that are managed by the `overlay` framework.
The script does nothing when executed.
Track stops and rollers are handled by `trackstop`.

The ``pressureplate`` overlay allows the player to change the trigger settings
of a selected pressure plate after it has been constructed. Manual value entry
of ranges for minecart and creature triggers is provided, allowing greater
precision than the game interface normally permits. Incrementing or decrementing
values always restricts them to the usual intervals.

The ``gearassembly`` overlay allows the player to toggle the state of a selected
gear assembly without linking it to a lever first. This is useful for dwarfputing
and other applications where it may be desirable to default to the disengaged
state until triggered.
11 changes: 3 additions & 8 deletions docs/trackstop.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,15 @@ trackstop
=========

.. dfhack-tool::
:summary: Overlay to allow changing track stop and related building settings after construction.
:summary: Overlay to allow changing track stop and roller settings after construction.
:tags: fort buildings interface

This script provides 3 overlays that are managed by the `overlay` framework.
This script provides 2 overlays that are managed by the `overlay` framework.
The script does nothing when executed.
Pressure plates and gear assemblies are handled by `machine-toggle`.

The ``trackstop`` overlay allows the player to change the friction and dump
direction of a selected track stop after it has been constructed.

The ``rollers`` overlay allows the player to change the roller direction and
speed of a selected roller after it has been constructed.

The ``pressureplate`` overlay allows the player to change the trigger settings
of a selected pressure plate after it has been constructed. Manual value entry
of ranges for minecart and creature triggers is provided, allowing greater
precision than the game interface normally permits. Incrementing or decrementing
values always restricts them to the usual intervals.
Loading
Loading