# CustomFurnace

> Last Updated: March 21, 2024

## Plugin Introduction
CustomFurnace is an advanced furnace plugin designed for Minecraft servers, allowing players to upgrade various types of furnaces to improve burning efficiency and enhance gameplay experience. The plugin supports upgrades using both in-game currency and points, providing multiple payment methods to meet different player needs. A unique feature is that currency and points can have different maximum upgrade level limits, offering players more choices.

## Current Development Status
✅ Main features completed - Internal testing phase

## Core Features

### 1. Furnace Upgrade System
- Support for custom unlimited furnace levels
- Each level can be configured with different burning speeds
- Support for customizable upgrade resources and conditions
- **Dual payment methods: Currency and Points, with independently configurable maximum levels for each**

### 2. Multiple Furnace Type Support
- Support for all vanilla furnace types: Regular Furnace, Blast Furnace, Smoker
- Each type can be individually configured with upgrade parameters
- Each payment method can have different maximum level restrictions

### 3. Interactive Upgrade Interface
- Intuitive GUI for displaying and upgrading furnaces
- Dual payment options: Currency (Gold Block button) or Points (Diamond Block button)
- Real-time display of current furnace properties and post-upgrade effects
- Different payment methods show different upgrade paths and costs

### 4. Global Language Customization
- Fully customizable message system
- Support for multilingual configuration of item names, descriptions, and interface prompts
- Color code and variable support

### 5. Display System
- Support for three display methods:
- Placed state: Using ArmorStand to implement floating display above blocks
- Dropped state: Floating display when items are dropped
- Held state: Floating display when items are held
- Unique display name for each level
- Dynamic updating of display content
- Configurable display toggles

## Configuration Examples

### config.yml
### furnaces.yml
### message.yml
## Implemented Features

### 1. Configuration & Language
- Complete configuration file system
- Customizable language messages
- Debug message system
- Independent display name configuration for each level
- Configurable display system (toggleable armorstand holograms and dropped item floating tags)

### 2. Furnace System
- Furnace speed adjustment
- Burning efficiency improvement
- Custom furnace property storage
- Different level caps for money and points
- Furnace display system (floating text)

### 3. GUI System
- Interactive furnace upgrade interface
- Dual payment options (Money/Points)
- Real-time display of upgrade costs and effects
- Intuitive payment method selection buttons
- Automatic GUI update after upgrades

### 4. Command System
- Complete command and permission system
- Tab auto-completion support

### 5. Data Persistence
- Automatic furnace data saving
- Data recovery after server restart
- Configurable save interval
- Floating display entity UUID storage

### 6. Economy System Integration
- Vault economy system support (money payment)
- PlayerPoints system support (points payment)
- Flexible configuration of upgrade costs and level caps for different currency types

### 7. Display System
- Floating display for placed state
- Floating display for dropped items
- Unique display name for each level
- Dynamic updating of display content
- Configurable display toggles

## Commands

- `/furnace help` - Display help information
- `/furnace info` - View information about the furnace in hand
- `/furnace upgrade` - Open the upgrade interface
- `/furnace give <player> <type> <level> [payment_method]` - Give a player a specified furnace
- `/furnace reload` - Reload configuration files

## Permissions

- `customfurnace.use` - Use basic features
- `customfurnace.upgrade` - Permission to upgrade furnaces
- `customfurnace.upgrade.vault` - Permission to upgrade using money
- `customfurnace.upgrade.points` - Permission to upgrade using points
- `customfurnace.admin` - Administrator permissions

## Compatibility & Requirements
- Supported versions: Spigot/Paper 1.21.4+
- Java version: Java 21+
- Required dependencies:
- Vault (for money economy support)
- PlayerPoints (for points system support)

## Recent Updates
- Optimized configuration reload system, fixed stack overflow issues during reload
- Added display system configuration options in config.yml to control armorstand holograms and floating tags
- Optimized configuration manager structure for better clarity and maintainability
- Improved language manager reload mechanism to avoid recursive calls
- Enhanced furnace data persistence, including floating display entity UUID storage
- Fixed issue with furnace hologram displays disappearing after server restart
- Fixed issue with high-level furnaces (levels 4-5, upgraded with points) not dropping items when broken
- Upgraded command system to support `/furnace give <player> <type> <level> [payment_method]` format
- Optimized configuration file loading logic, eliminated startup warning messages
- Beautified console output with colored log messages
- Fixed issue with GUI automatically closing after furnace upgrade
- Added updateUpgradeButtons method to refresh upgrade button status in GUI
- Optimized InventoryListener class to support real-time GUI display updates
- Implemented complete economy system integration, including money and points deduction and balance queries
- Updated Java version requirement to Java 21
- Added local dependency library support