🔎
UltraStorage Wiki
  • 👋Welcome UltraStorage
  • Overview
    • ðŸŠķFeatures
    • ðŸ’ĄSupport
  • Fundamentals
    • 🛠ïļGetting Started
      • Requirements
      • 📝Commands & Permissions
      • 🧑Configs
  • Use Cases
    • ðŸ–ĨïļFor Developers (API)
Powered by GitBook
On this page
  • Placeholders
  • GUI Item Icons
  1. Fundamentals
  2. Getting Started

Configs

Placeholders

In the config.yml file, the following special placeholders can be used

# %owner% -> Owner of the ultrachest
# %time_left% -> Time left for autosell to execute
# %auto_sell_enabled% -> Currently gives "Active" or "No".
# %block_collection_enabled% -> Currently gives "Active" or "No".
# %mob_kill_collection_enabled% -> Currently gives "Active" or "No".
# %mob_other_collection_enabled% -> Currently gives "Active" or "No".
# %furnace_collection_enabled% -> Currently gives "Active" or "No".
# %crop_collection_enabled% -> Currently gives "Active" or "No".
# %slot_count% -> Current amount of used slots in the chest.
# %storage_count% -> Current amount of used storage in the chest.
# %user_count% -> Current amount of users that can access the chest.
# All the placeholders below with the word TIER return a roman numeral for the tier NUMBER.
# All the placeholders below with the word VALUE return a number for the actual VALUE of given upgrade
#
# %current_upgrade_slot_tier%
# %current_upgrade_slot_value%
# %next_upgrade_slot_tier%
# %next_upgrade_slot_value%
# %next_upgrade_slot_price%
# %next_upgrade_slot_permission%
#
# %current_upgrade_storage_tier%
# %current_upgrade_storage_value%
# %next_upgrade_storage_tier%
# %next_upgrade_storage_value%
# %next_upgrade_storage_price%
# %next_upgrade_storage_permission%
#
# %current_upgrade_speed_tier%
# %current_upgrade_speed_value%
# %next_upgrade_speed_tier%
# %next_upgrade_speed_value%
# %next_upgrade_speed_price%
# %next_upgrade_speed_permission%
#
# %current_upgrade_multiplier_tier%
# %current_upgrade_multiplier_value%
# %next_upgrade__multiplier_tier%
# %next_upgrade__multiplier_value%
# %next_upgrade__multiplier_price%
# %next_upgrade__multiplier_permission%

# %current_upgrade_members_tier%
# %current_upgrade_members_value%
# %next_upgrade_members_tier%
# %next_upgrade_members_value%
# %next_upgrade_members_price%
# %next_upgrade_members_permission%

# %current_upgrade_sell_quantity_tier%
# %current_upgrade_sell_quantity_value%
# %next_upgrade_sell_quantity_tier%
# %next_upgrade_sell_quantity_value%
# %next_upgrade_sell_quantity_price%
# %next_upgrade_sell_quantity_permission%
#
#

# %item% -> Item Name
# %item_amount% -> Item quantity
# %item_price% -> Item price per stack, 64 items.
Others:
# %is_member_in_chest% -> Currently returns "Yes" or "No"
# %is_item_in_chest% -> Currently returns "Yes" or "No"

GUI Item Icons

UltraStorage allows for any item in the GUI to be changed, you can either chose any item ingame or you can even chose a player head skin! Just replace the VALUE in the material field of any config section and that's it!.

Config.yml

Use Placeholders to make these values adapt! The following is an example config section. HEX Colors are supported!

ultrastorage-hologram-main-page:
  - '&c%owner% &4&lUltraChest &8(&fMain&8)'
  - ''
  - '&4&lTEIRS'
  - '&c| &fUpgrade &4%current_upgrade_slot_tier% '
  - '&c| &fStorage &4%current_upgrade_storage_tier% '
  - '&c| &fMultiplier &4%current_upgrade_multiplier_tier%'
  - '&c| &fMembers &4%current_upgrade_members_tier%'
  - '&c| &fSell Quantity &4%current_upgrade_sell_quantity_tier%'
  - ''
  - '&c| &fAutosell Timer: &4&l%time_left%s'
  - ''
  - ''
  - '&7&oClick me to switch pages'
  - '&7&oRight-Click to Open UltraChest'
Upgrades.yml

UltraStorage has a very unique upgrade system, with permission nodes to prevent a specified user to further upgrade on top of the desired value!

Example:

In the following example, I created 4 upgrade tier for Slot Upgrades, meaning, more unique items will be able to be added to the UltraStorage Filter!

The "value" corresponds to what the new upgrade amount will be, In this case, tier 1, the default tier, will be a total of 1. Only 1 unique item will be able to be added to the list!

The "price" corresponds to how much needs to be paid to upgrade to the corresponding tier.

The "permission-code" is the requirement that the user will need to have that permission to be able to upgrade to that tier. If you give a user 'upgrades.slot.tier.3' the user will ONLY be able to upgrade up to tier 3.

"*" permission will allow all upgrades without checking!

NOTE: You do not need to give inidividual permissions from 1-10 for a user to be able to purchase tier 10. Just give the highest tier you want them to reach!.

gui-upgrades-slot-tier-config:
  1:
    value: 1
    price: 100
    permission-node: 'upgrades.slot.tier.1'
  2:
    value: 2
    price: 200
    permission-node: 'upgrades.slot.tier.2'
  3:
    value: 3
    price: 300
    permission-node: 'upgrades.slot.tier.3'
  4:
    value: 4
    price: 400
    permission-node: 'upgrades.slot.tier.4'
Messages.yml

PreviousCommands & PermissionsNextFor Developers (API)

Last updated 2 years ago

🛠ïļ
🧑
Custom heads
Make sure you select the value from OTHER -> VALUE section.
Logo