AnotherGymPlugin

From Pixelmon Generations Wiki
Jump to navigation Jump to search

The AnotherGymPlugin sidemod provides servers an alternative to traditional Gym systems.

The majority of AGP commands are security-based and will only work if a player has met all security requirements, which include being a Leader and a Head Leader.
It is not possible for a player to obtain the same badge twice, as security checks are in place. These checks can be found on the queue system, /giveBadge, and when a player challenges an NPC Leader.

A Gym is capable of having 3 different statuses, including:

Status Description
Open

A Player Leader is online, or a Head Leader intentionally opened the Gym.
Can be enabled by using /openGym command, or if automatic Gym opening is enabled in the config and a Leader logs on.

Closed

A Player Leader is not online at this time, or the Gym was intentionally closed.
Can be enabled by using /closeGym command, or having all of the Gym's Leaders log off.

Open
(NPC mode)

No Player Leaders are online and accepting challenges, but the Gym has NPCs in its Leader list.
Can be enabled by starting the server and have it automatically assigned if an NPC Leader is present, closing the Gym using /closeGym command while an NPC is present in the Leader list, or automatically when the last Player Leader logs off.


NPC Leader

An NPC Leader is a special type of NPC Trainer that will award a Gym's Badge if defeated.
NPC Leaders will follow the Gym's rules as set by /editGym command, such as level caps and Gym requirements. An NPC Leader can be placed by using the command /spawnNPCLeader <Gym name>, and can be edited or removed like a regular NPC Trainer by using an Grid Npc Editor.pngNPC editor.

NPC Leaders can be added to a server's /gymList by using the command /addLeader NPC <Gym name>, and can be removed by using /delLeader NPC <Gym name>. AGP also includes Badge refusal messages when the player already has a Gym's Badge, although the message is only shown if the NPC Leader is set to accept unlimited challenges (via an NPC editor).
If a level cap or Gym requirements are established on the NPC Leader's Gym, the NPC Leader will only initiate a battle if the restrictions are satisfied.

Note: NPC Leaders do not give out any items or PokéDollars specified by the Gym's setup.

Queue system

AGP's queue system consists of several commands which tie into one functionality.
Each Gym that is created automatically has a queue which players can join using /challengeGym <Gym name>. A player may only join a queue if the Gym's status is set to Open.

In order for a Gym Leader to accept a challenge, you must place Pokémon inside of the Gyms Pixelmon pool (refer to the section below for more informations).
Once a player joins a Gym's queue, the player will be notified of their place in line, and the Leader will be notified that a player has entered the queue. A Leader may use /queueList <Gym name> command to view a Gym's queue.
Once a Leader is ready to accept a challenge, the Leader can use the /acceptChallenge <Gym> command to start a battle with the next player in the queue. If arenas are set up by using /setGymWarp, the Leader and the challenger will be teleported to the first available arena. Otherwise, they will start a battle where they stand.
A Leader may deny a challenge by using /denyChallenge, and a player may cancel a challenge by using /cancelChallenge. Once a Gym closes, the queue is cleared.

If the challenger wins a queue battle, the challenger is awarded the Gym's Badge and the kit (items and PokéDollars) associated with the Badge, if any.

Temp Gym Teams

AGP supports having leaders using temporary teams from a Gym pool set up by the Gym Manager or Administrator.
You can add a Pokémon to the Gym's pool by using /addGymPoke <slot> <name> and you can view the Pokémon pool by using /gymPokemon <name>.

If the player has the agp.headleader or agp.gympokemon.admin permission node, it will permit the player to access a secondary menu of the GUI that will permit you to delete a Pokémon from the pool, copy a Pokémon from the pool into your party, or return to the previous screen.
Whenever a Gym leader uses /acceptChallenge command, a team selection GUI will appear prompting the Gym leader to select a team from the Gym's pool.

Installation

AnotherGymPlugin can only be installed on a server and does not need to be installed on the client. SpongeForge is required.

Server

  1. Download AnotherGymPlugin from the sidemods section of the downloads page.
  2. Drop/move the downloaded jar file into the mods folder on the server's files.
  3. Ensure that SpongeForge is in the mods folder as well.
  4. Start the server and wait for all mods to load.

Commands

Gym Management

AddGym

Command Information
* /addGym <name> <badge>: Adds a Gym to the configuration file.

Arguments:

name: The name choosen for the Gym. Two Gyms cannot share the same name.
badge: The ID of the item you want to use as Gym badge. (ex: pixelmon:rain_badge for the Grid Rain Badge.pngRain Badge)


Aliases: /

EditGym

Command Information
* /:

DelGym

Command Information
* /:

OpenGym

Command Information
* /:

CloseGym

Command Information
* /:

GymList

Command Information
* /:

SetGymWarp

Command Information
* /:

GymCommand

- Add
Command Information
* /:
- Del
Command Information
* /:
- List
Command Information
* /:

AddGymPoke

Command Information
* /:

GymPokemon

Command Information
* /:

GymRules

Command Information
* /:

Badges

CheckBadges

Command Information
* /:

DelBadge

Command Information
* /:

GiveBadge

Command Information
* /:

Leaders

AddLeader

Command Information
* /:

DelLeader

Command Information
* /:

GiveBadge

Main article: GiveBadge

SpawnNPCLeader

Command Information
* /:

GymWarp

Command Information
* /:

Challenges

ChallengeGym

Command Information
* /:

CancelChallenge

Command Information
* /:

AcceptChallenge

Command Information
* /:

DenyChallenge

Command Information
* /:

QueueList

Command Information
* /:

Administration

AgpReload

Command Information
* /:

Stc

Command Information
* /:

Permissions

There are no permissions for AnotherGymPlugin.

Config Settings

There are no config settings for AnotherGymPlugin.