ItemCompressor

About

ItemCompressor is a Paper plugin for Minecraft 1.21.X that allows players to equip a Compressor item — held in hand or worn as a helmet — which will automatically craft selected items in their inventory.

It supports both vanilla crafting recipes and custom items from ExecutableItems, making it a versatile addition to any economy or survival-based server. Upgrades, slot management, and compression toggling are all handled through an intuitive in-game GUI.

Features

⚙️ Auto-Compression

• Equipped compressors automatically craft materials on a configurable interval
• Compression can be toggled per compressor individually
• Set the tick interval via check-interval in the config

📦 Slot System

• Each compressor holds between 1 and 20 item slots
• Drag-and-drop items into the GUI to assign them; right-click to clear a slot
• Each slot only targets its assigned item type

⬆️ Upgrades

• Unlock additional slots through an upgrade system with up to 20 tiers
• Each tier has its own fully customizable material and price — items, Vault money, or both
• All upgrade costs are defined in the config and can be adjusted freely

🔌 Custom Item Support

• Custom items from ExecutableItems work as compression results
• Three detection methods are attempted: EI API → known ID sets → material map fallback
• The /ei give console command is used as a fallback when the EI API is unavailable

🚫 Item Whitelist

• An optional whitelist can be enabled in the config to restrict which items are allowed in a compressor's slots
• Useful for controlled server environments or economy balancing

💰 Vault Integration

• Optionally require in-game currency for upgrades
• Vault is a soft dependency — the plugin works fully without it

🎨 GUI

• Compressor GUI: View all slots, toggle auto-compression on/off, and open the upgrade menu
• Upgrade GUI: Displays the current tier, costs for the next tier (items + money), and a buy button

How It Works

1. Obtain a Compressor — give it to a player via command (/itemcompressor give [player]), or configure it as a craftable or shop item
2. Equip it — hold it in hand or wear it as a helmet; the compressor activates immediately
3. Configure slots — open the GUI and drag items into the available slots to define what gets compressed
4. Upgrade — spend items (and optionally money) to unlock more slots; up to 20 upgrade tiers available
5. Let it run — the plugin checks the player's inventory at the configured interval and auto-crafts whenever enough materials are present

Compatibility

| Dependency | Type | Notes |
|---|---|---|
| PaperMC 1.21.1 | Required | Must run on Paper or a Paper fork |
| Vault | Optional | Required only for money-based upgrade costs |

Configuration Highlights

• check-interval — tick interval between compression checks
• whitelist.enabled — restrict which items can be added to compressor slots
• upgrades — fully customizable tiers with individual item and money costs

Permissions

• itemcompressor.use — open and use the Item Compressor
• itemcompressor.give — execute /itemcompressor give
• itemcompressor.reload — execute /itemcompressor reload
• itemcompressor.* — grants all permissions

Support & Feedback

• 📝 Leave a Review on Modrinth
• 🔄 Share with others
• 💖 Donate to support the developer

For questions, suggestions & bug reports: Join my discord to create a ticket!