MFurnaces - By MythosCore v1.5.5

# MFurnaces — Plugin Documentation

---

## Overview

MFurnaces replaces vanilla furnaces with a tiered, economy-driven system. Players buy custom furnace items, place them in the world, and unlock faster smelting, better fuel efficiency, and XP bonuses as they upgrade. Furnaces can be marked private so only the owner can access them. Owners receive configurable notifications when smelting finishes or fuel runs out. Holograms (via DecentHolograms) float above each furnace showing live info.

---

## Installation

1. Drop MFurnaces-1.5.4.jar into your /plugins folder.
2. (Optional) Install Vault + an economy plugin (e.g. EssentialsX) for the shop system.
4. Restart the server.
5. Edit plugins/MFurnaces/config.yml and lang.yml to your liking.
6. Run /mfurnaces reload to apply changes without a full restart.


---

## Dependencies

| Vault | Click Here |
| DecentHolograms | Click Here |

---

## Commands

### Player Command — /furnaces

Aliases: /mf
Permission: mfurnaces.use
Description: Opens the MFurnaces main menu or runs a subcommand.

| Syntax | Description |
|---|---|
| /furnaces | Opens the Main Menu GUI |
| /furnaces help | Prints the player help list in chat |
| /furnaces shop | Opens the Furnace Shop GUI directly |
| /furnaces list | Lists all your placed custom furnaces in chat |

---

### Admin Command — /mfurnaces

Aliases: /mfa, /mfadmin
Permission: mfurnaces.admin
Description: Administrative control over the plugin.

| Syntax | Description |
|---|---|
| /mfurnaces reload | Reloads config.yml and lang.yml without restart |
| /mfurnaces give <player> <tier> [amount] | Gives a furnace item to a player. Amount defaults to 1, max 64 |
| /mfurnaces remove | Removes the custom furnace you are currently looking at |
| /mfurnaces info | Shows full info about the custom furnace you are looking at |
| /mfurnaces reset <player> | Removes all placed furnaces owned by the given player |

Valid tier names for /mfurnaces give:
BASIC · IRON · GOLD · DIAMOND · EMERALD · NETHERITE · CELESTIAL

---

## Permissions

| Node | Default | Description |
|---|---|---|
| mfurnaces.use | everyone | Access to /furnaces and basic interactions |
| mfurnaces.place | everyone | Place custom furnace items in the world |
| mfurnaces.shop | everyone | Open the Furnace Shop GUI and buy furnaces |
| mfurnaces.private | everyone | Toggle privacy on own furnaces |
| mfurnaces.notifications | everyone | Receive smelting / fuel-empty notifications |
| mfurnaces.tier.basic | everyone | Buy / place Basic tier furnaces |
| mfurnaces.tier.iron | everyone | Buy / place Iron tier furnaces |
| mfurnaces.tier.gold | everyone | Buy / place Gold tier furnaces |
| mfurnaces.tier.diamond | everyone | Buy / place Diamond tier furnaces |
| mfurnaces.tier.emerald | everyone | Buy / place Emerald tier furnaces |
| mfurnaces.tier.netherite | op | Buy / place Netherite tier furnaces |
| mfurnaces.tier.celestial | op | Buy / place Celestial tier furnaces |
| mfurnaces.admin | op | Full access to /mfurnaces + all child permissions |

mfurnaces.admin is a parent permission — it automatically grants all nodes above it.

Click to expand...

---

## Furnace Tiers

There are 7 tiers ordered from weakest to strongest.

| Tier | Display Name | Speed | Fuel Efficiency | XP Multiplier | Max Owned | Shop Price |
|---|---|---|---|---|---|---|
| BASIC | Basic Furnace | ×1.0 | ×1.0 | ×1.0 | 5 | $100 |
| IRON | Iron Furnace | ×1.5 | ×1.25 | ×1.1 | 4 | $500 |
| GOLD | Gold Furnace | ×2.0 | ×1.5 | ×1.25 | 3 | $1,500 |
| DIAMOND | Diamond Furnace | ×3.0 | ×2.0 | ×1.5 | 2 | $5,000 |
| EMERALD | Emerald Furnace | ×4.0 | ×2.5 | ×1.75 | 2 | $12,000 |
| NETHERITE | Netherite Furnace | ×6.0 | ×3.0 | ×2.0 | 1 | $30,000 |
| CELESTIAL | Celestial Furnace | ×10.0 | ×5.0 | ×3.0 | 1 | $100,000 |

• Speed multiplier — how many times faster than a vanilla furnace.
• Fuel efficiency — how much longer a given fuel source burns.
• XP multiplier — bonus XP received per smelt operation.
• Max owned — maximum number of furnaces of this tier one player can have placed at once (-1 = unlimited).
• CELESTIAL is the maximum tier and cannot be upgraded further (upgradeable: false).

All tiers use the vanilla FURNACE block as their placed block material (configurable per tier).

---

## Upgrade Paths & Costs

Upgrades are purchased through the Furnace Menu GUI (right-click a placed furnace you own). The cost is deducted from the player's Vault balance.

| From | To | Upgrade Cost |
|---|---|---|
| BASIC | IRON | $400 |
| IRON | GOLD | $1,000 |
| GOLD | DIAMOND | $3,500 |
| DIAMOND | EMERALD | $7,000 |
| EMERALD | NETHERITE | $18,000 |
| NETHERITE | CELESTIAL | $70,000 |

All costs are configurable in config.yml under the upgrades: section.

Click to expand...

---

### Furnace Menu GUI — right-click on own furnace
Opened automatically when a furnace owner right-clicks their placed MFurnace. Contains:

| Button | Action |
|---|---|
| Furnace Info | Shows tier, speed, fuel, XP stats |
| Toggle Private | Enables / disables privacy on the furnace |
| Toggle Notifications | Enables / disables smelt-complete / fuel-empty alerts |
| Upgrade Furnace | Initiates upgrade to the next tier (shows cost). Disabled if at max tier |

## Data Storage

Furnace data is persisted in plugins/MFurnaces/furnaces.yml. It stores:

• Furnace UUID
• Owner UUID and player name
• Placed location (world, x, y, z)
• Current tier
• Privacy status
• Notification preference

Data is saved:

• Automatically on the auto-save-interval tick timer.
• On server shutdown / plugin disable.
• Immediately after a furnace is placed, broken, or upgraded.

---