Skip to content

Configuration

Yap Zhen Yie edited this page Jun 15, 2018 · 21 revisions

GadgetsMenu Configuration

Here you can find the default config of GadgetsMenu.


GadgetsMenu Sample Config

# This option allows you to set where
# player's data do you want to save.
# 
# Storages: 'file' or 'mysql'.
# 
# If you enable mysql, you need to setup MySQL infos.
Player-Data:
  Storage: file
  MySQL:
    hostname: localhost
    username: root
    database: minecraft
    port: '3306'
    password: password

Cosmetic-Item-Purchase:
  # Set to true allows player to purchase cosmetic items.
  Enabled: true
  # Set the storage where do you want to save mystery dust.
  # Available storages: 'file', 'mysql', 'coins-jasperjh', 'coinsapi', 'playerpoints', 'vault'.
  Mystery-Dust-Storage: file
  # Set to true will allows player to purchase specified cosmetic.
  Enabled-Cosmetics:
    Hats: true
    Particles: true
    Suits: true
    Gadgets: true
    Pets: true
    Morphs: true
    Banners: true
    Emotes: true
    Cloaks: true
  # Reopen GUI menu after player purchase item.
  Reopen-GUI-Menu-After-Purchase: true
  # This is the command when player purchase cosmetic items.
  # This command is depends on your permission plugin.
  Execute-Command: pex user {PLAYER} add {PERMISSION}

# General settings.
Settings:
  # The default pet's name.
  Default-Pet-Name: '&b{PLAYER}''s pet'
  # The mystery dust amount of the player who join the server first time.
  Starting-Mystery-Dust: 0
  # The maximum characters that player can set the pet name.
  Max-Pet-Name-Characters: 20
  # The slot when player equip gadget, emote or morph.
  Gadget-Slot: 5
  # The default self morph view setting.
  Default-Self-Morph-View: true
  # Do you want to enable self morph view?
  Enabled-Self-Morph-View: true
  # Auto equip cosmetic after player purchased.
  Auto-Equip-After-Purchase: true
  # Auto equip cosmetic when player found loot from mystery box.
  Auto-Equip-On-Loot-Found: true
  # Set to true will shows particle effect to everyone,
  # otherwise will only show to the player itself.
  Show-Particle-Effect-To-Everyone: true
  # Set to true will shows cloak effect to everyone,
  # otherwise will only show to the player itself.
  Show-Cloak-Effect-To-Everyone: true
  # Do action when player equip cosmetic.
  # Replace: Replace the old item with equipped cosmetic.
  # Warn: Send a warning message to the player and reject to equip cosmetic.
  # Drop: Drop the old item on the ground and equip cosmetic.
  Equip-Cosmetic-Item-To-Slot: WARN

# The menu selector settings.
Menu-Item:
  # The name of the selector.
  Name: '&aGadgetsMenu'
  # The material of the selector.
  Material: '399:0' 
  # Slot: 0-8
  Slot: 4
  # Should give player menu selector when they join the server.
  Give-On-Join: true
  # Set to true allows player to move menu selector to another slot.
  Able-To-Move: false
  Lore:
  - '&7Mystery Dust: &b{MYSTERY_DUST}'
  - ''
  - '&7Enjoy fun cosmetic features!'
  - '&7More stuff will be added over time,'
  - '&7make sure to check our update forums!'
  - '&7Thanks you for supporting our server.'

# List of the worlds where cosmetics are enabled!
Enabled-Worlds:
- world
- world_nether
- world_the_end

# List of the disabled cosmetics.
# Set to true to disable it.
Disabled-Cosmetics:
  Hats: false
  Particles: false
  Suits: false
  Gadgets: false
  Pets: false
  Morphs: false
  Banners: false
  Emotes: false
  Cloaks: false

Permission:
  # When player doesn't have the permission of that item.
  No-Permission:
    # Set to true will show the lore.
    Show-In-Lore: false
    # Should close GUI menu when player selected 
    # a item which he doesn't have the permission.
    Close-GUI-Menu-After-Select: true
    Lore:
    - ''
    - '&7Status: &c&lLOCKED'
    # Set to true, will play sound 
    # when player select the item.
    #
    # Sounds: https://github.com/OnlyNoobDied/GadgetsMenu/wiki/Sounds
    Play-Sound:
      Enabled: true
      Sound: ENTITY_ENDERMEN_TELEPORT
    Show-Custom-Item:
      Enabled: true
      Material: '351:8'
 # When player have the permission of that item.
  Has-Permission:
    # Set to true will show the lore.
    Show-In-Lore: false
    Close-GUI-Menu-After-Select: true
    Lore:
    - ''
    - '&7Status: &a&lUNLOCKED'
    # Set to true, will play sound 
    # when player select the item.
    #
    # Sounds: https://github.com/OnlyNoobDied/GadgetsMenu/wiki/Sounds
    Play-Sound:
      Enabled: true
      Sound: ENTITY_EXPERIENCE_ORB_PICKUP

# When player clicks 'Go Back' button will execute these commands.
# If you enabled this option, it won't open the main menu of GadgetsMenu.
# Variables: {PLAYER}
Back-To-Main-Menu:
  Execute-Commands:
    Enabled: false
    Commands:
    - cc open menu.yml {PLAYER}

# Set to true will fill the blank slots of inventories with the item you set.
Fill-Empty-Slot-With-Item:
  Enabled: false
  Material: '160:15'

# List of commands that won't work when equip a cosmetic.
# Type commands in lowercase without slashes.
Disabled-Commands:
- hat

# Check for updates if you set to true.
Check-Update: true

# Set to true will automatic download 
# the latest plugin when it's released.
Auto-Update: true

# Do not edit this.
Config-Version: 1.0.6

How to edit cosmetic settings? (Categories folder)

In this sample I used the 'Hamburger Hat'.

# Don't change this!
Hamburger:
    
  # The name of the item.
  Name: '&aHamburger Hat'

  # How much mystery dust does it cost to craft it
  Mystery Dust: 12
  
  # The rarity of the item.
  # Rarity: Common, Rare, Epic, Legendary
  Rarity: Common

  # Is it enabled?
  Enabled: true
    
  # Can this item be found in mystery box?
  CanBeFound: true

  # Can player purchase this item?
  Purchasable: true

  # The lore of the item.
  Lore:
  - 'This is a hat with'
  - 'A Hamburger texture'

How can I use colored item names?

# Instead of just 'Hamburger Hat', put it between '' and enter your colorcode
Name: '&aHamburger Hat'

Sounds

You can find a list with all the sound names here

Play-Sound:
  Enabled: true
  Sound: ENTITY_ENDERMEN_TELEPORT

Go to the top of the page