Updated documentation for all blocks, added details and links.

MightyPirates · Apr 9, 2015 · 4d83e86 · 4d83e86
1 parent 85393fe
commit 4d83e86
Show file tree

Hide file tree

Showing 20 changed files with 52 additions and 32 deletions.
diff --git a/src/main/resources/assets/opencomputers/doc/en_US/block/assembler.md b/src/main/resources/assets/opencomputers/doc/en_US/block/assembler.md
@@ -2,10 +2,10 @@
 
 ![Harder, better, faster, stronger.](oredict:oc:assembler)
 
-The Assembler is an advanced workstation that can be used to build more complex electronic devices, such as [robots](robot.md), [drones](../item/drone.md) and [tablets](../item/tablet.md). They usually require a relatively large amount of energy to assemble these devices, to it is recommended to power them sufficiently.
+The Assembler is an advanced workstation that can be used to build more complex electronic devices, such as [robots](robot.md), [drones](../item/drone.md) and [tablets](../item/tablet.md). They usually require a relatively large amount of energy to assemble these devices, so it is recommended to power them sufficiently.
 
-To build a device using an assembler, first insert the base part for that device. For robots that is a computer case of any tier, for tablets that is a tablet case, for example. Continue to insert any parts you would like the device to contain. Take particular care to provide an operating system, or a possibility to install one later on (for robots you can install a [disk drive](diskDrive.md) to insert and remove [floppies](../item/floppy.md) later on, for example).
+To build a device using an assembler, first insert the base part for that device. For [robots](robot.md) that is a [computer case](case1.md) of any tier, for tablets that is a [tablet case](../item/tabletCase1.md), for example. Continue to insert any parts you would like the device to contain. Take particular care to provide an operating system, or a possibility to install one later on (for robots you can install a [disk drive](diskDrive.md) to insert and remove [floppies](../item/floppy.md) later on, for example).
 
-Also note that for robots to have a [screen](screen1.md) you need to install a tier one screen in them, and to allow typing on the screen you also need to install a [keyboard](keyboard.md). For tablets the screen is pre-installed in the tablet case, but you still need to install a keyboard if you wish to type on your tablet.
+Also note that for [robots](robot.md) to have a [screen](screen1.md) you need to install a tier one screen in them, and to allow typing on the screen you also need to install a [keyboard](keyboard.md). For [tablets](../item/tablet.md) the screen is pre-installed in the tablet case, but you still need to install a keyboard if you wish to type on your [tablet](../item/tablet.md).
 
 Once everything is in place, press the start button and wait for the device to be assembled and charged. It is important to remember that you §lcannot§r change the device after it has been assembled. If you forgot something or made a mistake, you will have to disassemble the device completely using the [disassembler](disassembler.md), which has a slight chance of breaking parts in the process.
diff --git a/src/main/resources/assets/opencomputers/doc/en_US/block/cable.md b/src/main/resources/assets/opencomputers/doc/en_US/block/cable.md
@@ -6,4 +6,4 @@ The Cable simply serves as a way of connecting computers and machines that are f
 
 Cables can be colored using any kind of dye. Colored cables will only connect to cables of the same color and to light gray colored cables - the default color. This can be useful for running cables for multiple subnetworks in parallel, without using covers.
 
-Speaking of which, cables can be covered using either Forge MultiPart covers or immibis Microblocks covers.
+If necessary, Cables can be covered using Forge MultiPart covers, or Immibis Microblocks covers. 
diff --git a/src/main/resources/assets/opencomputers/doc/en_US/block/capacitor.md b/src/main/resources/assets/opencomputers/doc/en_US/block/capacitor.md
@@ -2,6 +2,8 @@
 
 ![It's over 9000.](oredict:oc:assembler)
 
-The Capacitor has one job, storing a bunch of energy, either as a failsafe or for quick use. Unlike when converting energy from other mods' power systems to the internal energy format, transfer inside a single OC subnetwork is pretty much instantaneous, so it can be of advantage to store some energy internally, for tasks that consume a lot of energy, such as assembling devices in the [assembler](assembler.md) or charging [robots](robot.md).
+The Capacitor stores energy to be used by the network, acting as an energy buffer when needed. Unlike conversion from other mod's energy to OC's internal energy type (using a [power converter](powerConverter.md), transfering energy inside a single OC subnetwork is instantaneous, so it can be advantageous to store some energy internally for tasks that consume a lot of energy, such as assembling devices in the [assembler](assembler.md) or charging [robots](robot.md).
 
-The storage efficiency of capacitors increases the more capacitors are in their direct and indirect vicinity. For example, two capacitors directly next to each other will have a higher storage capacity than the sum of two separated capacitors. This adjacency bonus applies for capacitors up to two blocks away, with slightly less of a bonus for capacitors two blocks away than for capacitors one block away.
+The storage efficiency of capacitors increases with the number of capacitors in direct contact or in the vicinity. For example, two capacitors directly next to each other will have a higher storage capacity than the sum of two separated capacitors. This adjacency bonus applies for capacitors up to two blocks away, and is reduced as the distance between capacitors increases.
+
+The Capacitor can be connected to a [power distributor](powerDistributor.md) to provide power to other [computers](../general/computer.md) or machines on the network. 
diff --git a/src/main/resources/assets/opencomputers/doc/en_US/block/charger.md b/src/main/resources/assets/opencomputers/doc/en_US/block/charger.md
@@ -6,4 +6,4 @@ The Charger is used to charge devices such as [robots](robot.md), [drones](../it
 
 Note that this logic can be inversed by hitting the charger with a BuildCraft compatible wrench. In inversed mode the charger defaults to 100% charge speed, and a higher redstone signal will result in a slower charge speed.
 
-When a tablet is placed in the charger, its first [hard drive](../item/hdd1.md) is also exposed to [computers](../general/computer.md) connected to the charger, similar to how [floppies](../item/floppy.md) in [disk drives](diskDrive.md) are. This allows copying data onto or from a tablet, if desired.
+When a [tablet](../item/tablet.md) is placed in the charger, its first [hard drive](../item/hdd1.md) is also exposed to [computers](../general/computer.md) connected to the charger, similar to how [floppies](../item/floppy.md) in [disk drives](diskDrive.md) are. This allows transferring of data between the [computer](../general/computer.md) and [tablet](../item/tablet.md).
diff --git a/src/main/resources/assets/opencomputers/doc/en_US/block/disassembler.md b/src/main/resources/assets/opencomputers/doc/en_US/block/disassembler.md
@@ -2,6 +2,6 @@
 
 ![Build it, tear it down.](oredict:oc:disassembler)
 
-The Disassembler can be used to deconstruct most items in OpenComputers into their original parts. This is mostly useful to reclaim materials from old parts that are no longer useful, or to decompose devices that are either no longer needed or built broken (e.g. [robots](robot.md) without an operating system).
+The Disassembler can be used to deconstruct most items in OpenComputers into their original parts. This is mostly useful to reclaim materials from old parts that are no longer useful, or to deconstruct devices that are either no longer needed or were incorrectly built (e.g. [robots](robot.md) without an operating system).
 
-Disassembling items takes a relatively long time, and quite some energy. It also has a certain risk to destroy the reclaimed items - this chance is applied to each extracted item - so be sure to not carelessly throw things into the disassembler.
+Disassembling items takes a relatively long time, and some energy. There is also a slight chance of loosing a component, which is applied on a component by component basis - be careful about throwing a device into the disassembler. 
diff --git a/src/main/resources/assets/opencomputers/doc/en_US/block/diskDrive.md b/src/main/resources/assets/opencomputers/doc/en_US/block/diskDrive.md
@@ -2,6 +2,6 @@
 
 ![Going round and round and...](oredict:oc:diskDrive)
 
-The Disk Drive can be used to read [floppies](../item/floppy.md) using a computer connected to the disk drive. This is useful to get started, since the lower tier computer cases do not have a built-in floppy slot, and you'll need an operating system to get started - which usually only come on floppy disks (such the craftable OpenOS one).
+The Disk Drive can be used to read [floppy disks](../item/floppy.md) using a computer connected to the disk drive. This is useful to get started, since the lower tier [computer cases](../case1.md) do not have a built-in floppy slot, and you'll need an operating system to get started. An OpenOS disk can be crafted using an empty [floppy disk](../item/floppy.md) and a Book. 
 
-It can also be installed in [robots](robot.md) to allow inserting an removing floppy disks into and from the robot at any time, which can be very useful, since the only other way to transfer data from a robot is using networking - for example using [network cards](../item/lanCard.md).
+It can also be installed in [robots](robot.md) to allow inserting an removing [floppy disks](../item/floppy.md) into and from the robot at any time. This can be very useful since the only other way to transfer data to and from a robot is using networking - for example using [network cards](../item/lanCard.md).
diff --git a/src/main/resources/assets/opencomputers/doc/en_US/block/geolyzer.md b/src/main/resources/assets/opencomputers/doc/en_US/block/geolyzer.md
@@ -2,6 +2,6 @@
 
 ![It rocks.](oredict:oc:geolyzer)
 
-The Geolyzer can be used by computers to scan the terrain surrounding the geolyzer for the blocks' approximate hardness. This can be useful to generate maps of the area to display on [hologram projectors](hologram1.md) as well as to detect potentially valuable blocks (ores are usually harder than dirt and stone).
+The Geolyzer can be used by computers to scan the terrain surrounding the geolyzer for the blocks' approximate hardness. This can be useful to generate maps of the area to display on [hologram projectors](hologram1.md) as well as to detect potentially valuable blocks (ores are usually harder than dirt and stone). Geolyzer scan results have a certain amount of noise added; in theory, multiple scans can be performed to determine a more accurate reading of a block's hardness level. 
 
-The geolyzer can also be installed in [robots](robot.md) as an upgrade to allow them to scan their surroundings. Performing a scan will consume some energy, though, so using it excessivly may quickly drain a robot's batteries.
+The geolyzer can also be installed in [robots](robot.md) as an upgrade to allow them to scan their surroundings. Performing a scan will consume some energy, though, so using it excessivly may quickly drain a [robot](robot.md)'s batteries.
diff --git a/src/main/resources/assets/opencomputers/doc/en_US/block/hologram1.md b/src/main/resources/assets/opencomputers/doc/en_US/block/hologram1.md
@@ -2,6 +2,6 @@
 
 ![Is this the real life? Is this just fantasy?](oredict:oc:assembler)
 
-The Hologram Projector is a volumetric display, i.e. it provides a three dimensional array of voxels that can be individually enabled or disabled by a connected computer. The second tier projector, while having the same resolution as the tier one projector, supports displaying the individual voxels in three different colors.
+The Hologram Projector is a volumetric display, i.e. it provides a three dimensional array of voxels that can be individually enabled or disabled by a connected computer. The second tier projector, while having the same resolution as the tier one projector, supports displaying the individual voxels in three different user-definable colors.
 
-Holograms can be rotated along their vertical axis by hitting them with a BuildCraft compatible wrench on their top or bottom. This can save some effort, so that the output doesn't have to be transformed on the software side.
+Holograms can be rotated along their vertical axis by hitting them with a BuildCraft compatible wrench on their top or bottom. This can save some effort, so that the output doesn't have to be transformed on the software side. Holograms can also be scaled up or down as desired. 
diff --git a/src/main/resources/assets/opencomputers/doc/en_US/block/keyboard.md b/src/main/resources/assets/opencomputers/doc/en_US/block/keyboard.md
@@ -2,6 +2,6 @@
 
 ![QWERTY](oredict:oc:keyboard)
 
-A Keyboard is needed to type text on [screens](screen1.md), be they in the world or built into devices such as [robots](robot.md) or [tablets](../item/tablet.md).
+A Keyboard is needed to type text on [screens](../screen1.md), be they in the world or built into devices such as [robots](robot.md) or [tablets](../item/tablet.md).
 
-For a keyboard to work with a screen in the world, it has to be placed next to the screen, facing that screen, or placed directly on the screen (on top or on one of its sides). You can tell that a keyboard is "connected" to a screen if by right-clicking the keyboard the screen's GUI opens up.
+For a keyboard to work with a [screen](../screen1.md) in the world, it has to be placed next to the [screen](../screen1.md), facing that [screen](../screen1.md), or placed directly on the [screen](../screen1.md) (on top or on one of its sides). You can tell that a keyboard is "connected" to a [screen](../screen1.md) if by right-clicking the keyboard the [screen's](../screen1.md) GUI opens up.
diff --git a/src/main/resources/assets/opencomputers/doc/en_US/block/motionSensor.md b/src/main/resources/assets/opencomputers/doc/en_US/block/motionSensor.md
@@ -2,6 +2,6 @@
 
 ![Don't. Blink.](oredict:oc:motionSensor)
 
-The Motion Sensor allows computers to detect movement of living entities. If an entity moves faster than a set threshold, a signal will be injected into computers connected to the motion sensor. The threshold can be configured via the component the motion sensor exposes to connected computers.
+The Motion Sensor allows [computers](../general/computer.md) to detect movement of living entities. If an entity moves faster than a set threshold, a signal will be injected into [computers](../general/computer.md) connected to the motion sensor. The threshold can be configured via the component the motion sensor exposes to connected computers.
 
 Movement is only detected if it happens within a radius of eight blocks around the motion sensor, and if there is a direct line of sight from the block to the entity that moved.
diff --git a/src/main/resources/assets/opencomputers/doc/en_US/block/powerConverter.md b/src/main/resources/assets/opencomputers/doc/en_US/block/powerConverter.md
@@ -2,4 +2,7 @@
 
 ![One of us? One of us!](oredict:oc:powerConverter)
 
-The Power Converter serves as the fastest way to convert energy from other mods' power systems to OpenComputers' internal energy. If you only run a simple computer you probably won't need a converter. If you have a large capacitor bank that you only drain every now and then, you probably won't need one, either. However, if you wish to directly power an [assembler](assembler.md) or [charger](charger.md), it is usually a good idea to use a converter, instead of directly connecting them to external power.
+The Power Converter serves as the fastest way to convert energy from other mods' power systems to OpenComputers' internal energy. If you only run a simple computer, you probably won't need a converter. If you have a large capacitor bank that you only drain every now and then, you probably won't need one, either. However, if you wish to directly power an [assembler](assembler.md) or [charger](charger.md), it is usually a good idea to use a converter, instead of directly connecting them to external power.
+
+Power conversion rates are as follows: 
+- 
diff --git a/src/main/resources/assets/opencomputers/doc/en_US/block/powerDistributor.md b/src/main/resources/assets/opencomputers/doc/en_US/block/powerDistributor.md
@@ -2,4 +2,4 @@
 
 ![Power to the masses.](oredict:oc:powerDistributor)
 
-The Power Distributor is for energy what the [switch](switch.md) is for network messages. It allows several subnetworks to share their energy, without components being exposed to computers in other networks. It operates by regularly "balancing" the energy in all subnetworks it is connected to, so that the *relative* amount of energy is the same in them.
+The Power Distributor distributes a shared power storage (such as a [capacitor](capacitor.md)), allowing several subnetworks to share their energy, without components being exposed to computers in other networks. It operates by regularly "balancing" the energy in all subnetworks it is connected to, so that the *relative* amount of energy is the same in them. 
diff --git a/src/main/resources/assets/opencomputers/doc/en_US/block/raid.md b/src/main/resources/assets/opencomputers/doc/en_US/block/raid.md
@@ -2,8 +2,8 @@
 
 ![40 man instance.](oredict:oc:raid)
 
-The Raid block houses three hard drives which will be combined into a single file system. This combined file system has the size of the sum of the capacities of the individual hard drives and is available to all computers connected to the raid.
+The Raid block houses three [hard drives](../item/hdd1.md) which will be combined into a single file system. This combined file system has the size of the sum of the capacities of the individual [hard drives](../item/hdd1.md) and is available to all [computers](../general/computer.md) connected to the raid.
 
-The raid only works (and shows up as a file system) when three disks are present. The disks may differ in size.
+The raid only works (and shows up as a file system) when three [hard drives](../item/hdd1.md) are present. The [hard drives](../item/hdd1.md) may differ in size.
 
-Beware that adding a hard drive to the raid block will wipe it of its contents. Removing a single disk from a complete raid will also wipe the raid. Adding the disk back in will *not* restore it, the raid's new file system will not contain any files.
+Beware that adding a [hard drive](../item/hdd1.md) to the raid block will wipe it of its contents. Removing a single [hard drives](../item/hdd1.md) from a complete raid will also wipe the raid. Adding the disk back in will *not* restore it, the raid's new file system will not contain any files.
diff --git a/src/main/resources/assets/opencomputers/doc/en_US/block/redstone.md b/src/main/resources/assets/opencomputers/doc/en_US/block/redstone.md
@@ -2,7 +2,7 @@
 
 ![Hi Red.](oredict:oc:redstone)
 
-The Redstone I/O block can be used to remotely read and emit redstone signals. It behaves like a hybrid of a tier one and two [redstone card](../item/redstoneCard1.md), in that it can read and emit simple analog as well as bundled signals, but cannot read or emit wireless redstone signals.
+The Redstone I/O block can be used to remotely read and emit redstone signals. It behaves like a hybrid of a tier 1 and 2 [redstone card](../item/redstoneCard1.md): it can read and emit simple analog as well as bundled signals, but cannot read or emit wireless redstone signals.
 
 When providing a side to the methods of the component exposed by this block, the directions are the global principal directions, i.e. it is recommended to use sides.north, sides.east and so on.
 

diff --git a/src/main/resources/assets/opencomputers/doc/en_US/block/robot.md b/src/main/resources/assets/opencomputers/doc/en_US/block/robot.md
@@ -4,4 +4,6 @@
 
 Unlike computers, robots can move around and interact with the world much like a player can. They can *not* interact with external components, however! If you need to communicate with a computer or other robots, use a [wireless network card](../item/wlanCard.md), or create some low-level protocol using redstone signals via a [redstone card](../item/redstoneCard1.md), for example.
 
-Robots are built by placing a [computer case](case1.md) in an [assembler](assembler.md).
+Robots are built by placing a [computer case](case1.md) of any tier in an [assembler](assembler.md). Higher tier computer cases can build more complex robots, due to being able to hold a higher tier [CPU](../item/cpu1.md). Complexity of the robot (as shown in the [assembler](assembler.md)) is determined by the tier of the components and upgrades placed in the robot slots; higher tier components will increase the complexity more than a lower tier component. If the complexity of the robot is too high, the [assembler](assembler.md) will not build the robot. 
+
+Various upgrades can be placed into robots to increase the functionality. These include [inventory](../item/inventoryUpgrade.md) and [inventory controller](../item/inventoryControllerUpgrade.md) upgrades, [tank upgrades](../tankUpgrade.md), [navigation upgrade](../item/navigationUpgrade.md), among others. [Upgrade](../item/upgradeContainer1.md) and [card](../item/cardContainer1.md) containers can be placed in the robot for on-the-fly insertion and removal of upgrades and components. A [disk drive](diskDrive.md) can also be placed inside a robot to allow [floppy disks](../item/floppy.md) to be inserted, which will let you install openOS to the robot (an alternative is to install openOS to a blank [hard drive](../item/hdd1.md) using a computer, and using the pre-installed [hard drive](../item/hdd1.md) as a component in the robot assembly).