Builder: Difference between revisions

From Citizens Wiki

No edit summary
No edit summary
Line 3: Line 3:
| AUTHOR      =  jrbudda
| AUTHOR      =  jrbudda
| NAME        = Builder
| NAME        = Builder
| VERSION    = 0.2.1
| VERSION    = 0.3
| CITIZENSBUILD  = [http://ci.citizensnpcs.com/job/Citizens2/ 2.0.1 dev build #343]
| CITIZENSBUILD  = [http://ci.citizensnpcs.com/job/Citizens2/ 2.0.1 dev build #343]
| DEVSTATUS    = InDev
| DEVSTATUS    = InDev
Line 20: Line 20:
==Updates==
==Updates==
{{scrollbox|
{{scrollbox|
'''v. 0.3 Alpha''' 9/11/2012
* Added Denizen Task script execution option on build completion and cancellation. (broke at the moment, I think on the Denizen side)
* Reduced memory usage of loaded schematics by 80%.
* Last loaded schematic is now persistent.
* Lots of updates to messages and info.
'''v. 0.2.1 Alpha''' 9/9/2012
'''v. 0.2.1 Alpha''' 9/9/2012
* added commands origin clear, origin schematic, check, compare
* added commands origin clear, origin schematic, check, compare
Line 50: Line 56:


==Commands==
==Commands==
All commands can be run on a selected NPC as shown (<code>/builder [command]</code>), or on a target NPC with <code>/builder [npcid] [command]</code>.
'''/builder load [schematic]''' - Loads a .schematic file. simply use the name of the schematic.
'''/builder load [schematic]''' - Loads a .schematic file. simply use the name of the schematic.
Example
Example
Line 88: Line 96:
***Call /builder build and the builder will place any missing blocks or destroy new ones.
***Call /builder build and the builder will place any missing blocks or destroy new ones.
*Builder will {{color|red|white| NOT}} create sign text, chest contents, or anything else that uses extended data. (yet)
*Builder will {{color|red|white| NOT}} create sign text, chest contents, or anything else that uses extended data. (yet)
==Advanced Usage==
* Builder can be set to run [[Denizen]] Task Scripts on completion or cancellation of a build.
**The NPC must have both the Builder and [[Denizen]] Trait.
**Call <code>/builder build</code> with the optional modifiers <code>oncomplete:TaskName</code> and/or <code>oncancel:TaskName</code>. Example:
/builder build oncomplete:DespawnTask oncancel:AnnounceTask
**Only certain commands are valid in a Task script of this kind. See [[..something]]
**This usage would almost always be used from another Denizen script, although you may call it in-game, if you wish.


==Planned Additions==
==Planned Additions==

Revision as of 06:18, 11 September 2012

Builder.png

Builder


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

Builder is NOT compatible with the released Citizens 2 on bukkitdev. Use the link at the right to download the latest Citizens2 dev build to use Builder


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.3 Alpha 9/11/2012

  • Added Denizen Task script execution option on build completion and cancellation. (broke at the moment, I think on the Denizen side)
  • Reduced memory usage of loaded schematics by 80%.
  • Last loaded schematic is now persistent.
  • Lots of updates to messages and info.

v. 0.2.1 Alpha 9/9/2012

  • added commands origin clear, origin schematic, check, compare

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.*
  • builder.[name of command]

Commands

All commands can be run on a selected NPC as shown (/builder [command]), or on a target NPC with /builder [npcid] [command].

/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 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.

/builder check - Display a list of all the block types/count of the loaded schematic.

/builder compare - Display a list of all the block types/counts of the loaded schematic and compare to the player's inventory. Not really useful for anything, yet.

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.
    • 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.
  • Builder will NOT create sign text, chest contents, or anything else that uses extended data. (yet)

Advanced Usage

  • Builder can be set to run Denizen Task Scripts on completion or cancellation of a build.
    • The NPC must have both the Builder and Denizen Trait.
    • Call /builder build with the optional modifiers oncomplete:TaskName and/or oncancel:TaskName. Example:
/builder build oncomplete:DespawnTask oncancel:AnnounceTask
    • Only certain commands are valid in a Task script of this kind. See ..something
    • This usage would almost always be used from another Denizen script, although you may call it in-game, if you wish.

Planned Additions

  • Rotate/flip schematic before build.
  • Economy costs for building.
  • Require materials for building.
  • Configuration for schematics directory, default options.


Donate to jrbudda