Skip to content

Usage Guide

MaxTheCodingPenguin edited this page Jan 2, 2026 · 1 revision

Usage Guide

The management command is /bundle.

  • Base command: /bundle
  • Aliases: /cmdbundle, /cb
  • Usage: /bundle <add|remove|list|info|edit|subcommand|permission|reload|help>

/bundle add <name> <action...>

Create a new bundle with the given name.

  • Purpose: Create a new bundle and define its base actions.
  • Permission: commandbundle.add
  • Syntax:
    • /bundle add <name> <action1> [| <action2> | <action3> ...]
    • Actions are separated by | and each action is a full action line (the same as in commands.yml).
  • Example:
    • /bundle add starter !give %player% stone_sword 1 | #message:green:Enjoy your starter kit!

This creates a starter bundle and immediately registers /starter as a command.

/bundle remove <name>

Delete an existing bundle and unregister its command.

  • Purpose: Permanently remove a bundle.
  • Permission: commandbundle.remove
  • Example:
    • /bundle remove starter

/bundle list

List available bundles.

  • Purpose: View existing bundle names and how many actions they contain.
  • Permission: commandbundle.list
  • Example:
    • /bundle list

/bundle info <name>

Show the raw action lines for a bundle.

  • Purpose: Inspect how a bundle is defined.
  • Permission: commandbundle.info
  • Example:
    • /bundle info starter

/bundle edit <name> <add|insert|remove|replace> ...

Edit the action list of an existing bundle.

  • Permission: commandbundle.edit
  • Operations:
    • add <action> – append a new action at the end.
    • insert <index> <action> – insert at zero-based index.
    • remove <index> – remove the action at index.
    • replace <index> <action> – replace the action at index.

Example:

  • /bundle edit starter add #message:yellow:You used the starter bundle again!
  • /bundle edit starter replace 0 !give %player% stone_pickaxe 1

/bundle subcommand <name> <sub> <action...>

Define or overwrite a subcommand for a bundle.

  • Purpose: Add separate action lists for /name <sub>.
  • Permission: commandbundle.subcommand
  • Syntax:
    • /bundle subcommand <name> <sub> <action1> [| <action2> ...]
  • Example:
    • /bundle subcommand starter confirm #message:green:Starter confirmed!

After this, /starter confirm will run the subcommand actions instead of the base starter actions.

/bundle permission <name> [permission.node]

Get or set the permission node required to use a bundle.

  • Purpose: Restrict or open access to a bundle.
  • Permission: commandbundle.permission
  • Behavior:
    • Without permission.node, shows the current permission (if any).
    • With permission.node, sets or clears the permission stored in commands.yml.
  • Example:
    • /bundle permission starter server.bundle.starter

When a permission is set, players must have that node to use /starter.

/bundle reload

Reload bundle definitions from commands.yml.

  • Purpose: Apply changes to bundles made in commands.yml without restarting the server.
  • Permission: commandbundle.reload (typically OP only).
  • Example:
    • /bundle reload

Note: /bundle reload reloads commands.yml (bundles), not config.yml. To apply changes in config.yml, restart the server or reload the plugin with your server's plugin manager.

/bundle help [topic]

Show in-game help for bundle features.

  • Permission: usually same as commandbundle.add/commandbundle.edit.
  • Topics (if provided):
    • placeholders – argument and player/server placeholders.
    • conditions[if:], [else if:], [else].
    • delays[delay:].
    • variables+name:value and %var:name%.
    • random[random] / [random:<weight>].
    • subcommands – subcommand basics.
    • editedit usage.