Builder: Difference between revisions

Revision as of 03:59, 10 September 2012

Builder

Author	jrbudda
Version	0.2
Citizens build	2.0.1 dev build #343
Other dependencies	None required.
Download	Link
Description: Citizens NPCs that build schematics.

Builder is a Citizens 2.0 character trait that gives NPCs the ability to:

Build MCEdit/Worldedit schematics, block by block.
Rebuild an area, fixing anything that has been changed.

Updates

v. 0.2 Alpha 9/9/2012

Added commands ignoreair, ignoreliquid, origin, info

v. 0.1.1 Alpha 9/9/2012

Added Mark command.
Better pathing.

v. 0.1 Alpha 9/9/2012

First release

|

Installation

Install Citizens 2
Place Builder.jar file in /plugins directory.
Place .schematic files in /plugins/Builder/schematics/
Start Server
Create NPC and give the Builder trait.

/npc create Bob --trait builder

Permissions

builder.load
builder.build
builder.cancel
builder.mark

Commands

/builder load [schematic] - Loads a .schematic file. simply use the name of the schematic. Example

/builder load house

/builder origin - Sets the origin of the builder's projects to the builder's current location. Allows you to re-build in the same spot. If this is not set the builder will always start from his current location.

/builder mark - Places a glowstone block at the 4 corners of the footprint, then returns to the origin, so you can see where it's going to build.

/builder build - Start building the schematic.

/builder cancel - Cancel a build job.

/builder info - View a Builder's loaded schematic name and size, as well as the builder's options.

/builder ignoreair - Toggles the builder to not set air blocks, false by default. Use this to build into existing block structure.

/builder ignoreliquid - Toggles the builder to not set water or lava. Use this if the schematic comes with un-contained liquids.

Usage

.schematic files should be placed in the /plugins/Builder/schematics/ directory.
Position the builder, or set the builder's origin, to the center of the footpoint you want to build before calling build. The size of the schematic is shown upon load.
It is highly recommended to set the Origin before building. This will allow you to cancel the build and restart it later, the builder will pick up where he left off.
The builder will ignore any empty space underneath the schematic object so that it will always rest on the ground where the builder starts.
The builder will not attempt to replace blocks that are already set properly, this means you can use a builder to quickly 'restore' any changed blocks in something he has previously built.

Planned Additions

Rotate/flip schematic before build.
Economy costs for building.
Require materials for building.
More commands for info, area marking.
Configuration for schematics directory, default options.

@@ Line 3: / Line 3: @@
 | AUTHOR      =  jrbudda
 | NAME         = Builder
-| VERSION    = 0.1.1
+| VERSION    = 0.2
 | CITIZENSBUILD  = [http://ci.citizensnpcs.com/job/Citizens2/ 2.0.1 dev build #343]
 | DEVSTATUS    = InDev
@@ Line 12: / Line 12: @@
 '''Builder''' is a Citizens 2.0 [[Characters|character trait]] that gives NPCs the ability to:
 * Build MCEdit/Worldedit schematics, block by block.
+* Rebuild an area, fixing anything that has been changed.
 __TOC__
 ==Updates==
+'''v. 0.2 Alpha''' 9/9/2012
+*Added commands ignoreair, ignoreliquid, origin, info
 '''v. 0.1.1 Alpha''' 9/9/2012
@@ Line 45: / Line 48: @@
   /builder load house
-'''/builder mark''' - Places a glowstone block at the 4 corners of the footprint, then returns to the center, so you can see where it's going to build.
+'''/builder origin''' - Sets the origin of the builder's projects to the builder's current location. Allows you to re-build in the same spot. If this is not set the builder will always start from his current location.
+'''/builder mark''' - Places a glowstone block at the 4 corners of the footprint, then returns to the origin, so you can see where it's going to build.
 '''/builder build''' - Start building the schematic.
 '''/builder cancel''' - Cancel a build job.
+'''/builder info''' - View a Builder's loaded schematic name and size, as well as the builder's options.
+'''/builder ignoreair''' - Toggles the builder to not set air blocks, false by default. Use this to build into existing block structure.
+'''/builder ignoreliquid''' - Toggles the builder to not set water or lava. Use this if the schematic comes with un-contained liquids.
 ==Usage==
 *.schematic files should be placed in the /plugins/Builder/schematics/ directory.
-* Position the builder in the ''center'' of the footpoint you want to build before calling '''build'''. The size of the schematic is shown upon load.
+* Position the builder, or set the builder's '''origin''', to the ''center'' of the footpoint you want to build before calling '''build'''. The size of the schematic is shown upon load.
+* It is highly recommended to set the '''Origin''' before building. This will allow you to cancel the build and restart it later, the builder will pick up where he left off.
 * The builder will ignore any empty space underneath the schematic object so that it will always rest on the ground where the builder starts.
+* The builder will not attempt to replace blocks that are already set properly, this means you can use a builder to quickly 'restore' any changed blocks in something he has previously built.
 ==Planned Additions==