EcoTale Income

💰 EcoTaleIncome

Earn currency through gameplay on your Hytale server

Reward players for mob kills, mining, woodcutting & farming — with RPG level-scaling, VIP multipliers, depth bonuses, anti-farm protection, and a pluggable economy system.

---

✨ Features

• ⚔️ Mob Kills — 7 reward tiers from Critter to World Boss with level-scaling
• ⛏️ Ore Mining — 12 ore types with depth bonus (deeper = more coins)
• 🪓 Woodcutting — 18+ tree types from Softwood to Ebony
• 🌾 Farming — 15 crop types, F-key + LMB harvesting (configurable)
• 📈 RPG Level Scaling — optional integration with RPG Leveling (level difference = bigger multiplier)
• 👑 VIP Multipliers — permission-based ×1.25 / ×1.50 reward multipliers
• 🛡️ Anti-Farm Protection — rate limits, diminishing returns, block cooldowns, placed-block exploit protection
• 🔌 Pluggable Economy — built-in Ecotale support + API for any economy plugin
• 🧩 Generic Adapter — connect any economy plugin without writing Java code
• 🔧 Custom Blocks — add rewards for modded ores, trees, and crops
• 🔧 Hot Reload — /income reload, no restart needed
• 🌍 Localization — support for 6 languages — EN, RU, PT-BR, FR, DE, ES

---

📦 Requirements

Dependency	Required	Description
Ecotale ≥ 1.0.0	✅	Economy & currency system
RPG Leveling ≥ 0.2.0	✅	Level-scaling for mob rewards
EconomyAPI ≥ 1.4.5	✅	Economy & currency system
MMO Skill Tree ≥ 0.11.2	✅	Level-scaling for mob rewards
Endless Leveling ≥ 5.13	✅	Level-scaling for mob rewards

---

🚀 Installation

1. Download EcoTaleIncome-1.1.0.jar
2. Place it in your server's mods/ folder
3. Make sure Ecotale is also installed
4. Start the server — config is created automatically

All modules are enabled by default with balanced reward values.

---

🎮 Commands

Command	Description
/income	Current status & balance
/income info	Plugin info & active modules
/income stats	Your reward statistics
/income stats	Other player's stats
/income reload	Reload configuration
/income debug	Toggle debug mode
/income langen	Switch to English
/income langru	Switch to Russian
/income help	Command reference

---

⚙️ Configuration Highlights

Config file: mods/com.crystalrealm_EcoTaleIncome/EcoTaleIncome.json

General Settings

Setting	Default	Description
RoundToWholeNumbers	false	Round all income to whole numbers (e.g. 6.57 → 7)
EconomyProvider	"ecotale"	Economy provider key
NotifyOnReward	true	Show chat messages on income
DebugMode	false	Enable verbose debug logging

Anti-Farm & Exploit Protection

Setting	Default	Description
MaxRewardsPerMinute	60	Hard cap on rewards per minute
SameBlockCooldownMs	500	Cooldown between same-position rewards
DenyPlayerPlacedBlocks	true	Deny income for blocks placed by players (exploit protection)
PlacedBlockExpireMinutes	30	How long placed-block positions are remembered
AntiFarm.WindowSeconds	120	Time window for diminishing returns
AntiFarm.ThresholdKills	25	Kills before penalty triggers
AntiFarm.PenaltyMultiplier	0.10	Reward multiplier after threshold

Reward Tables

Mob Tiers:

Tier	Reward	Examples
Critter	0.5 – 1.5	Small animals
Passive	1.0 – 3.0	Cows, sheep
Hostile	3.0 – 8.0	Zombies, skeletons
Elite	8.0 – 15.0	Elite mobs
Miniboss	15.0 – 30.0	Mini-bosses
Boss	30.0 – 75.0	Bosses
World Boss	75.0 – 200.0	World bosses

Per-entity overrides supported (e.g. Fire Dragon: 150–300 coins).

Ores: 12 types from Copper (0.5–1.5) to Diamond (12–25), with +0.5% per block below Y=64 (up to +50%).

Trees: 18+ types from Softwood (0.3–0.8) to Ebony (1.0–2.0).

Crops: 15 types from Wheat (0.3–0.8) to Herb (1.0–2.5). Harvest method configurable: F-key, left-click, or both.

RPG Level Scaling

Level Difference	Multiplier
Mob 15+ levels below	×0.10
Within ±4 levels	×1.00
Mob 15+ levels above	×2.00

Anti-Farm Protection

• Max 60 rewards per minute
• Same-block cooldown (500ms)
• Diminishing returns after 25 kills in 2 minutes
• Penalty multiplier: ×0.10 after threshold

Custom Blocks

Add rewards for modded content:

"CustomBlocks": {
  "my_custom_ore":  { "Min": 2.0, "Max": 5.0, "Category": "ore" },
  "my_custom_tree": { "Min": 0.5, "Max": 1.5, "Category": "wood" }
}

---

🔌 Economy API

EcoTaleIncome provides a public Java API for custom economy integrations:

1. Implement EconomyProvider interface
2. Register with EcoTaleIncomeAPI.registerEconomyProvider("key", provider)
3. Users set "EconomyProvider": "key" in config

Generic Adapter — for server owners who don't want to write code: set "EconomyProvider": "generic" and fill in class name + method names in config. Auto-detects method signatures.

---

🔌 EcoTale Ecosystem

EcoTaleIncome is part of the CrystalRealm EcoTale plugin family:

Plugin	Description
EcoTaleIncome	Earn currency through gameplay ← you are here
EcoTaleBanking	Banking — deposits, loans, credit score
EcoTaleQuests	Daily & weekly quests with rewards

Install all three alongside Ecotale for a complete economic game loop: earn → save & invest → complete goals.

---

Developed by CrystalRealm for the Hytale community