PixelAnnouncer

From Pixelmon Generations Wiki
Jump to navigation Jump to search

The PixelAnnouncer sidemod adds automatic announcements to everyone on a server for doing certain Pixelmon related events (e.g. catching a Legendary Pokémon or defeating a Boss Pokémon).

Currently, PixelAnnouncer can track the following events:

  • activateShrineEvent - Triggered when a player activates any shrine.
  • breedEvent - Triggered when an egg has been made in a Rancher.
  • catchLegendEvent - Triggered when a player catches any Legendary Pokémon.
  • catchParticleEvent - Triggered when a player catches any Pokémon with a EntityParticle equiped.
  • catchPokeEvent - Triggered when a player catches any Pokémon that are not a Legendary Pokémon or Ultra Beast.
  • catchShinyEvent - Triggered when a player catches any shiny Pokémon that are not a Legendary Pokémon or Ultra Beast.
  • catchUBEvent - Triggered when a player catches any Ultra Beast.
  • defeatBossEvent - Triggered when a player defeats any Boss Pokémon.
  • defeatLegendEvent - Triggered when a player defeats any Legendary Pokémon.
  • defeatParticleEvent - Triggered when a player defeats any Pokémon with a EntityParticle equiped.
  • defeatPlayersEvent - Triggered when a player defeats another player in a battle.
  • defeatShinyEvent - Triggered when a player defeats any shiny Pokémon that are not a Legendary Pokémon or Ultra Beast.
  • defeatTotemEvent - Triggered when a player defeats any Totem Pokémon.
  • defeatTrainersEvent - Triggered when a player defeats a NPC Trainer in a battle.
  • defeatUBEvent - Triggered when a player defeats any Ultra Beast.
  • defeatWildEvent - Triggered when a player defeats any Pokémon that is not a shiny, Legendary Pokémon, or Ultra Beast.
  • evolveEvent - Triggered when a player evolves their Pokémon.
  • levelUpEvent - Triggered when a player levels up their Pokémon.
  • maxLevelEvent - Triggered when a player levels up their Pokémon to the max level.
  • playerTradeEvent - Triggered when a player trades with another player.


Installation

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

Server

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

There are no commands for PixelAnnouncer.

Permissions

There are no permissions for PixelAnnouncer.

Config Settings

The PixelAnnouncer pixelannouncerplus.conf configuration file is located in the \config\pixelannouncerplus\ folder of the server.

  • AnnouncementPrefix - The prefix that is placed in front of all announcement messages.

Everything else in the config file are events that can be announced if enabled. All of the events have the following options that can be edited:

  • AnnounceEvent - Enables that event to announce a message to all online players.
  • Announcement - This is the message that is displayed when the event is triggered. Color codes may be used as well as placeholders depending on the event (e.g. %player% -> player's name).
  • EventCommands - A list of commands that will be activated when the event is triggered.
  • TrackEvent - Enables the tracking of the event. If this is disabled, no commands or announcements will run, even if those are enabled.

Some events contain settings that pertain to that specific event and should be self-explanatory.