Skip to content

Configuration

Crosis47 edited this page May 1, 2026 · 4 revisions

Configuration

SmartPack is configured in plugins/SmartPack/config.yml.

The bundled default config is organized into major sections so server owners can decide how packing is triggered, what recipes exist, what requirements apply, and how messages are shown.

Main Sections

Section Purpose
config-version Internal config format marker
activation.* Command mode vs Smart Packer item mode
requirements.* Crafting-table requirement behavior
chest_pack.* Chest inventory packing controls
display.* Manual packing display controls
auto_pack.* Automatic packing triggers, cooldowns, and feedback
message.* Player-facing messages
validation.* Recipe validation and reversible-recipe checks
inventory_full.* Inventory-full slot estimation
pack.* Material conversion recipes

Minimal Recipe Example

pack:
  IRON_INGOT:
    output: IRON_BLOCK
    ratio_in: 9
    ratio_out: 1

This allows 9 iron ingots to pack into 1 iron block.

Activation

activation:
  mode: COMMAND
  smart_packer_item:
    allow_command_with_item: false
    cooldown:
      enabled: false
      seconds: 10

Supported modes:

Mode Behavior
COMMAND Players use /pack
SMART_PACKER_ITEM Players right-click a crafted Smart Packer item

Run /pack reload after changing activation.mode so recipe registration and item cleanup can refresh.

See Activation Modes for the full mode guide.

When activation.smart_packer_item.cooldown.enabled is true, Smart Packer item use has a per-player cooldown. The item tooltip shows a live cooldown timer, a ready ActionBar message is sent when the timer ends, and auto-pack is disabled while cooldown mode is active.

Crafting Table Requirements

requirements:
  crafting_table_mode: NEARBY_ONLY
  crafting_table_range: 5
  bypass_crafting_table_for_small_recipes: true
  small_recipe_bypass_max_ratio_in: 4

Supported crafting-table modes:

Mode Behavior
DISABLED No crafting table required
INVENTORY_ONLY Player must carry a crafting table
NEARBY_ONLY Player must be within range of a placed crafting table
INVENTORY_OR_NEARBY Either carried or nearby crafting table works

These settings apply only when activation.mode is COMMAND.

Chest Packing

chest_pack:
  enabled: true
  command: true
  smart_packer_item: true

Chest packing lets players pack placed chest inventories instead of only their own inventory.

Setting Behavior
enabled Master switch for all chest packing
command Allows /pack chest in command mode while looking at a chest within interaction range
smart_packer_item Allows Smart Packer item use to pack an open chest inventory

Players also need smartpack.chest.

Auto-Pack

auto_pack:
  enabled: false
  default_enabled: false
  smart_packer_item:
    require_item: true
  cooldown_ticks: 10
  delay_ticks: 2

Auto-pack is disabled by default. Players need both smartpack.use and smartpack.auto, and each player must have their preference enabled through /pack auto in command mode or through the Smart Packer item in item mode unless auto_pack.default_enabled is changed.

auto_pack.enabled controls auto-pack in the active activation mode. In Smart Packer item mode, auto_pack.smart_packer_item.require_item controls whether the player must carry a Smart Packer item before automatic packing can run.

If Smart Packer cooldown mode is enabled, auto-pack is disabled regardless of auto_pack.enabled.

See Auto-Pack for trigger and mode details.

Inventory-Full Estimates

inventory_full:
  include_nearby_pickups: true
  pickup_radius: 2.0

When output cannot safely fit, SmartPack leaves the affected conversion unchanged and reports how many extra slots would be needed.

If include_nearby_pickups is true, the estimate can include item entities that are already close enough to be picked up. Those nearby items are simulated through the same configured recipe chain before final slot needs are counted.

Messages

All player-facing messages live under message.*.

Common placeholders:

Placeholder Meaning
[item1] Input amount and material
[item2] Output amount and material, with leftovers when relevant
[input] Total original input count packed
[output] Total final item count after packing
[items] Combined final material list
[slots] Additional inventory slots needed
[time] Remaining Smart Packer cooldown time
[range] Configured crafting-table range
[mode] Invalid configured crafting-table mode

Minecraft legacy color codes are supported in config messages.

Validation

validation:
  warn_if_not_reversible: true
  disable_non_reversible_recipes: false

SmartPack can warn when a configured recipe does not appear reversible using the server's loaded crafting recipes. If disable_non_reversible_recipes is true, those inputs are skipped at runtime.

This is useful for storage compression servers that want every packed item to be craftable back into its original input.

Clone this wiki locally