summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorVanessaE <vanessaezekowitz@gmail.com>2013-04-14 14:34:21 -0700
committerVanessaE <vanessaezekowitz@gmail.com>2013-04-14 14:34:21 -0700
commit6d348001cd4de3053c01e6477b3363adc2244758 (patch)
tree4b1851fe6661bb7054cbbc1307b17b9959e3eb8b /README
parent1713f30d2121418ff5d4cc454043a227c3df0cc3 (diff)
parent46a33bbf2dd8b35ecc20fbe752680ee59aeccb77 (diff)
downloadpipeworks-6d348001cd4de3053c01e6477b3363adc2244758.tar
pipeworks-6d348001cd4de3053c01e6477b3363adc2244758.tar.gz
pipeworks-6d348001cd4de3053c01e6477b3363adc2244758.tar.bz2
pipeworks-6d348001cd4de3053c01e6477b3363adc2244758.tar.xz
pipeworks-6d348001cd4de3053c01e6477b3363adc2244758.zip
Merge pull request #30 from Uberi/master
Documentation Improvements
Diffstat (limited to 'README')
-rw-r--r--README20
1 files changed, 5 insertions, 15 deletions
diff --git a/README b/README
index fb18d4f..c16754e 100644
--- a/README
+++ b/README
@@ -1,5 +1,7 @@
-This simple mod uses nodeboxes to supply a complete set of 3D flanged pipes,
-along with "valve" and "pump" devices.
+This mod uses nodeboxes to supply a complete set of 3D pipes and tubes,
+along devices that work with them.
+
+See "Overview.html" for detailed information about usage of this mod.
Unlike the previous version of this mod, these pipes are rounded, and when
placed, they'll automatically join together as needed. Pipes can go vertically
@@ -14,21 +16,9 @@ windows, as if full (the two colors should also be easy to select if you want
to change them in a paint program). These windows only appear on straight
lengths and on certain junctions.
-There are no crafting recipes, yet, but you can use /giveme as usual, namely
-"/giveme pipeworks:pipe 999" or so, and then place them as needed. See
-init.lua for more details.
-
-This mod is intended to be used as a basis or at least as sort of a model for
-something else to build on (perhaps a nicer-looking oil mod?), and does not
-provide any of the code necessary to cause anything to flow through them. Like
-the pipes, the valve and pump don't do anything useful yet, but you can punch
-them to turn them "on" and "off". Note that the valve and pump textures and
-shapes are not yet complete (hence their boxy appearance).
-
This mod is a work in progress.
Please note that owing to the nature of this mod, I have opted to use 64px
textures. Anything less just looks terrible.
-If you don't need the old node names from the previous version of this mod,
-edit init.lua and comment-out the 'dofile' line at the top.
+All parts of this mod are licensed under the WTFPL. \ No newline at end of file