Getting Started

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; vault prices need Vault plus an Economy implementation, while playerpoints prices need PlayerPoints

Installation#

1. Put KaFurnace-1.0.0.jar in the server plugins folder.
2. Start the server and wait for the JDBC dependency download to finish.
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

The bundled upgrades.yml contains both Vault and PlayerPoints prices. Before testing paid purchases, install Vault, an Economy implementation, and PlayerPoints, or change every priced entry to a provider already available on the server and run /kf reload.

Verify the installation#

1. Run /kf to open the main menu.
2. Open the first furnace.
3. Insert a valid input and fuel.
4. Confirm that fuel and cooking information refresh about every 5 ticks.
5. Close and reopen the menu and confirm that all virtual items remain.
6. Open the upgrade menu and confirm that prices, provider availability, and all five upgrade categories are displayed correctly.

If the plugin does not enable, check the console for JDBC download or database connection errors.