PokeStops (sidemod)

From Pixelmon Generations Wiki
Jump to navigation Jump to search
This article is about the Pokéstop sidemod. For the Pokéstop structure refer to Poké Stop.


The PokeStops sidemod adds claimable PokeStops which will give items to players, similar to the ones found in Pokémon GO. There are currently three tiers of PokeStops, tier 1, tier 2, and tier 3. Each tier has its own configurable drop pool, cooldown, and optionally, permission. PokeStops are indicated to the player by a circular and rotating particle effect that is colored to the tier of PokeStop. Tier 1 is a pink color, tier 2 is a blue color, and tier 3 is a purple color. The player must step into this rotating particle effect and execute the /claimpokestop command to claim the PokeStop. The player will then receive a configurable amount of items from that tier's drop pool. All items in each tier's drop pools have their own individual rarity weight, which will determine the items the player will receive with higher rarity having a higher chance to be given.

Installation

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

Server

  1. Download PokeStops 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

Commands will often refer to a <tier> argument, which can be: tier1, tier2, or tier3.

AddDrop

Command Information
* /adddrop <tier> <item> <rarity>: Adds the specified item to the specified PokeStop tier with the specified rarity.

The <item> argument is in the format of <mod-id>:<item-id> (ex: pixelmon:poke_ball). The <rarity is a whole number that corresponds to that item's weight when compared to other items. The higher the weight, the more likely it will spawn compared to other items of lower weights.

AddPokeStop

Command Information
* /addpokestop <tier>: Adds a PokeStop of the specified type to the location of the player activating the command.

ClaimPokeStop

Command Information
* /claimpokestop: Claims the PokeStop that the player activating the command is currently within range of.

If enabled in the config, the player must have permission to claim that tier of PokeStop and must not be on cooldown. The player will then be placed on a configurable cooldown depending on the tier.

DelDrop

Command Information
* /deldrop <tier> <item>: Removes the specified item from the specified PokeStop tier.

The <item> argument is in the format of <mod-id>:<item-id> (ex: pixelmon:poke_ball).

DelPokeStop

Command Information
* /delpokestop: Removes the PokeStop that is in the radius of the player activating the command.

DropList

Command Information
* /droplist <tier>: Displays the list of items and their rarity that the specified PokeStop tier has.

Permissions

  • /adddrop - pokestops.adddrop.base
  • /addpokestop - pokestops.addpokestop.base
  • /claimpokestop - pokestops.claimpokestop.base
    • pokestops.claimpokestop.tier1 - Allows claiming of a tier 1 PokeStop.
    • pokestops.claimpokestop.tier2 - Allows claiming of a tier 2 PokeStop.
    • pokestops.claimpokestop.tier3 - Allows claiming of a tier 3 PokeStop.
    • pokestops.claimpokestop.unlimited - Bypasses the claim cooldown.
  • /deldrop - pokestops.deldrop.base
  • /delpokestop - pokestops.delpokestop.base
  • /droplist - pokestops.droplist.base

Config Settings

The PokeStop pokestop.cfg configuration file is located in the \config\ folder of the server.

  • Can a player use the same Pokestop more than once? - Enables PokeStops being claimable multiple times by the same player otherwise, they are one-time per player.
  • How long a player has to wait to use a Tier1 PokeStop again in minutes - The amount of time in minutes between claiming of the same tier 1 PokeStop by a player.
  • How long a player has to wait to use a Tier2 PokeStop again in minutes - The amount of time in minutes between claiming of the same tier 2 PokeStop by a player.
  • How long a player has to wait to use a Tier3 PokeStop again in minutes - The amount of time in minutes between claiming of the same tier 3 PokeStop by a player.
  • Maximum amount of items from a pokestop - The max items that a player can receive when claiming a PokeStop.
  • Minimum amount of items from a pokestop - The min items that a player can receive when claiming a PokeStop.
  • Should the player require the pokestops.claimpokestop.tierx permission node to claim a tiered PokeStop? - Enables the player needing specific permission to claim that tier of PokeStop.


The PokeStop PokestopPlayerData.json configuration file is located in the \config\ folder of the server. It contains information for the drops and locations of all PokeStops. This file can be edited manually, though the commands for adding and removing drops are recommended.
The PokeStop PokestopPlayerData.json file is located in the \config\ folder of the server. It contains information on cooldowns for each PokeStop for individual players. Editing this file manually is not recommended.