Skip to content

Commit

Permalink
Major change: Documentation is now included with mesecons, the websit…
Browse files Browse the repository at this point in the history
…e 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.
Jeija committed Nov 20, 2015
1 parent 75bd081 commit 0ec771b
Showing 146 changed files with 142 additions and 11 deletions.
62 changes: 62 additions & 0 deletions documentation.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
{
"Conductors" : {
"Mesecon" : "mesecons/doc/mesecon",
"Insulated Wire" : "mesecons_insulated/doc/insulated",
"T-Junction" : "mesecons_extrawires/doc/tjunction",
"Crossing" : "mesecons_extrawires/doc/crossing",
"Corner" : "mesecons_extrawires/doc/corner",
"Vertical Wire" : "mesecons_extrawires/doc/vertical",
"Mese" : "mesecons_extrawires/doc/mese"
},
"Receptors" : {
"Power Plant" : "mesecons_powerplant/doc/powerplant",
"Blinky Plant" : "mesecons_blinkyplant/doc/blinkyplant",
"Switch" : "mesecons_switch/doc/switch",
"Object Detector" : "mesecons_detector/doc/objectdetector",
"Node Detector" : "mesecons_detector/doc/nodedetector",
"Wall Lever" : "mesecons_walllever/doc/walllever",
"Pressure Plate" : "mesecons_pressureplates/doc/pressureplate_wood",
"Pressure Plate" : "mesecons_pressureplates/doc/pressureplate_stone",
"Water Turbine" : "mesecons_hydroturbine/doc/waterturbine",
"Solar Panel" : "mesecons_solarpanel/doc/solarpanel",
"Wall Button" : "mesecons_button/doc/button"
},
"Effectors" : {
"Noteblock" : "mesecons_noteblock/doc/noteblock",
"Lamp" : "mesecons_lamp/doc/lamp",
"Piston" : "mesecons_pistons/doc/piston",
"Sticky Piston" : "mesecons_pistons/doc/piston_sticky",
"Movestone" : "mesecons_movestones/doc/movestone",
"Sticky Movestone" : "mesecons_movestones/doc/movestone_sticky",
"Removestone" : "mesecons_random/doc/removestone",
"Ghoststone" : "mesecons_random/doc/ghoststone",
"Command Block" : "mesecons_commandblock/doc/commandblock",
"Lightstones" : {
"Dark Grey" : "mesecons_lightstone/doc/lightstone_darkgrey",
"Light Grey" : "mesecons_lightstone/doc/lightstone_lightgrey",
"Green" : "mesecons_lightstone/doc/lightstone_green",
"Red" : "mesecons_lightstone/doc/lightstone_red",
"Blue" : "mesecons_lightstone/doc/lightstone_blue",
"Yellow" : "mesecons_lightstone/doc/lightstone_yellow"
}
},
"Logic" : {
"Luacontroller" : "mesecons_luacontroller/doc/luacontroller",
"Torch" : "mesecons_torch/doc/torch",
"Delayer" : "mesecons_delayer/doc/delayer",
"Gates" : {
"Diode" : "mesecons_gates/doc/diode",
"NOT Gate" : "mesecons_gates/doc/not",
"AND Gate" : "mesecons_gates/doc/and",
"NAND Gate" : "mesecons_gates/doc/nand",
"OR Gate" : "mesecons_gates/doc/or",
"NOR Gate" : "mesecons_gates/doc/nor",
"XOR Gate" : "mesecons_gates/doc/xor"
}
},
"Crafts" : {
"Silicon" : "mesecons_materials/doc/silicon",
"Glue" : "mesecons_materials/doc/glue",
"Fiber" : "mesecons_materials/doc/fiber"
}
}
1 change: 1 addition & 0 deletions mesecons/doc/mesecon/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Mesecons are the wires, use them to connect effectors with receptors.
Binary file added mesecons/doc/mesecon/preview.png

Unable to render rich display

Invalid image source.

Binary file added mesecons/doc/mesecon/recipe.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions mesecons_blinkyplant/doc/blinkyplant/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The blinky plants toggles between on and off state every three seconds. Can be used to make clocks. Also works after having restarted the game.
Binary file added mesecons_blinkyplant/doc/blinkyplant/preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added mesecons_blinkyplant/doc/blinkyplant/recipe.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions mesecons_button/doc/button/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This receptor can be attached to walls. It turns on for 1 second if it's punched.
Binary file added mesecons_button/doc/button/preview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added mesecons_button/doc/button/recipe.png

Unable to render rich display

Invalid image source.

1 change: 1 addition & 0 deletions mesecons_commandblock/doc/commandblock/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
There is no crafting recipe as this should only be available for server admins. Quite similar to the Minecraft counterpart. Executes server commands.

Unable to render rich display

Invalid image source.

1 change: 1 addition & 0 deletions mesecons_delayer/doc/delayer/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The delayer delays the signal from the input for a determined time. The time can be set by punching the delayer. Possible delays are: 0.1 seconds, 0.3 seconds, 0.5 seconds and 1 second. You may try to use it for creating songs with the noteblock.
Binary file added mesecons_delayer/doc/delayer/preview.png

Unable to render rich display

Invalid image source.

Binary file added mesecons_delayer/doc/delayer/recipe.png

Unable to render rich display

Invalid image source.

6 changes: 6 additions & 0 deletions mesecons_detector/doc/nodedetector/description.html
Original file line number Diff line number Diff line change
@@ -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.
Binary file added mesecons_detector/doc/nodedetector/preview.png

Unable to render rich display

Invalid image source.

Binary file added mesecons_detector/doc/nodedetector/recipe.png

Unable to render rich display

Invalid image source.

3 changes: 3 additions & 0 deletions mesecons_detector/doc/objectdetector/description.html
Original file line number Diff line number Diff line change
@@ -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.
Binary file added mesecons_detector/doc/objectdetector/preview.png

Unable to render rich display

Invalid image source.

Binary file added mesecons_detector/doc/objectdetector/recipe.png

Unable to render rich display

Invalid image source.

1 change: 1 addition & 0 deletions mesecons_extrawires/doc/corner/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Insulated corners are conductors that only conduct between the inputs (also not up or down). When placing they always point to the left in direction of your vision.
Binary file added mesecons_extrawires/doc/corner/preview.png

Unable to render rich display

Invalid image source.

Binary file added mesecons_extrawires/doc/corner/recipe.png

Unable to render rich display

Invalid image source.

1 change: 1 addition & 0 deletions mesecons_extrawires/doc/crossing/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Insulated crossing are conductors that conduct two signals between the opposing sides, the signals are insulated to each other.
Binary file added mesecons_extrawires/doc/crossing/preview.png

Unable to render rich display

Invalid image source.

Binary file added mesecons_extrawires/doc/crossing/recipe.png

Unable to render rich display

Invalid image source.

1 change: 1 addition & 0 deletions mesecons_extrawires/doc/mese/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The basic prerequesite for mesecons, can be crafted into wires and other stuff. Have a look at the <a href="http://wiki.minetest.net/Mese">Minetest Wiki</a> for more information. Mese is a conductor. It conducts in all six directions: Up/Down/Left/Right/Forward/Backward
Binary file added mesecons_extrawires/doc/mese/preview.png

Unable to render rich display

Invalid image source.

Binary file added mesecons_extrawires/doc/mese/recipe.png

Unable to render rich display

Invalid image source.

1 change: 1 addition & 0 deletions mesecons_extrawires/doc/tjunction/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Insulated T-Junctions are conductors that only conduct between the inputs (also not up or down).
Binary file added mesecons_extrawires/doc/tjunction/preview.png

Unable to render rich display

Invalid image source.

Binary file added mesecons_extrawires/doc/tjunction/recipe.png

Unable to render rich display

Invalid image source.

1 change: 1 addition & 0 deletions mesecons_extrawires/doc/vertical/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Vertical Mesecons only conduct up and down. Plates appear at the ends, at that place they also conduct to the side.
Binary file added mesecons_extrawires/doc/vertical/preview.png

Unable to render rich display

Invalid image source.

Binary file added mesecons_extrawires/doc/vertical/recipe.png

Unable to render rich display

Invalid image source.

1 change: 1 addition & 0 deletions mesecons_gates/doc/and/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
And gates power their output if both inputs (from left and right) are powered.
Binary file added mesecons_gates/doc/and/preview.png

Unable to render rich display

Invalid image source.

Binary file added mesecons_gates/doc/and/recipe.png

Unable to render rich display

Invalid image source.

1 change: 1 addition & 0 deletions mesecons_gates/doc/diode/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Mesecon diodes, just like real ones, only transfer power (signals) in one direction only.
Binary file added mesecons_gates/doc/diode/preview.png
Binary file added mesecons_gates/doc/diode/recipe.png
1 change: 1 addition & 0 deletions mesecons_gates/doc/nand/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Nand gates do not power their output if both inputs (from left and right) are powered, but power it in every other case.
Binary file added mesecons_gates/doc/nand/preview.png
Binary file added mesecons_gates/doc/nand/recipe.png
1 change: 1 addition & 0 deletions mesecons_gates/doc/nor/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Nor gates only power their output if none of their two inputs is powered. They are basically or gates with a not gate at their output.
Binary file added mesecons_gates/doc/nor/preview.png
Binary file added mesecons_gates/doc/nor/recipe.png
1 change: 1 addition & 0 deletions mesecons_gates/doc/not/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Not gates invert signals, just like a mesecon torch does, but faster. The input is at the opposite side of the output.
Binary file added mesecons_gates/doc/not/preview.png
Binary file added mesecons_gates/doc/not/recipe.png
1 change: 1 addition & 0 deletions mesecons_gates/doc/or/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Or gates power their output if either of their inputs (or both) are powered. You could basically get the same behaviour with two diodes, but or gates save some space.
Binary file added mesecons_gates/doc/or/preview.png
Binary file added mesecons_gates/doc/or/recipe.png
1 change: 1 addition & 0 deletions mesecons_gates/doc/xor/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
XOR gates power their output if only one input is powered, they're off if either both or none of the inputs is powered.
Binary file added mesecons_gates/doc/xor/preview.png
Binary file added mesecons_gates/doc/xor/recipe.png
1 change: 1 addition & 0 deletions mesecons_hydroturbine/doc/waterturbine/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Water turbines are receptors that turn on if flowing water is above them.
Binary file added mesecons_hydroturbine/doc/waterturbine/recipe.png
1 change: 1 addition & 0 deletions mesecons_insulated/doc/insulated/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Insulated mesecons are conductors that only conduct in one direction (and also not up or down).
Binary file added mesecons_insulated/doc/insulated/preview.png
Binary file added mesecons_insulated/doc/insulated/recipe.png
1 change: 1 addition & 0 deletions mesecons_lamp/doc/lamp/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Lamps are effectors that if powered emit light.
Binary file added mesecons_lamp/doc/lamp/preview.png
Binary file added mesecons_lamp/doc/lamp/recipe.png
1 change: 1 addition & 0 deletions mesecons_lightstone/doc/lightstone_blue/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Effector, glows blue when powered.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Effector, glows dark grey when powered.
1 change: 1 addition & 0 deletions mesecons_lightstone/doc/lightstone_green/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Effector, glows green when powered.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Effector, glows light grey when powered.
1 change: 1 addition & 0 deletions mesecons_lightstone/doc/lightstone_red/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Effector, glows red when powered.
Binary file added mesecons_lightstone/doc/lightstone_red/recipe.png
1 change: 1 addition & 0 deletions mesecons_lightstone/doc/lightstone_yellow/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Effector, glows yellow when powered.
5 changes: 5 additions & 0 deletions mesecons_luacontroller/doc/luacontroller/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
The luacontroller is an advanced programmable component.
You can simply code it in the language mesecons uses itself: Lua!
All the code runs in a sandbox, so it's completely safe (but I won't guarantee that for absolute certainty!).

<a href="http://mesecons.net/luacontroller/">Documentation is available here!</a>
1 change: 1 addition & 0 deletions mesecons_materials/doc/fiber/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Craftitem: It can't be placed! Made by cooking glue in the furnace. Used for insulated mesecon crafting.
Binary file added mesecons_materials/doc/fiber/preview.png
Binary file added mesecons_materials/doc/fiber/recipe.png
1 change: 1 addition & 0 deletions mesecons_materials/doc/glue/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Craftitem: It can't be placed! Made by cooking saplings in furnace. Used for sticky pistons and sticky movestones.
Binary file added mesecons_materials/doc/glue/preview.png
Binary file added mesecons_materials/doc/glue/recipe.png
1 change: 1 addition & 0 deletions mesecons_materials/doc/silicon/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Silicon is just a craftitem: It can't be placed. You'll need it in order to craft other items.
Binary file added mesecons_materials/doc/silicon/preview.png
Binary file added mesecons_materials/doc/silicon/recipe.png
8 changes: 4 additions & 4 deletions mesecons_materials/init.lua
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
--GLUE
-- Glue and fiber
minetest.register_craftitem("mesecons_materials:glue", {
image = "jeija_glue.png",
image = "mesecons_glue.png",
on_place_on_ground = minetest.craftitem_place_item,
description="Glue",
})

minetest.register_craftitem("mesecons_materials:fiber", {
image = "jeija_fiber.png",
image = "mesecons_fiber.png",
on_place_on_ground = minetest.craftitem_place_item,
description="Fiber",
})
@@ -27,7 +27,7 @@ minetest.register_craft({

-- Silicon
minetest.register_craftitem("mesecons_materials:silicon", {
image = "jeija_silicon.png",
image = "mesecons_silicon.png",
on_place_on_ground = minetest.craftitem_place_item,
description="Silicon",
})
File renamed without changes
File renamed without changes
File renamed without changes
1 change: 1 addition & 0 deletions mesecons_movestones/doc/movestone/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Movestones are effectors that push the blocks in front of them. They move along on the right side of a mesecon wire track.
Binary file added mesecons_movestones/doc/movestone/preview.png
Binary file added mesecons_movestones/doc/movestone/recipe.png
1 change: 1 addition & 0 deletions mesecons_movestones/doc/movestone_sticky/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Movestones are effectors that push the blocks in front of them. They move along on the right side of a mesecon wire track. Sticky ones also pull blocks.
13 changes: 13 additions & 0 deletions mesecons_noteblock/doc/noteblock/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
This effector makes a sound if powered and can be used for making music. Normally it makes piano sounds. The sound frequency can be changed by punching the block. There are some special sounds that depend on the block below:
<table colspace="5">
<tr><th>Block Below</th><th>Effect</th></tr>
<tr><td>Glass</td><td>Hihat</td></tr>
<tr><td>Stone</td><td>Kick</td></tr>
<tr><td>Chest</td><td>Snare</td></tr>
<tr><td>Tree</td><td>Crash</td></tr>
<tr><td>Glass</td><td>Hihat</td></tr>
<tr><td>Wood</td><td>Lite Crash</td></tr>
<tr><td>Coal Block</td><td>Explosion Sound </td></tr>
<tr><td>Lava Source</td><td>Fire Sound</td></tr>
<tr><td>Steel Block</td><td>Raises the pitch by one octave</td></tr>
</table>
Binary file added mesecons_noteblock/doc/noteblock/preview.png
Binary file added mesecons_noteblock/doc/noteblock/recipe.png
1 change: 1 addition & 0 deletions mesecons_pistons/doc/piston/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Pistons are effectors, they push up to 20 blocks in front of them. The push direction can be set by placing them from different angles.
Binary file added mesecons_pistons/doc/piston/preview.png
Binary file added mesecons_pistons/doc/piston/recipe.png
1 change: 1 addition & 0 deletions mesecons_pistons/doc/piston_sticky/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Sticky pistons are effectors, they push up to 20 blocks in front of them. The push direction can be set by placing them from different angles. Sticky ones also pull 1 block.
Binary file added mesecons_pistons/doc/piston_sticky/preview.png
Binary file added mesecons_pistons/doc/piston_sticky/recipe.png
1 change: 1 addition & 0 deletions mesecons_powerplant/doc/powerplant/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
A power plant is a receptor that is always turned on: It provides energy.
Binary file added mesecons_powerplant/doc/powerplant/preview.png
Binary file added mesecons_powerplant/doc/powerplant/recipe.png
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This receptor turns on if there's an object above it. And object can be a player, an item, a mob...
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
This receptor turns on if there's an object above it. And object can be a player, an item, a mob...
1 change: 1 addition & 0 deletions mesecons_random/doc/ghoststone/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Ghoststones disappear when powered, just like Removestones. But in contrast to Removestones, they Reappear again when not powered anymore and they are also conductive.
Binary file added mesecons_random/doc/ghoststone/preview.png
Binary file added mesecons_random/doc/ghoststone/recipe.png
1 change: 1 addition & 0 deletions mesecons_random/doc/removestone/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Removestones are propably the simplest effectors possible. They simply disappear when powered.
Binary file added mesecons_random/doc/removestone/preview.png
Binary file added mesecons_random/doc/removestone/recipe.png
1 change: 1 addition & 0 deletions mesecons_solarpanel/doc/solarpanel/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Solar Panel are light receptors: they turn on if there is enough light.
Binary file added mesecons_solarpanel/doc/solarpanel/preview.png
Binary file added mesecons_solarpanel/doc/solarpanel/recipe.png
1 change: 1 addition & 0 deletions mesecons_switch/doc/switch/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The switch is a receptor. It changes its state as when punched.
Binary file added mesecons_switch/doc/switch/preview.png
Binary file added mesecons_switch/doc/switch/recipe.png
14 changes: 7 additions & 7 deletions mesecons_switch/init.lua
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
-- MESECON_SWITCH
-- mesecons_switch

mesecon.register_node("mesecons_switch:mesecon_switch", {
paramtype2="facedir",
@@ -14,15 +14,15 @@ mesecon.register_node("mesecons_switch:mesecon_switch", {
end
},{
groups = {dig_immediate=2},
tiles = { "jeija_mesecon_switch_side.png", "jeija_mesecon_switch_side.png",
"jeija_mesecon_switch_side.png", "jeija_mesecon_switch_side.png",
"jeija_mesecon_switch_side.png", "jeija_mesecon_switch_off.png"},
tiles = { "mesecons_switch_side.png", "mesecons_switch_side.png",
"mesecons_switch_side.png", "mesecons_switch_side.png",
"mesecons_switch_side.png", "mesecons_switch_off.png"},
mesecons = {receptor = { state = mesecon.state.off }}
},{
groups = {dig_immediate=2, not_in_creative_inventory=1},
tiles = { "jeija_mesecon_switch_side.png", "jeija_mesecon_switch_side.png",
"jeija_mesecon_switch_side.png", "jeija_mesecon_switch_side.png",
"jeija_mesecon_switch_side.png", "jeija_mesecon_switch_on.png"},
tiles = { "mesecons_switch_side.png", "mesecons_switch_side.png",
"mesecons_switch_side.png", "mesecons_switch_side.png",
"mesecons_switch_side.png", "mesecons_switch_on.png"},
mesecons = {receptor = { state = mesecon.state.on }}
})

1 change: 1 addition & 0 deletions mesecons_torch/doc/torch/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The torch is an inverter, it may take up to 1 second until the signal has passed through. The input is 2 blocks away in the direction of the stick, outputs are around the mesecon glow.
Binary file added mesecons_torch/doc/torch/preview.png
Binary file added mesecons_torch/doc/torch/recipe.png
1 change: 1 addition & 0 deletions mesecons_walllever/doc/walllever/description.html
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
A receptor just like a switch, but it can be attached to walls.
Binary file added mesecons_walllever/doc/walllever/preview.png
Binary file added mesecons_walllever/doc/walllever/recipe.png

0 comments on commit 0ec771b

Please sign in to comment.