Skip to content

Configuration

Jump to bottom
Hunter edited this page Oct 14, 2025 · 1 revision

Configuration Guide

Configuration File Location

Refiller stores its configuration in:

config/refiller.json

The configuration file is automatically created with default values when you first run the mod.

Default Configuration

{
  "enabled": true,
  "range": 6,
  "rangeY": 3,
  "ignoreHotbar": true,
  "allowEmptyDeposit": false,
  "playSound": true,
  "showToast": true,
  "sortMode": "NAME",
  "requireModifierToScroll": false,
  "enableDoubleClickSort": true,
  "sortHighlightedItem": true,
  "fallbackOpenContainerOnly": true
}

QuickStack Settings

Core Settings

Setting Type Default Description
enabled boolean true Master toggle for all Refiller functionality
range integer 6 Horizontal search radius (X/Z axis) in blocks
rangeY integer 3 Vertical search radius (Y axis) in blocks

Behavior Settings

Setting Type Default Description
ignoreHotbar boolean true Don't move items from hotbar slots (0-8)
allowEmptyDeposit boolean false Allow depositing into empty containers

Feedback Settings

Setting Type Default Description
playSound boolean true Play chest close sound on successful transfer
showToast boolean true Show action bar message with transfer count

Sorting Settings

Sort Mode Settings

Setting Type Default Options Description
sortMode string "NAME" "NAME", "CATEGORY" Current sort mode
requireModifierToScroll boolean false true, false Require CTRL to change sort modes (future feature)

Sorting Behavior

Setting Type Default Description
enableDoubleClickSort boolean true Allow double-clicking empty slots to sort
sortHighlightedItem boolean true Only sort inventory under cursor when true

Advanced Settings

Setting Type Default Description
fallbackOpenContainerOnly boolean true On servers without mod, limit to open container only

Configuration Methods

Method 1: In-Game Configuration (Recommended)

Requirements:

  • Mod Menu mod installed
  • Cloth Config mod installed

Steps:

  1. Open Minecraft
  2. Go to Mods menu
  3. Find Refiller in the list
  4. Click the config button
  5. Adjust settings in the GUI
  6. Settings are saved automatically

Method 2: Manual File Editing

Steps:

  1. Close Minecraft completely
  2. Navigate to your .minecraft/config/ folder
  3. Open refiller.json in a text editor
  4. Modify the values as needed
  5. Save the file
  6. Launch Minecraft

Important: Always backup your configuration before editing manually.

Detailed Setting Explanations

Range Settings

Horizontal Range (range)

  • Controls how far horizontally (X/Z axis) Refiller searches for containers
  • Range: 1-20 blocks
  • Default: 6 blocks
  • Higher values find more containers but may impact performance

Vertical Range (rangeY)

  • Controls how far vertically (Y axis) Refiller searches for containers
  • Range: 1-10 blocks
  • Default: 3 blocks
  • Useful for multi-level storage areas

Behavior Settings

Ignore Hotbar (ignoreHotbar)

  • When true: Items in hotbar slots (0-8) are never moved
  • When false: All inventory items can be moved
  • Recommended: Keep as true to protect your tools

Allow Empty Deposit (allowEmptyDeposit)

  • When true: Items can be deposited into completely empty containers
  • When false: Items only go into containers already containing that item type
  • Recommended: Keep as false to maintain organization

Feedback Settings

Play Sound (playSound)

  • When true: Plays chest close sound when items are transferred
  • When false: No audio feedback
  • Recommended: Keep as true for better user experience

Show Toast (showToast)

  • When true: Shows action bar message with transfer count
  • When false: No visual feedback
  • Recommended: Keep as true for better user experience

Sort Mode Settings

Sort Mode (sortMode)

  • "NAME": Sorts items alphabetically by display name
  • "CATEGORY": Groups similar items together by category
  • Recommendation: Use "NAME" for general use, "CATEGORY" for organized storage

Require Modifier To Scroll (requireModifierToScroll)

  • When true: Requires holding CTRL to change sort modes with scroll wheel
  • When false: Scroll wheel changes modes without modifier
  • Note: This feature is reserved for future implementation

Sorting Behavior Settings

Enable Double Click Sort (enableDoubleClickSort)

  • When true: Double-clicking empty slots triggers sorting
  • When false: Double-click sorting is disabled
  • Recommended: Keep as true for convenient sorting

Sort Highlighted Item (sortHighlightedItem)

  • When true: Only sorts the inventory under the cursor
  • When false: Sorts both player and container inventories
  • Recommended: Keep as true for more precise control

Configuration Examples

Example 1: Basic Setup

{
  "enabled": true,
  "range": 6,
  "rangeY": 3,
  "ignoreHotbar": true,
  "allowEmptyDeposit": false,
  "playSound": true,
  "showToast": true,
  "sortMode": "NAME",
  "enableDoubleClickSort": true,
  "sortHighlightedItem": true
}

Example 2: Large Storage Area

{
  "enabled": true,
  "range": 12,
  "rangeY": 6,
  "ignoreHotbar": true,
  "allowEmptyDeposit": false,
  "playSound": true,
  "showToast": true,
  "sortMode": "CATEGORY",
  "enableDoubleClickSort": true,
  "sortHighlightedItem": false
}

Example 3: Compact Storage

{
  "enabled": true,
  "range": 4,
  "rangeY": 2,
  "ignoreHotbar": true,
  "allowEmptyDeposit": true,
  "playSound": false,
  "showToast": true,
  "sortMode": "NAME",
  "enableDoubleClickSort": true,
  "sortHighlightedItem": true
}

Example 4: Server-Friendly

{
  "enabled": true,
  "range": 4,
  "rangeY": 2,
  "ignoreHotbar": true,
  "allowEmptyDeposit": false,
  "playSound": false,
  "showToast": false,
  "sortMode": "NAME",
  "enableDoubleClickSort": false,
  "sortHighlightedItem": true
}

Performance Considerations

Client Performance

Range Settings Impact:

  • Larger ranges search more blocks, potentially impacting FPS
  • Recommended maximum: 8-10 blocks horizontal, 4-5 blocks vertical
  • Use smaller ranges on lower-end systems

Sorting Performance:

  • Large inventories take longer to sort
  • Category mode is slightly more resource-intensive than name mode
  • Consider disabling double-click sort on very large inventories

Server Performance

Server-Side Installation:

  • Recommended for servers with many players
  • Reduces client-side processing load
  • Better compatibility with other mods

Range Optimization:

  • Limit range on busy servers
  • Consider time-of-day restrictions for large operations
  • Monitor server performance with different settings

Troubleshooting Configuration

Common Issues

Configuration Not Saving:

  • Ensure Minecraft is completely closed before editing
  • Check file permissions
  • Verify JSON syntax is correct
  • Try deleting the config file and letting it regenerate

Settings Not Taking Effect:

  • Restart Minecraft after configuration changes
  • Check for conflicting mods
  • Verify the configuration file is in the correct location

Performance Issues:

  • Reduce range settings
  • Disable sound/toast feedback
  • Use smaller inventory sections for sorting
  • Check for mod conflicts

Configuration Validation

Valid Range Values:

  • range: 1-20 (recommended: 4-8)
  • rangeY: 1-10 (recommended: 2-4)

Valid Sort Modes:

  • "NAME" (case-sensitive)
  • "CATEGORY" (case-sensitive)

Boolean Values:

  • Use true or false (lowercase)
  • Do not use quotes around boolean values

Related Documentation

Clone this wiki locally