From 582ac287f808c9daf31ebad5ae4f849473246165 Mon Sep 17 00:00:00 2001
From: loosewheel <76670709+loosewheel@users.noreply.github.com>
Date: Tue, 16 Nov 2021 04:44:02 +1000
Subject: [PATCH] Add files via upload

---
 docs/breaker.txt                |  44 +++++++++++++
 docs/collector.txt              |  33 ++++++++++
 docs/detector.txt               | 106 +++++++++++++++++++++++++++++++
 docs/digiswitch.txt             |  21 +++++++
 docs/dispenser.txt              |  47 ++++++++++++++
 docs/dropper.txt                |  40 ++++++++++++
 docs/fan.txt                    |  24 +++++++
 docs/hologram.txt               | 107 ++++++++++++++++++++++++++++++++
 docs/movefloor.txt              |  17 +++++
 docs/player_button.txt          |  21 +++++++
 docs/puncher.txt                |  69 ++++++++++++++++++++
 docs/siren.txt                  |  46 ++++++++++++++
 docs/solid_color_conductors.txt |   9 +++
 13 files changed, 584 insertions(+)
 create mode 100644 docs/breaker.txt
 create mode 100644 docs/collector.txt
 create mode 100644 docs/detector.txt
 create mode 100644 docs/digiswitch.txt
 create mode 100644 docs/dispenser.txt
 create mode 100644 docs/dropper.txt
 create mode 100644 docs/fan.txt
 create mode 100644 docs/hologram.txt
 create mode 100644 docs/movefloor.txt
 create mode 100644 docs/player_button.txt
 create mode 100644 docs/puncher.txt
 create mode 100644 docs/siren.txt
 create mode 100644 docs/solid_color_conductors.txt

diff --git a/docs/breaker.txt b/docs/breaker.txt
new file mode 100644
index 0000000..12c1883
--- /dev/null
+++ b/docs/breaker.txt
@@ -0,0 +1,44 @@
+Breaker
+-------
+* This block is only available if digilines and/or mesecons are loaded.
+
+Breakers dig the node directly in front of them and drop the item at the
+back of them. The node is only dug if the breaker has a tool that can
+dig it, of if it can be dug by hand. The tool is worn if used. Also acts
+as a digilines conductor. If the hopper mod is loaded, will take tools
+from the top and sides.
+
+Only the owner can dig or access the form of the locked version.
+
+UI
+
+Channel - digilines channel of breaker.
+Top 1 slot inventory - tool to use.
+Bottom 32 slot inventory - player's inventory.
+
+Mesecons
+	Digs the node in front when power is turned on, if it can.
+
+Digilines messages
+
+"break"
+	Digs the node in front when power is turned on, if it can.
+
+"eject side"
+	Drop the tool in the tool slot at the given side. Valid sides are "left",
+	"right", "back", "front". If side is omitted or invalid "front" is used.
+
+When a breaker digs a node or wears out the tool a digilines message is
+sent with the puncher's channel. The message is a table with the following
+keys:
+{
+	action = "<action>",
+	name = "<name>"
+}
+
+action
+	Will be "break" or "tool".
+
+name
+	For "break" action the registered node name of what was dug.
+	For "tool" action the registered tool name of the tool that wore out.
diff --git a/docs/collector.txt b/docs/collector.txt
new file mode 100644
index 0000000..4788b6a
--- /dev/null
+++ b/docs/collector.txt
@@ -0,0 +1,33 @@
+Collector
+---------
+* This block is only available if digilines is loaded.
+
+Picks up dropped items in adjacent block, with optional filtering. Also
+acts as a digilines conductor. If the hopper mod is loaded, will take items
+from the top and sides, and release them from the bottom.
+
+Only the owner can dig or access the form of the locked version.
+
+UI
+
+Channel - digilines channel of collector.
+Left 16 slot inventory - storage of picked up items.
+Right 8 slot inventory - Filter list. Place what items should be picked
+	up in this list. Leave empty to pick up all.
+Bottom 32 slot inventory - player's inventory.
+
+Digilines messages
+
+"start"
+	Start the collector.
+
+"stop"
+	Stop the collector.
+
+When items are picked up a digilines message is sent with the collector's
+channel. The message is a table with the following keys:
+{
+	action = "collect",
+	name = "<itemname>", -- name of picked up items.
+	count = <count> -- number of the item picked up.
+}
diff --git a/docs/detector.txt b/docs/detector.txt
new file mode 100644
index 0000000..2ebae9a
--- /dev/null
+++ b/docs/detector.txt
@@ -0,0 +1,106 @@
+Detector
+--------
+* This block is only available if digilines and/or mesecons are loaded.
+
+Detects items or entities within a given radius. Also acts as a
+digilines conductor.
+
+Only the owner can dig or access the form of the locked version.
+
+UI
+
+Channel - digilines channel of detector.
+Radius - block distance from detector to detect.
+Entities - if checked detects entities.
+Players - if checked detects players.
+Drops - if checked detects drops.
+Nodes - if checked detects nodes.
+
+mode:
+	All - detects to radius in all directions, including diagonal.
+	Forward - detects to radius directly in front of the detector (one block high).
+	Up - detects to radius directly above the detector (one block wide).
+	Down - detects to radius directly below the detector (one block wide).
+
+Mesecons
+	Mesecons power is turned on when something is detected, and turned off
+	when nothing is detected.
+
+Digilines messages
+
+"start"
+	Start the detector.
+
+"stop"
+	Stop the detector.
+
+"radius <n>"
+	Set radius of the detector. <n> should be a number from 1 to 5, and is
+	trimmed to this range.
+
+"entities <true|false>"
+	Set detection of entities on or off.
+
+"players <true|false>"
+	Set detection of players on or off.
+
+"drops <true|false>"
+	Set detection of drops on or off.
+
+"nodes <true|false>"
+	Set detection of nodes on or off.
+
+"mode all"
+"mode forward"
+"mode up"
+"mode down"
+	Set the detector's mode.
+
+When items or entities are detected a digilines message is sent with the
+detector's channel. A message is sent for each found item/entity. The
+message is a table with the following keys:
+{
+	action = "detect",
+	type = "<type>", -- will be "entity", "player", "drop" or "node"
+	name = "<name>",
+	label = "<label>",
+	pos = { x = n, y = n, z = n },
+	count = <count>,
+	hp = <number>,
+	height = <number>
+}
+
+type
+	Will be "entity", "player", "drop" or "node".
+
+name
+	For "entity" the registered entity name.
+	For "player" the player's name.
+	For "drop" the registered item name.
+	For "node" the registered item name.
+
+label
+	For "entity" the name tag text.
+	For "player" the player's name.
+	For "drop" the registered item name.
+	For "node" the registered item name.
+
+pos
+	The relative position of the detected item/entity from the detector,
+	facing the direction of the detector.
+	+x = right
+	-x = left
+	+z = forward
+	-z = behind
+	+y = above
+	-y = below
+
+count
+	The count of items for a "drop", or 1 for everything else.
+
+hp
+	Health points for players and entities. Zero for everything else.
+
+height
+	Height for players and entities. Zero for everything else. This is simply
+	the top position of the object's collision box.
diff --git a/docs/digiswitch.txt b/docs/digiswitch.txt
new file mode 100644
index 0000000..74f5dde
--- /dev/null
+++ b/docs/digiswitch.txt
@@ -0,0 +1,21 @@
+DigiSwitch
+----------
+* This block is only available if both digilines and mesecons are loaded.
+
+Digiswitches act as both a digilines message target and a digilines cable,
+as well as a mesecons power source. They can be placed beside each other
+to form a bank, horizontally or vertically.
+
+Right click the digiswitch to give it a channel.
+
+Mesecon power can be delivered at 6 sides of the digiswitch, the adjacent
+4 in the (x, z), above and below. Around the connector on these sides are a
+colored border indicating the side. The sides are named "red", "green",
+"blue", "yellow", "white" and "black".
+
+The digilines message sent to the digiswitch dictates the action, "on" or
+"off". The action can be followed with the side to act upon, separated by
+a space. eg. "on white". If a side is stated only that side is acted upon.
+If the side is omitted (or is invalid) all 6 sides are acted upon. If the
+side name "switch" is give the power is supplied the same as a mesecons
+switch (all horizontal sides, one below, this height and one above).
diff --git a/docs/dispenser.txt b/docs/dispenser.txt
new file mode 100644
index 0000000..c7a3e9c
--- /dev/null
+++ b/docs/dispenser.txt
@@ -0,0 +1,47 @@
+Dispenser
+---------
+* This block is only available if digilines and/or mesecons are loaded.
+
+Contains an inventory and dispenses (with velocity) an item on command.
+Also acts as a digilines conductor. If the hopper mod is loaded, will take
+items from the top and sides, and release them from the bottom.
+
+Dispensers support mobs mod if loaded and Spawn mobs setting is enabled.
+Will spawn the entity from an 'egg' if possible, or the 'egg' is dispensed.
+If a chicken egg is dispensed a 10% chance a chicken is dispensed instead.
+If the spawned entity can be owned (or tamed) and the dispenser is owned
+the owner of the dispenser is set as the owner of the entity.
+
+Only the owner can dig or access the form of the locked version.
+
+UI
+
+Channel - digilines channel of dispenser.
+Top 16 slot inventory - storage of items to dispense.
+Bottom 32 slot inventory - player's inventory.
+
+Mesecons
+	Dispenses the next item when power is turned on.
+
+Digilines messages
+
+"dispense"
+	Dispenses the next item. No dispense if dispenser is empty.
+
+"dispense <slot>"
+	Dispenses 1 item from the given slot (1 to 16). No dispense if slot is
+	empty.
+	eg. "dispense 7"
+
+"dispense <itemname>"
+	Dispenses 1 item of the given name. No dispense if dispenser does not
+	contain the item.
+	eg. "dispense default:stone"
+
+When an item is dropped a digilines message is sent with the dropper's
+channel. The message is a table with the following keys:
+{
+	action = "dispense",
+	name = "<itemname>", -- name of dropped item
+	slot = <slot> -- slot number the item was taken from (1 to 16).
+}
diff --git a/docs/dropper.txt b/docs/dropper.txt
new file mode 100644
index 0000000..0a17175
--- /dev/null
+++ b/docs/dropper.txt
@@ -0,0 +1,40 @@
+Dropper
+-------
+* This block is only available if digilines and/or mesecons are loaded.
+
+Contains an inventory and drops an item on command. Also acts as a
+digilines conductor. If the hopper mod is loaded, will take items from the
+top and sides, and release them from the bottom.
+
+Only the owner can dig or access the form of the locked version.
+
+UI
+
+Channel - digilines channel of dropper.
+Top 16 slot inventory - storage of items to drop.
+Bottom 32 slot inventory - player's inventory.
+
+Mesecons
+	Drops the next item when power is turned on.
+
+Digilines messages
+
+"drop"
+	Drops the next item. No drop if dropper is empty.
+
+"drop <slot>"
+	Drops 1 item from the given slot (1 to 16). No drop if slot is empty.
+	eg. "drop 7"
+
+"drop <itemname>"
+	Drops 1 item of the given name. No drop if dropper does not contain the
+	item.
+	eg. "drop default:stone"
+
+When an item is dropped a digilines message is sent with the dropper's
+channel. The message is a table with the following keys:
+{
+	action = "drop",
+	name = "<itemname>", -- name of dropped item
+	slot = <slot> -- slot number the item was taken from (1 to 16).
+}
diff --git a/docs/fan.txt b/docs/fan.txt
new file mode 100644
index 0000000..7eed02f
--- /dev/null
+++ b/docs/fan.txt
@@ -0,0 +1,24 @@
+Fan
+---
+* This block is only available if digilines and/or mesecons are loaded.
+
+Fans blow any entity, player or drop in front of the fan for 5 node
+spaces in the direction of the fan. A node placed in these 5 spaces blocks
+the fan's action beyond the placed node. Also acts as a digilines conductor.
+
+Only the owner can dig or access the form of the locked version.
+
+UI
+
+Channel - digilines channel of fan.
+
+Mesecons
+	Fan runs while power is turned on.
+
+Digilines messages
+
+"start"
+	Starts the fan.
+
+"stop"
+	Stops the fan.
diff --git a/docs/hologram.txt b/docs/hologram.txt
new file mode 100644
index 0000000..70e2fe7
--- /dev/null
+++ b/docs/hologram.txt
@@ -0,0 +1,107 @@
+Hologram
+--------
+* This block is only available if digilines is loaded.
+
+Projects a hologram above the hologram node. Also acts as a digilines
+conductor.
+
+The hologram occupies a space 15x15x15. The lower level of the hologram
+is 2 blocks above the hologram node (so the hologram node can be hidden
+beneath a floor). The hologram node is in the x, z horizontal center, ie.
+the hologram can extend 7 blocks in each direction from the node.
+
+Colored blocks cannot be interacted with, but will be replaced if built
+into. If a block already exists where the hologram requires a color, it
+is not placed unless the block is a color block from this hologram block.
+If an existing block is dug while a holograms is displayed it is not
+filled in, the hologram has to be re-displayed.
+
+Only the owner can dig or access the form of the locked version.
+
+UI
+
+Channel - digilines channel of hologram.
+
+Digilines messages
+
+"clear"
+	Removes any hologram currently projected.
+
+table
+	To display a hologram a table of dimensions holo[15][15][15] is sent as
+	the message. The table structure is holo[layer][line][block]. In the
+	direction the hologram block is facing, the layers run from bottom to
+	top, the lines run from back to front, and the blocks run from right to
+	left. Each block value can be nil for no display, or a string with the
+	color. Valid colors are:
+		"black"
+		"gray"
+		"silver"
+		"white"
+		"sky"
+		"blue"
+		"cyan"
+		"lime"
+		"green"
+		"magenta"
+		"purple"
+		"pink"
+		"red"
+		"yellow"
+		"orange"
+		"brown"
+	If anything else no color block is placed.
+
+	For example:
+	{
+		{
+			{ "black", nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, "green" },
+			{},
+			{},
+			{},
+			{},
+			{},
+			{},
+			{},
+			{},
+			{},
+			{},
+			{},
+			{},
+			{},
+			{ "blue", nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, "red" }
+		},
+		{},
+		{},
+		{},
+		{},
+		{},
+		{},
+		{},
+		{},
+		{},
+		{},
+		{},
+		{},
+		{},
+		{
+			{ "orange", nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, "lime" },
+			{},
+			{},
+			{},
+			{},
+			{},
+			{},
+			{},
+			{},
+			{},
+			{},
+			{},
+			{},
+			{},
+			{ "purple", nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, nil, "yellow" }
+		},
+	}
+
+	will display a hologram with a black and green block at the back of
+	the bottom layer, and orange and lime at the back of the top layer.
diff --git a/docs/movefloor.txt b/docs/movefloor.txt
new file mode 100644
index 0000000..fe1916a
--- /dev/null
+++ b/docs/movefloor.txt
@@ -0,0 +1,17 @@
+MoveFloor
+---------
+* This block is only available if mesecons and mesecons_mvps is loaded.
+
+The MoveFloor block responds to a mesecons power source in the 4 horizontal
+directions. If the power source is one higher the MoveFloor moves up to
+that height. If the power source is one lower the MoveFloor moves down to
+that height. Powering an adjacent block has no effect. The power source
+should be turned off before another move or the MoveFloor will oscillate.
+
+Any horizontally adjoining MoveFloor acts as a single block (only one
+needs to be powered).
+
+The MoveFloor will move up to 3 blocks stacked on it.
+
+If using a DigiSwitch as the power source use the side name "switch" or
+the MoveFloor will not move.
diff --git a/docs/player_button.txt b/docs/player_button.txt
new file mode 100644
index 0000000..7b82312
--- /dev/null
+++ b/docs/player_button.txt
@@ -0,0 +1,21 @@
+Player Button
+-------------
+* This block is only available if both digilines and digistuff are loaded.
+
+When pressed sends a digilines message with the name of the player that
+pressed the button.
+
+The first time the button is right clicked a form opens to set the
+digilines channel. After that right click presses the button. The
+digilines cannot be changed after its set.
+
+UI
+
+Channel - digilines channel of button.
+
+When the button is pressed a digilines message is sent with the button's
+channel in the form:
+{
+	action = "player",
+	name = <player name>
+}
diff --git a/docs/puncher.txt b/docs/puncher.txt
new file mode 100644
index 0000000..dd19c5c
--- /dev/null
+++ b/docs/puncher.txt
@@ -0,0 +1,69 @@
+Puncher
+-------
+* This block is only available if digilines and/or mesecons are loaded.
+
+Punches players or entities within a given reach. Also acts as a
+digilines conductor.
+
+Only the owner can dig or access the form of the locked version.
+
+UI
+
+Channel - digilines channel of puncher.
+Reach - block distance from puncher to punch.
+Entities - if checked punches entities.
+Players - if checked punches players.
+
+mode:
+	Forward - punches to reach extent directly in front of the puncher (one block high).
+	Up - detects to reach extent directly above the puncher (one block wide).
+	Down - detects to reach extent directly below the puncher (one block wide).
+
+Mesecons
+	Punches the next item when power is turned on.
+
+Digilines messages
+
+"start"
+	Start the puncher.
+
+"stop"
+	Stop the puncher.
+
+"reach <n>"
+	Set reach of the puncher. <n> should be a number from 1 to 5, and is
+	trimmed to this range.
+
+"entities <true|false>"
+	Set punching of entities on or off.
+
+"players <true|false>"
+	Set punching of players on or off.
+
+"mode forward"
+"mode up"
+"mode down"
+	Set the puncher's mode.
+
+"punch"
+	Action a single punch if the puncher is turned on.
+
+When a player or entity is punched a digilines message is sent with the
+puncher's channel. The message is a table with the following keys:
+{
+	action = "punch",
+	type = "<type>", -- will be "entity" or "player"
+	name = "<name>",
+	label = "<label>"
+}
+
+type
+	Will be "entity" or "player".
+
+name
+	For "entity" the registered entity name.
+	For "player" the player's name.
+
+label
+	For "entity" the name tag text.
+	For "player" the player's name.
diff --git a/docs/siren.txt b/docs/siren.txt
new file mode 100644
index 0000000..05eafcd
--- /dev/null
+++ b/docs/siren.txt
@@ -0,0 +1,46 @@
+Siren
+-----
+* This block is only available if digilines and/or mesecons are loaded.
+
+Plays a sound repeatedly while active. Also acts as a digilines conductor.
+digilines conductor.
+
+Only the owner can dig or access the form of the locked version.
+
+UI
+
+Channel - digilines channel of siren.
+Distance - block distance the sound can be heard (range 0 to 100).
+Volume - volume the sound is played.
+Sound - select Buzzer, Horn, Raid or Siren.
+
+Mesecons
+	Sound plays while mesecons power is applied.
+
+Digilines messages
+
+"start"
+	Start the siren (turn on).
+
+"stop"
+	Stop the siren (turn off).
+
+"distance <n>"
+	Set block distance the sound can be heard. <n> should be a number
+	from 1 to 100, and is trimmed to this range.
+
+"volume <n>"
+	Set the sound volume. <n> should be a number from 1 to 100, and is
+	trimmed to this range.
+
+"sound buzzer"
+"sound horn"
+"sound raid"
+"sound siren"
+	Set the sound of the siren.
+
+"siren on"
+	Activate the siren, if its on.
+
+"siren off"
+	deactivate the siren.
diff --git a/docs/solid_color_conductors.txt b/docs/solid_color_conductors.txt
new file mode 100644
index 0000000..9fc456e
--- /dev/null
+++ b/docs/solid_color_conductors.txt
@@ -0,0 +1,9 @@
+Solid Color Conductors
+----------------------
+* These blocks are only defined if mesecons and unifieddyes are loaded.
+
+Provides 2 blocks that can be colored the same as Solid Color Block (with
+the air brush) and is both a mesecons and digilines conductor.
+
+The Solid Color Conductor block conducts in the 'default' directions and
+the Solid Color Horizontal Conductor only conducts horizontally.