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.
- Collect the required materials from players before building.
- 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
/npc create Bob /trait builder
- builder.* Give access to all Builder permissions.
- builder.[command] Give access to [command].
- builder.donate Allows players to donate to a builder in Supply Mode (useful for locking out creative mode players)
Builder will create Builder/config.yml if it does not exist already. Be sure to check the configuration page if new options are added.
All commands can be run on a selected NPC as shown (
/builder [command]), or on a target NPC with
/builder [npcid] [command].
/builder list - Lists all available schematics in the configured schematics folder. Does not require a builder selected.
/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 origin clear - Clears the saved build origin.
/builder origin schematic - Sets the origin of the builder's projects to the origin of the loaded schematic. Best used for schematics created from the builder's world with worldedit.
/builder origin me - Sets the origin of the builder's projects to the player's position. Does not work from the console.
/builder origin current - Sets the origin of the builder's projects to the origin of the project currently being built. Use this if you forgot to set the origin before starting to build, and need to cancel it to resume later.
/builder origin x,y,z - Sets the origin of the builder's projects to the location x,y,z of the builder's current world.
/builder mark (item) - Places a block at the 4 corners of the footprint, then returns to the origin, so you can see where it's going to build. You can specify the item to use, although that item must be allowed in the config.yml. The first item on the list in the config is the default if no item is specified. If the config is missing the builder will use GLASS.
/builder timeout [value] - Sets the maximum time, in seconds, between blocks. Valid values are 0.1 - 2000000.0. Default is 2.0. Default can be changed in the config.yml.
/builder build (option1) (option2) ... etc - Start building the schematic. This command takes several optional arguments. The order does not matter. you can add to this command the following:
- linear - build north to south
- reverselinear - build south to north
- sprial - build inside to outside (this is the default and thus does not need to be specified.)
- reversespiral - build outside to inside.
- excavate - The builder will clear out the area of blocks before starting to place them.
- layers:# - The builder will build # number of layers at a time, the default is 1.
- yoffset:# - The builder will start building the specified number of blocks up or down from the set starting location.
- groupall - the builder will build all of a group of materials at once, instead of doing it per layer.
- ignoreair - the builder will not place air blocks. (Use to build into an existing structure, pointless if used with excavate)
- ignoreliquid - the builder will not place lava or water blocks. (Use if the schematic has unconstrained liquids on the bottom.)
- onstart:Task - the builder will run the Denizen task script on start of build (after material collection). See #Advanced Usage
- oncomplete:Task - the builder will run the Denizen task script on completion of build. See #Advanced Usage
- oncancel:Task - the builder will run the Denizen task script on cancellation of build. See #Advanced Usage
- silent - the builder will not send completion/error messages to the command sender.
/builder build /builder build excavate reverselinear yoffset:-3 /builder build ignoreair ignoreliquid oncomplete:Celebrate /builder build groupall layers:3
/builder cancel - Cancel a build job.
/builder info - View a Builder's loaded schematic name and size, as well as the builder's options and status.
/builder survey (excavate) - Display a list of all the block types/count it would require to build at the current location. Specify excavate to show the list of materials if excavation is used. Does not show water or lava.
/builder supply true|false set whether the builder will need to be given the materials before he will start building. See #Supply Mode
/builder hold true|false set whether the builder will hold the items he is placing (Turn off only for compatibility with other plugins like Sentry)
/builder reload - reload options from the builder config.yml
/builder help - Display the help.
- .schematic files should be placed in the /plugins/Builder/schematics/ directory. This directory can be configured in the config.yml
- 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.
- You can cancel a build and resume it later if you have an Origin set. You can use
/builder origin currentto set the origin after building has started if you forgot.
- Do not try to resume a build with the excavate option!
- The builder will ignore any empty space underneath the schematic object so that it will always rest on the ground where the builder starts. If you want to build above or below the origin, use the yoffset: build option.
- 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.
- To set up a builder to maintain an existing building:
- Select the building with worldedit and save it as a schematic.
- Copy the schematic to the builder's schematics directory.
- Load the schematic to a builder and call
/builder origin schematic.
- Call /builder build and the builder will place any missing blocks or destroy new ones.
- To set up a builder to maintain an existing building:
- Rail and dispensers my not be placed correctly. (Hey this is Construction, not Engimaneerin'.)
- By default, NPCs despawn when their chunk unloads. This behavior can be changed in the Citizens2 config.yml, and is recommended if you would like builders to continue to work unattended.
If the Builder is set to require materials for building (with /builder supply true), he will go into Supply Mode when /builder build is called. When Supply Mode starts the Builder will survey the build site and generate a list of required materials to start building. Players must provide these materials for the builder to begin.
While in Supply Mode:
- Right-Click the Builder with an empty hand to view the list of materials still needed.
- Right-Click the Builder with any block or item to see if he needs it. If he does, he will tell you how much he still needs.
- After clicking with a needed material, Right-Click again within a few seconds to give it to the Builder.
- After receiving a material the Builder will say how many more blocks he needs in total to begin, or he will begin building if he has everything.
What materials are required:
- By default all blocks require their normal drop type (i.e. Cobwebs require String)
- This behavior can be overridden via the 'supply.txt' file found in the \Builder folder.
- Each line contains the Item ID of the block in the schematic, and the ItemID of the block/Item that is required.
- Optionally you can specify the number of blocks/items required for each source block.
- Setting the required Item ID to 0 will not include that source block in the requirements.
|Default Supply Mode configuration|
Original Block Number:Require Item Number:Amount(Optional) Set to 0 to never require block. Blocks not specified will require their normal drop item. 90:0 97:0 95:54 78:0 34:0 119:0 80:80 92:354 43:44:2 125:126:2 20:20 102:102 47:47 103:362 130:130 134:53 135:53 136:53 128:67 109:67 108:67 79:332 51:0 59:295 72:70 71:330:0.5 26:335:0.5
All blocks are currently matched on Item ID only. This means:
- All Wool is Wool. Color is ignored building the list, and any color wool can be given to fulfill the requirement.
- The same goes for saplings, slabs, logs, and wood planks.
- Stairs are similar. All wood stairs count as 'oak'. All stone/brick stairs count as 'stone' with the exception of nether brick stairs which are separate.
If the build is canceled at any point, the collected materials are lost.
- Builder can be set to run Denizen Task Scripts on start, completion, or cancellation of a build.
- The NPC must have both the Builder and Denizen Trait.
/builder buildwith the optional modifiers
/builder build oncomplete:DespawnTask oncancel:AnnounceTask
- Builder can also run Denizen Actions at the 3 indicated events. Add the following to the NPC's actions:
- "Build Start"
- "Build Complete"
- "Build Cancel"
BuilderAssignment: type: assignment actions: on Build Start: - ANNOUNCE "Let's do this!" on Build Complete: - ANNOUNCE "I have finished!"
For more complex examples with Denizen and Builder see Builder and Denizen Examples
Q: How can I use multiple builders on one project?
A: You can use up to 4 builders on one project by giving them all the same schematic and origin, but different build patterns. You can also manually split your schematic into multiple parts with WorldEdit or MCEdit.
Q: How can I make builders go faster?
A: Use the /builder timeout command to set the max time between blocks. You can also make the builder walk faster with "/npc speed"