Arable

Flexible, hardcore farming for the masses

Arable lets you tweak how fertile or hostile your world's arable land is. Do you live in a farmer's paradise, where every seed instantly grows to maturity? Or do you live in a desolate wasteland where crops wither and die, even catching fire in the searing heat of the sun? With Arable, you can control the agricultural impacts of all kinds of environmental conditions, including biome, growth stage, elevation, light level, and more.

Your world, your rules

Arable gives you a single, immensely powerful tool to bend the world to your whim: arable rules. Each rule has a set of conditions and a set of effects. If a crop matches a rule's conditions, the effects get applied. Effects can include anything from increasing or decreasing the growth rate (both the average rate and the variability) to a crop's chances of succumbing to a number of nasty effects such as being uprooted or incinerated. The best part about it is that you can have an unlimited number of rules per world and every rule can stack!

Features

Conditions

block type
growth stage
biome
wetness
humidity
temperature
elevation
weather
time of day
light level (total, sunlight, and/or blocklight)

Effects

slow down or speed up plant growth rate
affect crop growth variability
ripen a plant or grow a mushroom tree
cause plants to wilt, reversing growth
uproot plants
destroy plants, leaving nothing behind
ignite plants
bury plants under snow
start a nasty (and contagious!) blight

There are several other plugins that I would like to integrate with, including Seasons and Terrain Control. I would also like to add the /arable command so you can query, modify, and reload arable rules without restarting the server. If you have any suggestions of your own, I would love to hear about them. You can let me know via comment, message, or ticket.

Configuration

There are four configuration sections: rules, defaults, worlds, and advanced. The following sections are brief introductions to each. For more in-depth information, including a list of supported conditions, effects, blocks, and biomes, check out the Configuration page.

rules

The rules section is the meat of your configuration file, it's where you list out all of the arable rules that you want to use. In fact, for single-world setups, the rules section is the only section you'll need to use. Here is a sample rules section that shows a small number of the available conditions and effects:

rules:
    desert-sun:
        # conditions
        blocks:  [wheat,melon,pumpkin,carrot,potato,sugar]
        biomes:  [desert,deserthills]
        minSunlight: 9
        # effects
        rate:     0.5
        spread:   0.1
        wilt:     0.1
        die:      0.1
        burn:     0.1
    cold-frost:
        # conditions
        maxBlocklight:  10
        maxTemperature: 0.1
        # effects
        frost:  0.1

defaults

By default, all rules in the "rules" section apply to all game worlds. If this is what you want, then you're already done! If, however, you want to override the default rule list, you need to create a "defaults" section. The format is simply a list of the default rule names. Here is a defaults section that applies the "desert-sun" rule by default (leaving out "cold-frost"):

defaults:
    - desert-sun

worlds

The worlds section lets you override the default rule list for specific worlds. You only need this section if you want to have worlds with unique rule lists. If a world is not listed here, it receives the default rule list. Here is a worlds section that only applies the "cold-frost" rule to WorldA, and only applies the "desert-sun" rule to WorldB:

worlds:
    WorldA:
        - cold-frost
    WorldB:
        - desert-sun

advanced

The advanced section is for modifying how the plugin does its job. This is a section that you will most likely never need to deal with, but it's here in case you need to exercise extreme control over Arable. Here is an advanced section that doubles the update interval (might be useful if you encounter lag):

advanced:
    interval: 2

Compatibility

The way the plugin works right now, it probably won't be compatible with plugins that restrict crop growth. I have an idea of how to fix this, though, and will hopefully get the time to do so in the future. If there are any major plugins in the farming and/or area protection genre that you have discovered are compatible or incompatible with Arable, please let me know and I'll list them here:

Seasons and SeasonsPlusPlus both have their growth rates replaced with Arable's rates. There is currently no way to limit rules to particular seasons, but this is a feature I have decided to work on in the near future (see Ticket #2).
TerrainControl custom biomes don't work in the biomes condition, but they do respond to humidity and temperature conditions.

Bugs

Seeing as this plugin is fairly new, there is a chance of it containing a bug or two. There is a small chance that these bugs may in fact be harmful to your server in some way. While I will be deeply regretful and work my hardest to solve any such problems, I cannot be held responsible for them; you use this plugin at your own discretion.

In the event that you discover a bug, I would greatly appreciate it if you let me know, preferably by opening a ticket.

Versions

v0.9.2 [beta] [CB 1.4.7-R1.0] - fix lag and memory issues on shutdown
v0.9.1 [beta] [CB 1.4.7-R1.0] - add missing crop types, grow cocoa pods
v0.9.0 [beta] [CB 1.4.7-R1.0] - moved data to "data" folder, new effects and conditions, bug fixes
v0.8.1 [beta] [CB 1.4.7-R1.0] - fixed several bugs, including the addition of Java 6 compatibility
v0.8.0 [beta] [CB 1.4.7-R1.0] - initial beta; looking for feedback and bug-squashing