Ecompatible

Ecompatible v0.2.0

For Eco v0.11.1.0+

This is a library for other mods to independently affect various game values such as how many blocks shovels dig and how trees are processed.

It also has config files so you can configure "Big Shovel" and "Easy Logging" -style behaviour

Usually this would mean creating override files which are incompatible with any other changes other mods want to the same values without the user patching them together. For instance XP Benefits increases how many blocks can be picked up, which requires an override for TreeObject.cs, making it incompatible with Easy Logging-style mods which also replace the same file. By using Ecompatible both mods can apply their effects independently of one each other.

Config file for "Big Shovel" functionality

This mod provides a server config file "EcompatibleShovel.eco" where you can configure how many blocks each shovel can pick up.

Config file for "Easy Logging" functionality

This mod provides a server config file "EcompatibleAxe.eco" where you can configure how trees get automatically processed when felled. When the tree falls it will start slicing off pieces of the tree starting from the bottom, deal damage to the stump and chop up debris as it spawns. These actions go through the law system and use calories and tool durability as if the player manually used their axe. If the tree doesn't fall because it's supported by nearby trees or blocks, then it will get processed after a short timer instead. 

The values you can change are:

• "FractionOfTreeToAutoSlice" - How much of the tree should be automatically sliced up.
• "DamageToStumpWhenFelled" - How much damage should be dealt to the stump.
• "MaxTreeDebrisToSpawn" - What is the maximum number of debris to spawn per tree.
• "ChanceToClearDebrisOnSpawn" - What is the chance for each debris to get automatically cleared.

Modders

Welcome! I made this library so that we can make our mods compatible and make implementing new modifiers to these game values easy, and I'll continue to expand on it if new situations arise. If you have ideas for new values that you'd like supported let me know.

Each value is resolved using a context object which contains useful information you can base your modifier on. See the readme files in the download for more information on this.

Currently there are resolvers for:

• Sweeping Hands pickup range
• Carried inventory stack size
• Tree processing steps, as explained above

Note: if you add your own inventory restriction to overwrite the Carried inventory stack size, it won't be compatible because sweeping hands and picking up logs depend on the value provided by Ecompatible, but there is a resolver for this value where you can apply your modifier to multiply or overwrite any existing values.

Be aware that because it's a new library it is more likely to undergo breaking changes, but I'll do my best to document these and support old versions of the API so you have time to update. I've intentionally kept the public API as small as possible to limit breaking changes.

What's likely to come?

• Option for automatically pick up a fraction of the logs when the tree falls
• Sweeping Hands for logging - pick up logs within a range
• Sweeping Hands for mining to not always require the talent but the distance be configurable by other mods - the default behavior will still be vanilla
• Option for automatically picking up a number of rubble when mining
• Tooltips for axes to show how much of the tree will be automatically chopped up, collected etc