EcoHarmony Plugin Documentation
Table of Contents
- Introduction
- Installation
- Configuration
- Features
- Commands
- Permissions
- API for Developers
- Troubleshooting
- FAQ
Introduction
EcoHarmony is a comprehensive ecosystem management plugin for Minecraft servers. It introduces dynamic environmental mechanics that respond to player actions, creating a more immersive and challenging gameplay experience.
Installation
- Download the EcoHarmony.jar file from the Spigot resource page.
- Place the JAR file in your server's plugins folder.
- Restart your server.
- The plugin will generate a default configuration file on first run.
Configuration
The main configuration file is located at plugins/EcoHarmony/config.yml. Here are the key settings:
Code (Text):
biodiversity:
initial-score: 100
max-score: 1000
min-score: 0
tree-growth-increase: 5
animal-breeding-increase: 3
crop-harvest-increase: 2
natural-increase-chance: 0.01
natural-increase-amount: 1
pollution-decrease-factor: 10
pollution:
smelting-pollution: 5
max-pollution: 1000
purification-crystal-power: 100
poison-threshold: 500
crop-slowdown-threshold: 300
max-crop-slowdown: 0.5
farming:
crop-rotation-bonus: 0.2
monoculture-penalty: 0.1
max-monoculture-penalty: 5
weather:
climate-change-rate: 0.01
acid-rain-threshold: 800
acid-rain-damage: 1
rewards:
harmony-buffs:
- threshold: 500
effect: REGENERATION
duration: 30
amplifier: 0
- threshold: 700
effect: SPEED
duration: 30
amplifier: 0
- threshold: 900
effect: INCREASE_DAMAGE
duration: 30
amplifier: 0
Adjust these values to fine-tune the plugin's behavior on your server.
Features
Biodiversity System
- Tracks the ecological health of each chunk.
- Increases with tree growth, animal breeding, and crop harvesting.
- Decreases with pollution and over-exploitation.
Pollution Management
- Smelting and certain industrial activities generate pollution.
- High pollution levels cause negative effects on crops and mobs.
- Use Purification Crystals to clean polluted areas.
Advanced Farming
- Implements crop rotation bonuses and monoculture penalties.
- Pollution affects crop growth rates.
- Encourages diverse and sustainable farming practices.
Weather and Climate
- Long-term weather patterns affected by server activities.
- Acid rain occurs in highly polluted areas, damaging players and crops.
Mob Migration
- Animals relocate when their population in an area becomes too low.
- Encourages wildlife conservation and sustainable hunting.
Purification Crystals
- Craftable items used to reduce pollution in an area.
- Recipe: Diamond (D), Glowstone Dust (G), Emerald (E)
Player Rewards
- Players receive buffs for maintaining high biodiversity in their area.
- Encourages eco-friendly gameplay.
Commands
- /ecoharmony info: Displays ecological information about your current location.
- /ecoharmony restore: Uses a Purification Crystal to restore the area (must be holding the crystal).
- /ecoadmin setbiodiversity <value>: Sets the biodiversity score for the current chunk (Admin only).
- /ecoadmin setpollution <value>: Sets the pollution level for the current chunk (Admin only).
Permissions
- ecoharmony.info: Allows use of the /ecoharmony info command.
- ecoharmony.restore: Allows use of the /ecoharmony restore command.
- ecoharmony.admin: Allows use of all admin commands.
API for Developers
EcoHarmony provides an API for other plugins to interact with its systems. Here's a basic example:
Code (Text):
EcoHarmony plugin = (EcoHarmony) Bukkit.getPluginManager().getPlugin("EcoHarmony");
BiodiversitySystem biodiversitySystem = plugin.getBiodiversitySystem();
PollutionSystem pollutionSystem = plugin.getPollutionSystem();
// Get biodiversity score of a chunk
int score = biodiversitySystem.getBiodiversityScore(chunk);
// Add pollution to a chunk
pollutionSystem.addPollution(chunk, amount);
Troubleshooting
- If the plugin is not loading, ensure you're using a compatible server version (Spigot/Paper 1.21+).
- For any issues, check the server console for error messages.
- If crops are not growing, check the pollution levels in the area.
- Ensure that the config.yml file is properly formatted after making changes.
FAQ
Q: How often does the plugin save data? A: Data is saved periodically and when the server shuts down.
Q: Can I disable certain features? A: Most features can be effectively disabled by setting their values very low in the config.yml.
Q: How do I reset the ecological data for my world? A: Delete the data.yml file in the plugin's folder and restart the server.
For any additional questions or support, please post in the plugin's discussion thread on Spigot.