AlphaToolsDocs v2.0.0
AlphaToolsReferenceConfiguration

Configuration

How config.yml defines tools, and what else it controls.

On this page

File layout

plugins/AlphaTools/
  config.yml # tools, messages, effects, blacklists, panel
  data # SQLite database for tools and player settings

Defining a tool

Every top-level section that is not a reserved key is a tool. The section name is the key used by /atools give.

titan-drill:
  type: drill
  show-glow: true
  name: "&e&lTitan Drill"
  material: NETHERITE_PICKAXE
  displayname: "&e&lTitan Drill"
  default-duration: 10000
  enchantments:
    - "EFFICIENCY:5"
    - "UNBREAKING:3"
  lore:
    - " &8- &7Time Left: &e%uses%"
    - " &8- &7Last Used By: &f%lastusedby%"
KeyMeaning
typeThe real behavior: drill, shovel, tree-chopper, nether-hoe, lava-bucket, water-bucket, water-drain-bucket, lava-drain-bucket, fluid-drain-bucket, rocket or jump-feather.
materialThe item. Pick one that fits the type, for example a bucket for a bucket tool.
name / displaynameThe item name and the name used in messages.
enchantmentsA list of ENCHANT:level.
loreLines under the name. %uses% is the time left and %lastusedby% the last user.
show-glowAdds the enchant glint.
Rename a section to anything you like and keep type. A section called my-legendary-miner with type: drill is a drill you give with /atools give <player> my-legendary-miner 1h.

Reserved sections

These top-level keys are not tools: messages, sound, particle1, particle2, blacklist and blacklisted-areas. The panel block holds the approval settings.

Messages

Under messages: reload, give-success, receive, tool-broke, the toggle messages, no-permission, player-not-found, inventory-full, and the help and list text. %player% and %item% are replaced where they make sense. Colors use & codes.

combat-blocked and tool-recharged exist in the config but nothing in this version sends them.

Sound and particles

The sound, particle1 and particle2 sections choose the sound and the two particle effects, each with a type, plus volume and pitch for the sound or a count for the particles. An invalid type is skipped silently, so check the names against the Bukkit enums if nothing plays.