Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
SchematicBrush is a simple add-on plugin for WorldEdit on the Bukkit platform. Consequently, the plugin cannot be used without WorldEdit having been properly installed.
SchematicBrush adds a new type of brush control for WorldEdit - one based on the application of contents of one or more schematic files. One activated, each use of the brush tool will load the appropriate schematic file into the clipboard, optionally rotate and/or flip the data, and then apply it with the center of the bottom of the given schematic centered on the location the brush was applied.
The brush can be set to select more than one schematic source : in this event, each use of the tool will randomly select a schematic among those listed. In addition, each schematic selected can optionally indicate that either a specific or a random value be used for rotating and/or flipping the schematic before it is pasted. The format for schematic specifications is as follows:
- name@rotation flip
- Any combination of the above (name followed zero or more of the appropriate separator and values)
- name is the name of the schematic file to be used. Names can also include wildcards (* or ?, as used on Windows or Linux command line) or can be regular expressions (these must start with ^ - see http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html for regex details). In these cases, each use of the schematic specification will randomly select one of the schematics matching the given pattern.
- rotation is the rotation, in degrees, to be applied to the schematic once loaded (see //rotate command). If '*' is specified, a rotation is selected at random. Other valid values are 0 (default), 90, 180, and 270.
- flip is the flip option specified. If '*' is specified, a random selection is made (none, north-south, or east-west). If 'N' or 'S' is specified, the loaded schematic is flipped north-to-south before being applied. If 'E' or 'W' is specified, the loaded schematic is flipped east-to-west before being applied.
- weight allows specific control of the random selection of the schematic. If specified, the value is the percent chance that the given schematic will be selected. If not specified, the schematic is equally likely to be selected as any other that has not specified a weight (and all those share whatever percentage remains once the weight values for those schematics that specified a value are totaled).
- format allows the format of the given schematic file to be specified: at present WorldEdit only supports the MCEdit format (look-up 'mcedit' or 'mce').
- offset is an offset added to the Y position of the schematic, causing it to place above (positive) or below (negative) where it would otherwise be placed. As of SchematicBrush v0.4 or later.
SchematicBrush also allows definition and use of schematic sets: persistent named collections of schematic specifications. Once defined, a schematic set can be used by any authorized user on the server. Each schematic set consists of a name, an optional description, and a list of one or more schematic specifications.