GiantTrees

This plugin now only uses official Bukkit APIs, so it should be future proof. Recently tested with Spigot 1.15.

Giant Trees is a plugin for adding procedurally generated giant trees to your Spigot world. Giant trees are generated in three ways:

Grow trees in creative/survival mode by planting saplings and fertilizing with bone meal
Summon trees with a command
Generate trees naturally when new forested biomes spawn

Giant Trees is based on the tree generation algorithm described in Creation and Rendering of Realistic Trees by Jason Weber and Joseph Penn as implemented by Wolfram Diestel in Arbaro.

IMPORTANT NOTES for version 3.2

Custom trees can be added to a biome by naming the tree and root files as such:

biome.<biome>-<name>.xml
biome.<biome>-<name>.root.xml

Where <biome> is the biome in question - FOREST, BIRCH_FOREST, DARK_FOREST, SWAMP, MANGROVE_SWAMP, JUNGLE, BADLANDS, SAVANNA and TAIGA,
hyphen separator between biome and tree name is required,
and <name> is anything you want to call the tree using lowercase and uppercase letters, numbers, underscore or hyphen.

For example. to have Oak, Cottonwood, and Bramble Wood trees spawn naturally in the FOREST biome, the file names could be something like this:

biome.FOREST-BrambleWood.xml (along with .root.xml file)
biome.FOREST-COTTONWOOD.xml (along with .root.xml file)
biome.FOREST-Oak.xml (along with .root.xml file)

The base set of biome tree files that come with the plugin have been renamed to include the tree name in the filename. So biome.FOREST.xml and biome.FOREST.root.xml were just copies of tree.OAK.xml and tree.OAK.root.xml, so are now called biome.FOREST-OAK.xml and biome.FOREST-OAK.root.xml. Additional tree types you create should follow this naming convention.

When a tree is going to be generated the tree files are read from the plugin directory for the biome in question, and a tree chosen at random from the selection. New trees can be placed in the folder and will be included in future selections. No restart or reload is required to get a new tree into a biome.

You might want to remove the biome tree files from the plugin directory if upgrading from older versions, but given they don't follow the naming convention they will not be used.

Feel free to send in your trees for inclusion in the plugin!

IMPORTANT NOTES for version 3.1

The 3.1 version uses a new configuration file format. You cannot use the old configuration file with this version. If you do the plugin will detect an incorrect configuration and disable the tree generation. You must wipe out the old GiantTrees folder in the plugins folder and let it create a new config and then you can put back any settings you changed. The 3.1 version and the new config file format allows for custom trees beyond the standard saplings and now gives you the option of changing patterns for the base tree set too. For example, the new mesapuzzle tree has a pattern that is made from both Acacia and Oak saplings. Each tree in the game has it's own recipe now and doesn't use the 'S' sapling generic pattern. Core block is indicated by an 'X'. Check the config file for details.

You now need to right click the core block and not the saplings in order to generate the tree.

The pattern matching routine has also been changed to be simpler and I think, more flexible for future updates. It uses a series of 90 degree rotations of the recipes in an attempt to match a sapling pattern laid out in the 5x5 grid. This means you can put put a complex pattern but not have to worry about compass orientation. It currently doesn't flip the pattern, but that might be something to add later.

Do not use the reload command on your server. Restart the server for changes to take effect. If you encounter lag, try reducing the number of blocks updated per tick in the config. Dark Oak is really laggy! Ensure you have at least 2GB of memory allocated to the server.

Report any issues on the github repository.

Planting Giant Trees

To plant a giant tree in creative/survival mode, perform the following steps:

Flatten a 5x5 area of dirt or grass
Place the core block as defined in the config (default EMERALD_BLOCK) in the center
Surround the core block with two rings of saplings according to the pattern for the tree you want
Right click the core block with a stack of 64 bone meal
Stand back (default of 3 seconds to get out of the way)

Commands

To create a giant tree with a command, use the /tree-create or /gt command, followed by the name of the tree. Tree names are found in the plugin's data directory. For example, to summon a giant acacia tree, use the command

/gt tree.ACACIA

To edit the model for an existing tree, or create a new tree model, use the /tree-edit command. This command can only be used from the server console.

/tree-edit tree.ACACIA

Naturally Growing Trees

By default, Giant Trees will grow naturally in newly generated chunks in the default overworld (the world called "world"). To add giant trees to more worlds, increase the frequency of tree growth, or disable natural tree growth altogether, edit the plugin's config.yml.

Making Your Own Giant Tree Species

You can make your own species of giant tree. Start by using the /tree-edit command from the server console, giving it the name of the tree you want to edit or create. (For new trees, ignore the file not found error). As an alternative, you can double-click the Giant Trees plugin .jar file to start the visual tree editor.

Design your tree using the visual tree editor. When you are done, click save and exit the visual editor. To add roots to your tree, create another tree with the same name as your tree, with .root added to the end. For example, /tree-edit tree.ACACIA.root. Root trees are rendered upside down in the world and scaled to match their tree.

Permissions

gianttrees.create (default OP) - Allows the creation of a giant tree using the tree-create command.
gianttrees.grow (default true) - Allows a player to grow a giant tree by fertilizing a grid of saplings.

Installation

Make sure you have Apache Maven installed.
Clone this repo.
Run mvn package in the plugin directory.
Copy the Giant Trees jar file from the target directory to your server's plugins directory.
Restart your server.

or the simple way:

Download the jar file from the latest release in the github repository
Move the jar file to the plugins folder
Restart your server.

Ifiht/GiantTrees