summaryrefslogtreecommitdiff
path: root/docs/piston.txt
diff options
context:
space:
mode:
authorcheapie <no-email-for-you@example.com>2021-02-21 03:50:59 -0600
committercheapie <no-email-for-you@example.com>2021-02-21 03:50:59 -0600
commitf0ce172302a02c854a52bae449e6dd4c4287f949 (patch)
tree393a106ed0feba7403018519d28ae004b265a56c /docs/piston.txt
parent39a7904f07b943c8ce464ec4486f208ff78ec109 (diff)
downloaddigistuff-f0ce172302a02c854a52bae449e6dd4c4287f949.tar
digistuff-f0ce172302a02c854a52bae449e6dd4c4287f949.tar.gz
digistuff-f0ce172302a02c854a52bae449e6dd4c4287f949.tar.bz2
digistuff-f0ce172302a02c854a52bae449e6dd4c4287f949.tar.xz
digistuff-f0ce172302a02c854a52bae449e6dd4c4287f949.zip
Split documentation from README out into separate files
Diffstat (limited to 'docs/piston.txt')
-rw-r--r--docs/piston.txt7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/piston.txt b/docs/piston.txt
new file mode 100644
index 0000000..0ac9e22
--- /dev/null
+++ b/docs/piston.txt
@@ -0,0 +1,7 @@
+How to use the digilines pistons:
+The following commands are accepted as strings: "extend" (extend the piston), "retract" (retract the piston), and "retract_sticky" (retract the piston, pulling one node like a sticky piston)
+You can also send a command as a table. If so, the fields that can be used in the table are as follows:
+* action: "extend" or "retract"
+* max: The maximum number of nodes to push/pull, cannot be set higher than 16. Set to 0 (or omit) when retracting to perform a non-sticky retraction.
+* allsticky: Pull a whole stack of nodes (like movestone), not just one.
+* sound: The sound to make. "mesecons" for the mesecons piston sounds, "digilines" for the digilines piston sounds (default), or "none" for no sounds at all.