Skip to content

Latest commit

 

History

History
485 lines (392 loc) · 16 KB

README.md

File metadata and controls

485 lines (392 loc) · 16 KB
Raw

Bonsai Trees

Bonsai Trees 3

A Minecraft mod adding a block that grows small trees in a single block space.

How to get started

  1. Craft a Bonsai Pot and place it somewhere nice.
  2. Find some soil to use in your pot. Dirt will do for now. Right-click it on the Bonsai Pot.
  3. Get a tree sapling and right-click it on the Bonsai Pot. Or open the GUI and insert it into the sapling slot.
  4. Watch it grow.
  5. You can then optionally harvest the tree by clicking the "Axe" button in the GUI.
  6. You can also upgrade your Bonsai Pot with various items. For now, put a wooden axe into one of the upgrade slots - your Bonsai will now be cut automatically.
  7. Place a hopper below the Bonsai to extract the harvested items. Or insert it into an upgrade slot - the bonsai will then automatically export all items on the next harvest.
  8. Use dyes to color your pot. Just right-click the pot while holding any dye.

A particular soil might be needed for some of the trees. And the different types of soil provide different boosts to the growth of your Bonsai. It is recommended to use JEI to look up compatible saplings and available soils. TheOneProbe will show what sapling is growing on what soil and its progress.

Upgrades

Hopper

Insert a hopper into one of the upgrade slots to make the Bonsai Pot automatically export all harvested items into the inventory below. This is not needed to extract the items in a different way, e.g. you can also place the hopper or some piping below the pot.

Axes - or tools that can cut trees

Insert any kind of axe into an upgrade slot to make the Bonsai Bot automatically cut the tree for you once its fully grown. But be aware that items that do not fit into the output buffer will be voided. You can enchant the axe with Efficiency, Fortune and/or Silk Touch to get additional upgrade benefits!

You can configure in the Bonsai GUI whether applied redstone signals stop auto-cutting.

Silk Touch

Some of the things a tree produces requires a Silk Touch upgrade. You can either put an enchanted axe or an appropriately enchanted book into one of the upgrade slots. This does not prevent you from putting additional Fortune Upgrades into the Bonsai Pot.

Bee Hives - or Nests

Your Bonsai won't produce any fruits unless you pollinate them. Easiest is to stick a Bee Hive in there!

Fortune

Increases number of rolls and chance for each possible drop. The higher the level the more items you get and the higher the chance to get uncommon drops.

Efficiency

Reduces the time it takes for a bonsai to fully grow. The higher the upgrade level the faster the growth.

Batteries

Speeds up the growth of the tree by consuming Forge Energy from the upgrade item.

Configuration

Clientside options

  • alwaysRenderAsItem (default: false)
    • Always render trees in bonsai pot as their item equivalent.
    • Use this if you have performance problem. But please note that this is not the intended way for this mod.

Shared options

  • enableFortuneUpgrade (default: true)

    • Enable fortune upgrades
    • These increase the drop rolls and chances
    • Can still be inserted into upgrade slots, but effects are disabled.

  • enableEfficiencyUpgrade (default: true)

    • Enable efficiency upgrades?
    • These decrease the required tick time for a tree to fully grow
    • Can still be inserted into upgrade slots, but effects are disabled.

  • enableHoppingUpgrade (default: true)

    • Enable hopping upgrade?
    • Used to auto-push items to the inventory below
    • Can still be inserted into upgrade slots, but effects are disabled.

  • enableAutoCuttingUpgrade (default: true)

    • Enable auto cutting upgrades?
    • Required for trees to get cut automatically
    • Can still be inserted into upgrade slots, but effects are disabled.

  • enablePollinatingUpgrade (default: true)

    • Enable pollinating upgrades?
    • Required for trees to drop fruit-like items
    • Can still be inserted into upgrade slots, but effects are disabled.

  • enableForgeEnergyUpgrade (default: true)

    • Enable forge energy upgrades?
    • Required for trees to consume energy for growth
    • Can still be inserted into upgrade slots, but effects are disabled.

  • showChanceInJEI (default: true)

    • Show chance for drops in JEI
    • Not sure why you wouldn't want this.

  • sumEnchantmentLevels (default: true)

    • Summarize enchantment levels instead of using the highest level?
    • I.e. is '4 x Fortune III = Fortune XII'?
    • One can consider this to be quite overpowered.

  • extraRollsPerFortuneLevel (default: 1)

    • Drops: How many extra rolls per fortune enchantment level?
    • The more rolls the more items can be gained

  • extraChancePerFortuneLevel (default: 0.05)

    • Drops: What is the bonus chance to get a successful drop per fortune enchantment level?
    • The higher the chance the more likely it is that a roll counts towards the result.
    • These sum up, e.g. Fortune V gives a 25% chance boost with the default settings.

  • allowBonemeal (default: true)

    • Allow usage of bone meal on bonsai pots to boost their growth?
    • This is not really efficient - growing a regular sapling with bone meal results in larger amounts of wood than in a Bonsai Pot. Unless the Bonsai Pot is stuffed with Fortune upgrades - then it might be worth it.

  • bonemealSuccessChance (default: 0.45)

    • How likely is it for bonemeal to succeed in boosting growth?

  • hoppingCooldown (default: 60)

    • How many ticks to wait before trying to insert items into the inventory below after failure?
    • Lowering this increases load on the server.

  • cuttingCooldown (default: 60)

    • How many ticks to wait before trying to cut the tree automatically after failing to do so?
    • Lowering this slightly increases load on the server.

  • minimumRequiredTicks (default: 10)

    • How many ticks it takes for a tree to grow at minimum. No upgrades etc will make it grow faster than this.
    • Lowering this increases load on the server, especially if you have a lot of trees.

  • requiredTicksModifier (default: 1.0)

    • Use this to globally speed up or slow down the growth of all trees.
    • This is multiplied with all other growth time modifiers.

  • maximumExtractedEnergyPerTick (default: 60)

    • How much energy can be extracted from the upgrade item per tick?
    • This is the maximum amount of energy that can be used to grow a tree per tick.

  • extraGrowthRatioPerFE (default: 0.005)

    • How much faster a tree grows per extracted Forge Energy. (Example: 1.0 + 60fe/t * 0.005 = 1.3x faster)

  • autoCuttingDamagesItems (default: false)

    • Auto-cutting does damage to the used axe upgrade
    • This means tools will break inside the bonsai pot.
    • The top side of the block can be used to access the upgrade slots and refill automatically.

  • autoCuttingDamageChance (default: 0.075)

    • How likely is it that the axe upgrade takes damage for each tree it cuts?
    • This is independent of the Unbreaking enchantment

Tree Compatibility

Supported Saplings and Soils are completely configurable via .json files. There are a bunch of examples available in the repository for all the vanilla trees. But to make this more straight forward here's a quick rundown of what is needed for a tree to be supported:

Step 0, JSON

Know how JSON works. Here's a good quick rundown. Especially don't include any of the comments from the examples here in the .json files.

Step 1, Soil

Create the soil recipe first. You can skip this if you don't have custom soil requirements.

{
  "type": "bonsaitrees3:soil",                 // The recipe type. Must be "bonsaitrees3:soil"
  "conditions": [{                             // Conditions are optional
    "type": "forge:mod_loaded",
    "modid": "tconstruct" }                    // The mod required for this soil to get loaded
   ],
  "tickModifier": 1.0,                         // The time to grow a tree is multiplied by this value
  "soil": {
    "item": "minecraft:grass_block"            // The item that plants this soil in the bonsai pot
  },
  "compatibleSoilTags": [
    "grass"                                    // Only trees also having these tags can grow on this soil
  ],
  "display": {
    "block": "minecraft:grass_block"            // The block that's being used to render the soil
    // "fluid": "minecraft:lava"                // You can also use fluids here!
    // "texture": "bonsaitrees3:block/hopping_bonsaipot"  // Or a custom texture.
  }
}

Step 2, Sapling

Create the sapling recipe:

{
  "type": "bonsaitrees3:sapling",               // The recipe type. Must be "bonsaitrees3:sapling"!
  "conditions": [{                              // Conditions are optional
    "type": "forge:mod_loaded",
    "modid": "tconstruct" }                     // The mod required for this tree to get loaded
   ],
  "sapling": { "item": "minecraft:azalea" },    // The ingredient that grows this tree (or whatever). Can also be an array of ingredients!
  "drops": [                                    // An array of drops this tree produces each harvest
    {
      "rolls": 1, "chance": 0.05,               // The number of rolls and the chance for each roll for this drop
      "result": { "item": "minecraft:azalea" }  // The name of the item for this drop
    },
    {
      "rolls": 1, "chance": 0.75,
      "result": { "item": "minecraft:oak_log" }
    },
    {
      "rolls": 3, "chance": 0.2,
      "result": { "item": "minecraft:stick" },
      "requiredUpgrades": {                     // EXPERIMENTAL: This allows configuring additional upgrade item required for this drop
        "tag": "forge:fences"                   // This is a bit of a stupid example: Sticks only drop if a fence is used as upgrade item.
      }
    },
    {
      "rolls": 2, "chance": 0.15,
      "result": { "item": "minecraft:azalea_leaves" },
      "requiresSilkTouch": true                 // Indicates that this item only drops if a Silk Touch upgrade is present
    },
    {
      "rolls": 2, "chance": 0.05,
      "result": { "item": "minecraft:flowering_azalea_leaves" },
      "requiresBees": true                      // Indicates that this item only drops if a Bee Hive/Nest upgrade is installed
    }
  ],
  "compatibleSoilTags": ["dirt", "grass"]       // What types of soil this tree can grow on
}

Step 3, Model

Create the model for the tree or whatever it is that you want to make growable. That's pretty easy as long as you don't want to write the json file yourself. If there is no model for your sapling it will be rendered as the item version instead.

a) Start up the game and find the tree, structure that should be grown in the pot.

b) Isolate it from any other blocks touching it. Diagonally also counts! To make sure just add a 2 block margin of air around the "thing".

c) Run the /bonsai maker X Y Z command by looking at the thing and using tab completion. This will copy the wanted JSON into your systems clipboard. Paste it into the newly created file.

d) Adjust the type property to bonsaitrees3:sapling/XXX/YYY, where XXX is the mod id and YYY is essentially the name of the sapling file. Following the example above that would be "type": "bonsaitrees3:sapling/minecraft/azalea_tree".

Do not write these yourself! 
{
  "type": "bonsaitrees3:sapling/minecraft/azalea_tree",
  "version": 3,
  "ref": {
    "a": {
      "block": "minecraft:azalea_leaves",
      "properties": {
        "distance": "1",
        "persistent": "false"
      }
    },
    "b": {
      "block": "minecraft:flowering_azalea_leaves",
      "properties": {
        "distance": "2",
        "persistent": "false"
      }
    },
    "c": {
      "block": "minecraft:azalea_leaves",
      "properties": {
        "distance": "4",
        "persistent": "false"
      }
    },
    "d": {
      "block": "minecraft:oak_log",
      "properties": {
        "axis": "y"
      }
    },
    "e": {
      "block": "minecraft:flowering_azalea_leaves",
      "properties": {
        "distance": "3",
        "persistent": "false"
      }
    },
    "f": {
      "block": "minecraft:azalea_leaves",
      "properties": {
        "distance": "3",
        "persistent": "false"
      }
    },
    "g": {
      "block": "minecraft:azalea_leaves",
      "properties": {
        "distance": "2",
        "persistent": "false"
      }
    },
    "h": {
      "block": "minecraft:flowering_azalea_leaves",
      "properties": {
        "distance": "4",
        "persistent": "false"
      }
    },
    "i": {
      "block": "minecraft:flowering_azalea_leaves",
      "properties": {
        "distance": "5",
        "persistent": "false"
      }
    },
    "j": {
      "block": "minecraft:azalea_leaves",
      "properties": {
        "distance": "5",
        "persistent": "false"
      }
    },
    "k": {
      "block": "minecraft:azalea_leaves",
      "properties": {
        "distance": "6",
        "persistent": "false"
      }
    },
    "l": {
      "block": "minecraft:azalea_leaves",
      "properties": {
        "distance": "7",
        "persistent": "false"
      }
    },
    "m": {
      "block": "minecraft:flowering_azalea_leaves",
      "properties": {
        "distance": "1",
        "persistent": "false"
      }
    },
    "n": {
      "block": "minecraft:flowering_azalea_leaves",
      "properties": {
        "distance": "7",
        "persistent": "false"
      }
    }
  },
  "shape": [
    [
      "     ",
      "     ",
      "  f  ",
      "   ll",
      "  m  ",
      "     ",
      "     "
    ],
    [
      " cf n",
      " fgf ",
      " fgfc",
      " gm  ",
      " ad k",
      "  d  ",
      "  d  "
    ],
    [
      "cfge ",
      "f agf",
      "fgabf",
      "gadm ",
      " gm j",
      "     ",
      "     "
    ],
    [
      "fgab ",
      "badag",
      "badmg",
      "fgagf",
      " f  c",
      "     ",
      "     "
    ],
    [
      " bagf",
      "gadag",
      "fgag ",
      " fg c",
      "ic   ",
      "     ",
      "     "
    ],
    [
      "he   ",
      "egabf",
      "hfge ",
      "  f  ",
      "     ",
      "     ",
      "     "
    ],
    [
      " c c ",
      "   fc",
      " h   ",
      "     ",
      "     ",
      "     ",
      "     "
    ]
  ]
}

Step 4: Bundle it up

Equipped with these three files you now need to either create a Pull Request to get the support into the mod itself. Or you create a data and a resource pack to distribute with your modpack. The files for the soil and sapling recipe belong into a data pack, whereas the model belongs into a resource pack. The easiest way to get going there is to use the Open Loader mod.

Where the files need to get placed depends on the way you want to integrate these changes. For Pull Requests this should be

  • src/main/resources/assets/bonsaitrees3/models/tree/XXX/YYY.json for the model
  • src/main/resources/data/bonsaitrees3/recipes/sapling/XXX/YYY.json for sapling recipes
  • src/main/resources/data/bonsaitrees3/recipes/soil/XXX/YYY.json for soil recipes

If you create a datapack or resource pack your paths will be slightly different. Please read the Open Loader description and the wiki pages it links to (1, 2) to learn more about this.

Contributing to the project

You can easily help in multiple ways:

  • Add translations using POEditor
  • Create json files to support trees added by other mods
  • Create data packs for originally unintended things: e.g. create a data+resource pack that allows growing iron/copper/gold nuggets. We are happy to promote those here and on the CurseForge project page.
  • I am also looking for someone who can deal with Pull Requests for new trees/soils. If you know your way around json and git and want to help, please feel free to contact me.