Skip to content

USER_GUIDE.md

Latest commit

 

History

History
39 lines (27 loc) · 1.44 KB

USER_GUIDE.md

File metadata and controls

39 lines (27 loc) · 1.44 KB

User Guide

Prerequisites

  • A Spigot or Paper Minecraft server (API version 1.13 or later).
  • The FoodSpoilage plugin jar placed in the plugins/ folder and the server restarted.
  • (Optional) rpk-food-lib-bukkit – provides extended food definitions via RPKit integration.

First Steps

  1. Start your server with the plugin installed. FoodSpoilage will generate a default plugins/FoodSpoilage/config.yml.
  2. Review the configuration file and adjust spoil times and other settings to suit your server. See CONFIG.md for a full reference.
  3. Reload the configuration without restarting: /fs reload
  4. Give the food item you want to test to yourself and check its remaining time with /fs timeleft.

Common Scenarios

Checking when a food item will expire

  1. Hold a food item in your main hand.
  2. Run /fs timeleft.
  3. The plugin will display the remaining time before the item spoils.

Reloading the configuration

After editing plugins/FoodSpoilage/config.yml:

/fs reload

Permissions

Permission Description Default
fs.default Allows use of the base /fs command Everyone
fs.help Allows use of /fs help Everyone
fs.timeleft Allows use of /fs timeleft Everyone
fs.reload Allows use of /fs reload OP only