Changes

Page history
Update Bags authored by Lxlp's avatar Lxlp
Show whitespace changes
Inline Side-by-side
Bags.md
View page @ d53e31ee
...@@ -11,10 +11,99 @@ SMALL_BAG: ...@@ -11,10 +11,99 @@ SMALL_BAG:
Inventory: Inventory:
Title: Small Bag Title: Small Bag
Size: 9 Size: 9
SaveOnItemUpdate: true
``` ```
### Bag Options ```yaml
NetheriteBackpack:
Template: UncommonBag
Display: "<dark_gray><bold>Netherite Backpack"
Generation: "backpacks/netherite_backpack"
Model: 90000
Lore:
Description: "<white>A Sturdy Backpack with lots of room!"
Inventory:
Size: 18
Title: "<fontimage.backpacknull>&f<fontimage.netheritebackpack>"
PreventBagNesting: true
SaveOnItemUpdate: true
Sounds:
Open: "mythic:backpack.zipper_open"
Close: "mythic:backpack.zipper_close"
Pickup: "entity.villager.death"
Volume: 1
Pitch: 1
AutoPickup:
Enabled: true
OnlyWhenFull: true
CollectWhenHeld: false
AddToBagStacks: true
BlacklistedItems:
- BEDROCK
- COMMAND_BLOCK
Particles:
Enabled: true
Type: "SMOKE_NORMAL"
Count: 5
Notifications:
NearlyFull:
Enabled: true
Threshold: 3
Message: "§8Your Netherite Backpack is nearly full! ({slots} slots left)"
```
## Bag Options
| Option | Description | Default |
|---------|------------------------------------------------------------------------------------|---------|
| Title | The title for the backpack inventory. Defaults to the item's display name, or `BAG` otherwise | `BAG` |
| Size | The amount of slots the backpack has. Must be a multiple of 9 | 54 |
| SaveOnItemUpdate | Whether the content of the inventory should be saved once the item updates | true |
| Personal | *Currently unimplemented* | |
| PreventBagNesting | Whether backpack nesting should be prevented (putting a backpack inside another backpack) |
| Sounds | Options relative to the sounds the backpack makes | |
| AutoPickup | Options relative to the autopickup feature of the backpack | |
| Notifications | Options relative to the notifications the backpack sends | |
### Sounds
| Option | Description | Default |
|---------|------------------------------------------------------------------------------------|---------|
| Open | The open sound | BLOCK_CHEST_OPEN |
| Close | The close sound | BLOCK_CHEST_CLOSE |
| Pickup | The pickup sound | ENTITY_ITEM_PICKUP |
| Volume | The volume of the sounds | 1.0 |
| Pitch | The pitch of the sounds | 1.0 |
### AutoPickup
| Option | Description | Default |
|---------|------------------------------------------------------------------------------------|---------|
| Enabled | Whether auto-pickup is enabled | false |
| Radius | The radius within which items will be picked up | 5.0 |
| OnlyWhenFull | Whether items should only be picked up when the bag is full | true |
| CollectWhenHeld | Whether items should be picked up only when the bag is held | true |
| BlacklistedItems | List of items that should not be picked up | |
| WhitelistedItems | List of items that should be picked up | |
| AddToBagStacks | Whether items should be added to existing stacks in the bag | false |
| CheckInterval | Interval in ticks for checking nearby items | 20 |
| UseTimer | Whether to use a timer for auto-pickup | false |
| Particles | Particle related options for the autopickup feature | |
#### Particles
| Option | Description | Default |
|---------|------------------------------------------------------------------------------------|---------|
| Enabled | Whether particles for auto pickup are enabled | true |
| Type | The particle to display | ITEM_CRACK|
| Count | The amount of particles | |
### Notifications
| Option | Description | Default |
|---------|------------------------------------------------------------------------------------|---------|
| NearlyFull | Options for the notifications to send when the backpack is nearly full | |
- `Title` - inventory title of your custom bag. Defaults to the display name of your Crucible item. #### NearlyFull
- `Size` - the inventory size of your custom bag. Size is limited to 9,18,27,36,45, and 54. | Option | Description | Default |
- `SaveOnItemUpdate` - if the content of the inventory should be saved once the item Updates |---------|------------------------------------------------------------------------------------|---------|
\ No newline at end of file | Enabled | Whether this notification type is enabled | true |
| Threshold | How many slots must be left available to determine if the backpack is really nearly full | 5 |
| Message | The message to send | §6Your bag is almost full! Only {slots} slots remaining. |
\ No newline at end of file