Commands - NickImpact/Bidoof-Unleashed GitHub Wiki

Overview

Arguments Key

  • Required arguments are marked with angle brackets - e.g. <required>
  • Optional arguments are marked with square brackets - e.g. [optional]
  • If you want to include spaces in arguments, such as specifying a name, you must enclose the argument in quotes - e.g. "? ??"

All commands in Bidoof Unleashed will be conducted via the primary alias: /bu3. However, one command overrides this. This command is /badges, which is setup as it's own command to ease player access.

Index

/badges

Permission: bu3.command.badges.base

Allows a player to view their collection of obtained badges!

/bu3

Permission: bu3.command.bu3.base

Base Bidoof Unleashed command. Specifying this command with no arguments will simply list out all potential sub commands based on permission level.

/bu3 help

Permission: bu3.command.help.base

Specifying this command with no arguments will simply list out all potential sub commands based on permission level.

/bu3 gyms

Permission: bu3.command.gyms.base

Opens up a sorted menu by category which details all gyms in the system. Allows people to directly warp to the gym in the event all conditions are met for it.

/bu3 challenge

Permission: bu3.command.challenge.base

Arguments:

  • <gym / e4> - The Gym or E4 you wish to challenge
  • ``[stage] - A number between 1-4. This option is only necessary when challenging the E4.

Allows a player to challenge a Gym or Elite Four member. Your challenge is placed into the Gym/E4's queue, which can then be accepted by the leader. Make sure you have your team ready for your challenge! Don't worry, your pokemon will be healed before the battle starts.

/bu3 accept

Permission: bu3.command.accept.base

Arguments:

  • <gym / e4> - The Gym or E4 you wish to accept a challenge for.

If you are a leader of the specified Gym or Elite Four, you may accept a challenge from the queue belonging to such.

/bu3 open

Permission: bu3.command.open.base

Arguments:

  • <gym / e4> - The Gym or E4 you wish to open.

If you are a leader of the specified Gym or Elite Four, you may open it!

/bu3 close

Permission: bu3.command.close.base

Arguments:

  • <gym / e4> - The Gym or E4 you wish to close.

If you are a leader of the specified Gym or Elite Four, you may close it!

/bu3 admin addgym

Aliases: addgym, ag, creategym, cg

Permission: bu3.command.admin.addgym.base

Arguments:

  • <name> - The name of the Gym
  • [spec] - Additional settings for the Gym to quicken the creation process.
    • Available Settings:
      • badge-type - Item ID
      • badge-name - Name for the badge
      • lvl-cap-init - The level cap for players who have not yet defeated the gym
      • lvl-cap-rematch - The level cap for players who have defeated the gym
      • cooldown - How long players must wait (in minutes) to challenge the gym after a previous attempt.
      • weight - Specifies the ordering of the gym. Lower values come before larger ones!
      • category - The category to create the gym under. If no category currently exists for the specification, one will be created

Specifies the creation of a new gym. Gyms created via this command will still need a few edits before being ready for the public!

/bu3 admin editgym

Aliases: editgym, eg

Permission: bu3.command.admin.editgym.base

Arguments:

  • <gym> - The Gym we want to edit
  • <spec> - Additional settings for the Gym to quicken the creation process.
    • Available Settings:
      • name - The name of the gym
      • badge-type - Item ID
      • badge-name - Name for the badge
      • lvl-cap-init - The level cap for players who have not yet defeated the gym
      • lvl-cap-rematch - The level cap for players who have defeated the gym
      • cooldown - How long players must wait (in minutes) to challenge the gym after a previous attempt.
      • weight - Specifies the ordering of the gym. Lower values come before larger ones!
      • category - The category to create the gym under. If no category currently exists for the specification, one will be created

Allows quick command usage to simply edit a gym rather than go through the config to edit it.

/bu3 admin deletegym

Aliases: deletegym, dg

Permission: bu3.command.admin.deletegym.base

Arguments:

  • <gym> - The gym you wish to delete.

Deletes a gym from the stored data. If you have teams.save-on-delete set to true in your config, the pool of pokemon belonging to the gym will not be altered.

/bu3 admin createe4

Aliases: createe4, ce4

Permission: bu3.command.admin.createe4.base

Arguments:

  • <category> - The category for the Elite Four
  • [spec] - Additional settings for the Gym to quicken the creation process.
    • Available Settings:
      • badge-type - Item ID
      • badge-name - Name for the badge
      • cooldown - How long players must wait (in minutes) to challenge the gym after a previous attempt.

Specifies the creation of a new Elite Four. Note that you will likely want to configure each stage separately after this creation.

/bu3 admin addleader

Aliases: addleader, addgymleader, agl, al

Permission: bu3.commands.admin.addgymleader.base

Arguments:

  • <gym> - The Gym to add the leader to
  • <leader> - The name of the leader, or "npc" to add an NPC leader at your position
  • [world] - The world to spawn a NPC leader in (Namely for console use)
  • [position] - The position to spawn a NPC leader at (Namely for console use)

Adds a new leader to the specified Gym.

/bu3 admin adde4member

Aliases: ae4m, adde4member

Permission: bu3.commands.admin.ae4m.base

Arguments:

  • <e4> - The Gym to add the leader to
  • <stage> - The stage of the Elite Four
  • <leader> - The name of the leader, or "npc" to add an NPC leader at your position

Adds a new leader to the specified Elite Four.

/bu3 admin givebadge

Aliases: givebadge, gb

Permission: bu3.commands.admin.givebadge.base

Arguments:

  • <player> - The player to give a badge to
  • <gym> - The gym referencing which badge to award

Manually gives a player a badge.

/bu3 admin removebadge

Permission: bu3.commands.admin.removebadge.base

Arguments:

  • <player> - The player to give a badge to
  • <gym> - The gym referencing the badge

Takes a badge away from the player, assuming they have it.

/bu3 admin addpoke

Aliases: addpoke, aps, addpokemonspec

Permission: bu3.commands.admin.aps.base

Arguments:

  • <gym> - The Gym we are targetting
  • <battle type> - initial or rematch
  • <spec> - The pokemon spec, typically exactly how you'd format pokegive or pokespawn

Adds a pokemon spec to the gym's pool of pokemon, translated into Showdown format

/bu3 admin addrequirement

Permission: bu3.commands.admin.addrequirement.base

Arguments:

  • <gym> - The Gym we are targetting
  • <battle type> - initial or rematch
  • <requirement> - The requirement to add to the gym
  • [extras] - Any additonal arguments required to add the requirement.

Adds a requirement to the gym's list of requirements

/bu3 admin setuparena

Aliases: setuparena, sa, sarena

Permission: bu3.commands.admin.setuparena.base

Arguments:

  • <gym> - The Gym we are targetting
  • <area> - challenger, leader, or spectator

Sets the location of an arena location based on the command caster's current position.

⚠️ **GitHub.com Fallback** ⚠️