Katacr
Enter at least two characters

Getting Started

Docs version: v1.0.3

This page covers installation, first-time menu setup, and basic verification.

Requirements#

Item Requirement
Minecraft Spigot/Paper 1.16.5+; Folia 1.20.1+
Java Java 16+; the server may require a newer Java version
Database SQLite by default; MySQL 8.0+ is optional
Optional plugins PlaceholderAPI, ItemsAdder, Oraxen, and CraftEngine; vault prices need Vault plus an Economy implementation, while playerpoints prices need PlayerPoints

Installation#

  1. Put the downloaded KaFurnace JAR file in the server plugins folder.
  2. Start the server. On first use, allow time for database drivers to download and check the console for the enabled message.
  3. Run /kf as an administrator player.
  4. Click the Chinese or English menu button, or run /kf ui zh_CN or /kf ui en_US.
  5. KaFurnace installs three menu files and opens the main menu.

The first startup creates config.yml, upgrades.yml, and lang; it does not create ui automatically. Selecting a menu language creates:

plugins/KaFurnace/ui/main.yml
plugins/KaFurnace/ui/furnace.yml
plugins/KaFurnace/ui/upgrade.yml

Default prices use both Vault and PlayerPoints. Before testing purchases, install Vault, an economy plugin, and PlayerPoints. If you use only one payment method, change every paid entry as shown in pricing configuration, then run /kf reload.

Verify the installation#

  1. Run /kf to open the main menu.
  2. Open the first furnace; if initial-furnace-count is 0, buy it from the main menu first.
  3. Insert a valid input and fuel.
  4. Check that fuel and cooking progress update automatically.
  5. Close and reopen the menu and confirm that all virtual items remain.
  6. Open the upgrade menu and check that prices and upgrades display correctly.

If the plugin does not enable, check the console for database driver download or connection errors. Sharing furnaces across servers also requires MySQL cross-server sync on every backend; a single server does not need it.

ItemsAdder, Oraxen, and CraftEngine are optional UI integrations; virtual furnaces work without them. Fully restart the server after installing or removing one so the soft-dependency load order is applied. CraftEngine glyphs also require network.intercept-packets.container: true.