Name:    placecraft
Source:  Original mod
License: See "LICENSE"

----------------------------------------------------------------------

1. "placecraft" is a mod that provides the following function:

      placecraft.register_item (name, def)

This function is an enhanced version of:

      minecraft.register_craftitem (name, def)

It supports the same parameters.  However, the "def" table may include
additional settings.

----------------------------------------------------------------------

2. Primary feature.

2.1. Most  importantly,  "def.drawtype" may be set to "sprite", "mob",
or "plantlike".

In any of these cases, the craft-item created may be placed; hence the
name of the mod.

2.2. If the "sprite" setting is used, the placed version of the craft-
item is a 2D sprite that always faces the player.

This looks better, in some cases,  than the "plantlike" or "torchlike"
drawtypes than other mods which place 2D objects more typically use.

2.3. If the  "mob" setting  is used,  the placed version of the craft-
item is the same, but it behaves like a mob.

This mode is  similar to  CoRNeRNoTe's Critters except for the always-
facing aspect.  The  classic  version of  Critters  originally  used a
"torchlike" approach.

2.4. If the "plantlike" setting is used,  the craft-item is defined as
a "plantlike" node instead of a sprite or mob.

This mode isn't recommend except for cases where the object represent-
ed has radial symmetry.

----------------------------------------------------------------------

3. If "def.drawtype" is omitted or empty, it defaults to "sprite".

To use the  new function to create a normal craft-item, set "def.draw-
type" to "none".

----------------------------------------------------------------------

4. Features and limitations:

4.1. You can use a  "world.conf" setting as  shown below to change the
default behavior of the mod:

    # By default, don't place craft-items:
    placecraft_drawtype = none

    # By default, place craft-items as static sprites:
    placecraft_drawtype = sprite

    # By default, place craft-items as mobs:
    placecraft_drawtype = mob

    # By default, redefine craft-items as "plantlike" nodes
    placecraft_drawtype = plantlike

4.2. A single parameter, "def.image", may be set to specify inventory,
wield, sprite, and node "tiles" images.

Or any of the following "def.*" parameters may be used:

    inv    or inventory_image = inventory    image
    sprite or sprite_image    = sprite       image
    tile   or tiles           = ndoe "tiles" image
    wield  or wield_image     = wield        image

The latter 8 parameters take precedence over "def.image".

4.3. "vsize" may be set, in the "def" table, to scale a sprite or mob.
For example:

    vsize = 0.50 ,  -- scale to half   size
    vsize = 2.00 ,  -- scale to double size

4.4. "narrow" may be set to true, in the "def" table, to indicate that
an item is tall and skinny. For example:

    narrow = true

Or "narrow"  may be set to a 0.## number from 0.25 to 0.99 to indicate
that an item is about 0.## as wide as it is tall.

4.5. Accurate "vsize" and/or "narrow" settings will improve the accur-
acy of the collision  and/or selection box for a placed node.

4.6. Protection  is  presently supported  only through a kludge.  This
is to be documented.

----------------------------------------------------------------------

5. Sample objects:

This  mod  defines a number of  lab beakers in  different colors.  The
beakers are in the "beaker:" namespace.  Examples: beaker:red, beaker:
blue, etc.

Graded lab glasses, in the same colors, are provided as well. The gra-
ded glasses are in the "graded:" namespace. Examples: graded:red, gra-
ded:blue, etc.

----------------------------------------------------------------------
End of file.