summaryrefslogtreecommitdiff
path: root/mesecons_detector/doc
diff options
context:
space:
mode:
authorJeija <norrepli@gmail.com>2015-11-20 20:14:50 +0100
committerJeija <norrepli@gmail.com>2015-11-20 20:14:50 +0100
commit0ec771bf7d8d95f24b46d2f608cccc109ec2de4f (patch)
tree646ef2a1e6d7750fa6e12d648986ef2ff7e78fee /mesecons_detector/doc
parent75bd081a67a2ac52b8a0eea1e051a456d288c71d (diff)
downloadmesecons-0ec771bf7d8d95f24b46d2f608cccc109ec2de4f.tar
mesecons-0ec771bf7d8d95f24b46d2f608cccc109ec2de4f.tar.gz
mesecons-0ec771bf7d8d95f24b46d2f608cccc109ec2de4f.tar.bz2
mesecons-0ec771bf7d8d95f24b46d2f608cccc109ec2de4f.tar.xz
mesecons-0ec771bf7d8d95f24b46d2f608cccc109ec2de4f.zip
Major change: Documentation is now included with mesecons, the website just extracts the documentation in a more readable format
This makes development of new features easier, as documentation can automatically be updated on the website without modifying the website's code! Every mod that has nodes in the mesecons modpack has a "doc" folder that contains subfolders with recipe, description and preview of the block. The website will discover which documentation is available by reading the documentation.json file.
Diffstat (limited to 'mesecons_detector/doc')
-rw-r--r--mesecons_detector/doc/nodedetector/description.html6
-rw-r--r--mesecons_detector/doc/nodedetector/preview.pngbin0 -> 49571 bytes
-rw-r--r--mesecons_detector/doc/nodedetector/recipe.pngbin0 -> 10043 bytes
-rw-r--r--mesecons_detector/doc/objectdetector/description.html3
-rw-r--r--mesecons_detector/doc/objectdetector/preview.pngbin0 -> 85870 bytes
-rw-r--r--mesecons_detector/doc/objectdetector/recipe.pngbin0 -> 9813 bytes
6 files changed, 9 insertions, 0 deletions
diff --git a/mesecons_detector/doc/nodedetector/description.html b/mesecons_detector/doc/nodedetector/description.html
new file mode 100644
index 0000000..be34fde
--- /dev/null
+++ b/mesecons_detector/doc/nodedetector/description.html
@@ -0,0 +1,6 @@
+The node detector is a receptor. It changes its state when either any node
+or a specific node is detected. Right-click it to set a nodename to scan for.
+It can also receive digiline signals. You can either send "GET" and it will
+respond with the detected nodename or you can send any other string and it will
+set this string as the node to scan for.
+Nodenames must include the mod they reside in, so for instance default:dirt, not just dirt.
diff --git a/mesecons_detector/doc/nodedetector/preview.png b/mesecons_detector/doc/nodedetector/preview.png
new file mode 100644
index 0000000..1f78161
--- /dev/null
+++ b/mesecons_detector/doc/nodedetector/preview.png
Binary files differ
diff --git a/mesecons_detector/doc/nodedetector/recipe.png b/mesecons_detector/doc/nodedetector/recipe.png
new file mode 100644
index 0000000..958c7e6
--- /dev/null
+++ b/mesecons_detector/doc/nodedetector/recipe.png
Binary files differ
diff --git a/mesecons_detector/doc/objectdetector/description.html b/mesecons_detector/doc/objectdetector/description.html
new file mode 100644
index 0000000..c8315e8
--- /dev/null
+++ b/mesecons_detector/doc/objectdetector/description.html
@@ -0,0 +1,3 @@
+The object detector is a receptor. It changes its state when a player approaches.
+Right-click it to set a name to scan for.
+It can also receive digiline signals which are the name to scan for on the specified channel in the right-click menu.
diff --git a/mesecons_detector/doc/objectdetector/preview.png b/mesecons_detector/doc/objectdetector/preview.png
new file mode 100644
index 0000000..85c4dea
--- /dev/null
+++ b/mesecons_detector/doc/objectdetector/preview.png
Binary files differ
diff --git a/mesecons_detector/doc/objectdetector/recipe.png b/mesecons_detector/doc/objectdetector/recipe.png
new file mode 100644
index 0000000..a1cee00
--- /dev/null
+++ b/mesecons_detector/doc/objectdetector/recipe.png
Binary files differ