Join our discord
In partnership with NodeCraft Logo NodeCraft


You are not logged in! Create an account or login to contribute! Log in here!

Difference between revisions of "Pixelmon Broadcasts"

From Pixelmon Wiki
(→‎Permissions: Removed extant Toggle permission mention, clarified the block permission for setups without specific group/player requirements.)
m
 
(18 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
<pre style="color: red">Warning: This sidemod is a work in progress, and may cause issues. Proceed with caution, and report any bugs.</pre>
+
Pixelmon Broadcasts is a [[sidemod]] for [[Pixelmon]] which extents the legendary spawned message into a multiple of different Pixelmon events with customizable messages (broadcasts). These events are also logged into the main log file if enabled.
−
 
 
−
[[File:Pbr_broadcasts.png|300px|thumb]]
 
−
[[File:Pbr_toggles.png|300px|thumb]]
 
−
Pixelmon Broadcasts is a [[sidemod]] for [[Pixelmon]] that adds a ton of configurable messages for Pixelmon events, and also logs them to console if set up to do so.
 
  
 +
__NOTOC__
 
== Installation ==
 
== Installation ==
 
{{SidemodVersionh}}
 
{{SidemodVersionh}}
 +
{{SidemodVersion|1.12.2|8.3.6+|1.2.3}}
 +
{{SidemodVersion|1.12.2|8.3.5+|1.2.0}}
 +
{{SidemodVersion|1.12.2|8.3.1+|1.1.1}}
 +
{{SidemodVersion|1.12.2|8.3.0+|1.0.2}}
 +
{{SidemodVersion|1.12.2|8.2.0+|0.6.1}}
 +
{{SidemodVersion|1.12.2|8.0.0+|0.6}}
 
{{SidemodVersion|1.12.2|7.0.5+|0.4.1}}
 
{{SidemodVersion|1.12.2|7.0.5+|0.4.1}}
 
{{SidemodVersion|1.12.2|6.3.4|0.2.2}}
 
{{SidemodVersion|1.12.2|6.3.4|0.2.2}}
 
{{SidemodVersionf}}
 
{{SidemodVersionf}}
  
−
__NOTOC__
+
===Servers===
−
Pixelmon Broadcasts is meant to be run on a server. It may work on the client, but this is currently untested. SpongeForge is required.
+
# Download Pixemon Broadcasts for your version of Minecraft/Pixelmon [https://pixelmonmod.com/downloads.php here].
 +
# Place the downloaded <code>.jar</code> in the server's ''mods'' folder.
 +
# Start the server and wait for it to load.
 +
# Open the configuration folder in the server's ''config/pixelmonbroadcasts'' and edit the files as desired.
 +
# Either restart the server or use <code>/pixelmonbroadcasts reload</code> (see commands for more detail) command to load any changes made.
  
−
#Download Pixelmon Broadcasts for your version of ''Minecraft'' and ''Pixelmon''.
+
===Clients===
−
#Place the downloaded .jar file in the ''mods'' folder, along with ''SpongeForge''.
+
# Download PixelBroadcasts for your version of Minecraft/Pixelmon here.
−
#Start the server and wait for it to load.
+
# Place the downloaded <code>.jar</code> in your game's ''mods'' folder.
−
#Open the configuration files in the server's ''config/PixelmonBroadcasts'' folder, and edit to taste.
+
# Start the game and wait for it to load.
−
#Use the <code>/pixelmonbroadcasts reload</code> command to load any changes into Pixelmon Broadcasts.
+
# Open the configuration folder in the game's ''config/pixelmonbroadcasts'' and edit the files as desired. The default setup should be fine though.
−
#Add the permissions for the broadcasts and commands you want people to have access to to [https://luckperms.github.io/ LuckPerms].
+
# Either restart the game or use <code>/pixelmonbroadcasts reload</code> (see commands for more detail) command to load any changes made.
  
−
 
+
==Commands==
−
If [https://forums.spongepowered.org/t/pixelmonoverlay-gives-plugin-access-to-the-pixelmon-overlay-and-provides-some-useful-features-like-broadcasts-and-such/27606 Pixelmon Overlay] is installed, integration will automatically be enabled. This allows Broadcasts to work together with other mods and plugins also using Pixelmon's noticeboard. Please note that this disables Toggle functionality for noticeboard broadcasts due to plugin limitations.
 
−
 
 
−
== Commands ==
 
 
{{CommandSyntax}}
 
{{CommandSyntax}}
 +
* <code>/pixelmonbroadcasts</code>: The base command used for all subcommands. Displays the sidemod's version if ran by itself.
 +
** <code>reload</code>: The subcommand to reload all configurations (config, lang and broadcasts folder).
  
−
* <code>/pixelmonbroadcasts</code> or <code>/pbroadcasts</code>: Shows subcommands that the player has access to. Clickable.
+
===Permissions===
−
** <code>toggle</code>: Prints a list with clickable toggles for all available broadcasts, based on permissions.
+
* <code>/pixelmonbroadcasts</code>: <code>None</code>
−
** <code>reload</code>: Reloads all config settings, messages and broadcasts.
+
* <code>/pixelmonbroadcasts reload</code>: <code>pixelmonbroadcasts.admin</code> or <code>pixelmonbroadcasts.admin.reload</code>
−
 
 
−
== Permissions ==
 
−
=== Command nodes ===
 
−
These nodes will give players access to specific subcommands.
 
−
* <code>pixelmonbroadcasts.command.staff.reload</code> - allows the use of /pixelmonbroadcasts reload, should be staff-only
 
−
 
 
−
=== Action nodes ===
 
−
These nodes will give players access to specific on-click actions.
 
−
* <code>pixelmonbroadcasts.action.staff.teleport</code> - allows teleportation to an event's source
 
−
 
 
−
=== Notifier nodes ===
 
−
These nodes will allow players to see the matching broadcasts, and will allow them to toggle them on and off for themselves.
 
−
 
 
−
Note that the below permissions are for per-role or per-player broadcast access. If this isn't necessary, simply give everybody <code>pixelmonbroadcasts.notify</code>. You can then control available broadcasts through the settings.
 
  
−
==== Blackout nodes ====
+
==Configuration==
−
Shown when a player's party is wiped out by an opponent of the given type. Works well with [[SafePlace|the SafePlace sidemod]].
+
''Note: All configurations are <code>.json</code> files - we recommend you [https://jsonlint.com/ validate] them when making significant changes.''
−
* <code>pixelmonbroadcasts.notify.blackout.normal</code>
 
−
* <code>pixelmonbroadcasts.notify.blackout.shiny</code>
 
−
* <code>pixelmonbroadcasts.notify.blackout.legendary</code>
 
−
* <code>pixelmonbroadcasts.notify.blackout.shinylegendary</code>
 
−
* <code>pixelmonbroadcasts.notify.blackout.ultrabeast</code>
 
−
* <code>pixelmonbroadcasts.notify.blackout.shinyultrabeast</code>
 
−
* <code>pixelmonbroadcasts.notify.blackout.boss</code>
 
−
* <code>pixelmonbroadcasts.notify.blackout.trainer</code>
 
−
* <code>pixelmonbroadcasts.notify.blackout.bosstrainer</code>
 
  
−
==== Catch nodes ====
+
===Config File===
−
Shown when a Pokémon of the given type is caught.
+
The <code>config.json</code> is intended to allow for as much customization as possible! The contents of this file are either used throughout the plugin.
−
* <code>pixelmonbroadcasts.notify.catch.normal</code>
 
−
* <code>pixelmonbroadcasts.notify.catch.shiny</code>
 
−
* <code>pixelmonbroadcasts.notify.catch.legendary</code>
 
−
* <code>pixelmonbroadcasts.notify.catch.shinylegendary</code>
 
−
* <code>pixelmonbroadcasts.notify.catch.ultrabeast</code>
 
−
* <code>pixelmonbroadcasts.notify.catch.shinyultrabeast</code>
 
  
−
==== Challenge nodes ====
+
* <code>commandName</code>: Used to specify the base. All <code>commandAliases</code> will use this.
−
Shown when a player starts fighting an opponent of the given type.
+
** Default: <code>pixelmonbroadcasts</code>.
−
* <code>pixelmonbroadcasts.notify.challenge.shiny</code>
+
* <code>commandAliases</code>: Used to specify aliases for the <code>commandName</code>.
−
* <code>pixelmonbroadcasts.notify.challenge.legendary</code>
+
** Default: <code>pixelbroadcasts</code>, <code>pbroadcasts</code>.
−
* <code>pixelmonbroadcasts.notify.challenge.shinylegendary</code>
+
* <code>broadcastsDimPlayerOnly</code>: Used to specify if all online players or if only players in the same dimension as the event will see the broadcast.
−
* <code>pixelmonbroadcasts.notify.challenge.ultrabeast</code>
+
** Default: <code>false</code>.
−
* <code>pixelmonbroadcasts.notify.challenge.shinyultrabeast</code>
+
* <code>logToConsole</code>: Used to specify if additional details regarding the broadcast are logged. These details include player's username, player's UUID, Pokémon, coordinates, dimension ID and dimension name.
−
* <code>pixelmonbroadcasts.notify.challenge.boss</code>
+
** Default: <code>true</code>.
−
* <code>pixelmonbroadcasts.notify.challenge.trainer</code>
+
* <code>dimensionNames</code>: Used to specify the name of the dimension based on the dimension's ID.
−
* <code>pixelmonbroadcasts.notify.challenge.bosstrainer</code>
+
** Default: <code>"0": "Overworld"</code>.
−
* <code>pixelmonbroadcasts.notify.challenge.pvp</code>
+
* <code>customTextureMessage</code>: Used to specify the display for custom textures in the broadcast. The custom texture's name is first specified then the display, supports formatting codes.  
 +
** Default: <code>"shadow": "&8Shadow"</code>.
 +
* <code>customTextureHover</code>: Used to specify the display for custom textures in the hover. The custom texture's name is first specified then the the HEX code.  
 +
** Default: <code>"shadow": "#555555"</code>.
 +
* <code>showHoverStats</code>: Used to specify if hovering over the broadcast will display the stats of the Pokémon. The stats displayed can be changed below.
 +
** Default: <code>true</code>.
 +
* <code>statsDisplay</code>: Used to specify the stats of the Pokémon displayed when hovering over the the broadcast.
 +
** Default: all placeholders are used.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Stat Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Untradeable || <code><untradeable></code> || If the Pokémon is untradeable, an indicator is displayed but nothing is displayed if it isn't. The display can be changed in the <code>lang.json</code>.
 +
|-
 +
| Shiny || <code><shiny></code> || If the Pokémon is shiny, an indicator is displayed but nothing is displayed if it isn't. The display can be changed in the <code>lang.json</code>
 +
|-
 +
| Custom Texture || <code><customtexture></code> || If the Pokémon has a custom texture, an indicator is displayed but nothing is displayed if it isn't. The display can be changed in the <code>lang.json</code>
 +
|-
 +
| Species/Pokémon || <code><species></code> || Displays the name and form of the Pokémon.
 +
|-
 +
| Pokerus || <code><pokerus></code> || If the Pokémon has pokerus or has been cured, an indicator is displayed but nothing is displayed if it isn't. The displays can be changed in the <code>lang.json</code>
 +
|-
 +
| Level || <code><level></code> || Displays the level value of the Pokémon.
 +
|-
 +
| Form || <code><form></code> || Displays the form of the Pokémon.
 +
|-
 +
| Ability || <code><ability></code> || Displays the ability of the Pokémon.
 +
|-
 +
| Gender || <code><gender></code> || Displays a gender indicator of the Pokémon. The displays can be changed in the <code>lang.json</code>
 +
|-
 +
| Nature || <code><nature></code> || Displays the nature of the Pokémon along with the benefits of the nature. These displays can be changed in the <code>lang.json</code>  
 +
|-
 +
| Growth || <code><growth></code> || Displays the growth of the Pokémon.  
 +
|-
 +
| Breed Status || <code><breedstatus></code> || If the Pokemon is breedable, an indicator is display but if it's unbreedable/undiscovered, a different indicator is displayed. The displays can be changed in the <code>lang.json</code>
 +
|-
 +
| Held Item || <code><item></code> || If the Pokemon is holding a held item, the held item will be displayed but if if not, will display none.
 +
|-
 +
| HP IVs || <code><ivhp></code> || Displays the HP IVs value of the Pokémon.
 +
|-
 +
| Attack IVs || <code><ivatk></code> || Displays the Attack IVs value of the Pokémon.
 +
|-
 +
| Defense IVs || <code><ivdef></code> || Displays the Defense IVs value of the Pokémon.
 +
|-
 +
| Special Attack IVs || <code><ivspatk></code> || Displays the Special Attack IVs value of the Pokémon.
 +
|-
 +
| Special Defense IVs || <code><ivspdef></code> || Displays the Special Defense IVs value of the Pokémon.
 +
|-
 +
| Speed IVs || <code><ivspd></code> || Displays the Speed IVs value of the Pokémon.
 +
|-
 +
| IV Percentage || <code><ivpercent></code> || Displays total IV percentage of the Pokémon.
 +
|-
 +
| Dynamax Level || <code><dynamaxlevel></code> || Displays the Dynamax level value of the Pokémon.
 +
|-
 +
| Move 1 || <code><move1></code> || Displays the name of the Pokemon's first move.
 +
|-
 +
| Move 2 || <code><move2></code> || Displays the name of the Pokemon's second move.
 +
|-
 +
| Move 3 || <code><move3></code> || Displays the name of the Pokemon's third move.
 +
|-
 +
| Move 4 || <code><move4></code> || Displays the name of the Pokemon's fourth move.
 +
|}
 +
</spoiler>
  
−
==== Forfeit nodes ====
+
===Lang File===
−
Shown when a player forfeits a battle with an opponent of the given type.
+
The <code>lang.json</code> is intended to allow for as much customization as possible! The contents of this file are either used by commands, the broadcasts or the hover functionality.
−
* <code>pixelmonbroadcasts.notify.forfeit.shiny</code>
 
−
* <code>pixelmonbroadcasts.notify.forfeit.legendary</code>
 
−
* <code>pixelmonbroadcasts.notify.forfeit.shinylegendary</code>
 
−
* <code>pixelmonbroadcasts.notify.forfeit.ultrabeast</code>
 
−
* <code>pixelmonbroadcasts.notify.forfeit.shinyultrabeast</code>
 
−
* <code>pixelmonbroadcasts.notify.forfeit.boss</code>
 
−
* <code>pixelmonbroadcasts.notify.forfeit.trainer</code>
 
−
* <code>pixelmonbroadcasts.notify.forfeit.bosstrainer</code>
 
  
−
==== Spawn nodes ====
+
* <code>prefixNeutral</code>: Used specify the broadcast's neutral prefix.
−
Shown when an entity of the given type spawns in the world.
+
** Default <code>&0[&d&lPixelmon&0] &8&l>&7 </code>.
−
* <code>pixelmonbroadcasts.notify.spawn.shiny</code>
+
* <code>prefixPositive</code>: Used specify the broadcast's positive (successes) prefix.
−
* <code>pixelmonbroadcasts.notify.spawn.legendary</code>
+
** Default <code>&0[&d&lPixelmon&0] &8&l>&a </code>.
−
* <code>pixelmonbroadcasts.notify.spawn.shinylegendary</code>
+
* <code>prefixNegative</code>: Used specify the broadcast's negative (error) prefix.
−
* <code>pixelmonbroadcasts.notify.spawn.ultrabeast</code>
+
** Default <code>&0[&d&lPixelmon&0] &8&l>&c </code>.
−
* <code>pixelmonbroadcasts.notify.spawn.shinyultrabeast</code>
+
* <code>reload</code>: Used to specify the reload message.
−
* <code>pixelmonbroadcasts.notify.spawn.wormhole</code>
+
** Default <code>Reloaded configuration!</code>.
−
* <code>pixelmonbroadcasts.notify.spawn.boss</code>
+
* <code>noPerms</code>: Used to specify the no permission message.
 +
** Default <code>You don't have permission!</code>.
 +
* <code>invalidArgs</code>: Used to specify the invalid arguments message.
 +
** Default <code>Invalid args!</code>.
 +
* <code>shinyMessage</code>: Used to specify the indicator displayed in the broadcast if the Pokémon is shiny.
 +
** Default <code>&6Shiny </code>.
 +
* <code>untradeableHover</code>: Used to specify the indicator displayed on the stats hover if the Pokemon is untradeable.
 +
** Default <code>&8[&4Untradeable&8]</code>.
 +
* <code>shinyHover</code>: Used to specify the indicator displayed on the stats hover if the Pokemon is shiny.
 +
** Default <code>&e&l★</code>.
 +
* <code>hasPokerusHover</code>: Used to specify the indicator displayed on the stats hover if the Pokemon has Pokerus.
 +
** Default <code>&8[&dPKRS&8]</code>.
 +
* <code>noPokerusHover</code>: Used to specify the indicator displayed on the stats hover if the Pokemon has had Pokerus and been cured.
 +
** Default <code>&8[&7&mPKRS&8]</code>.
 +
* <code>maleGenderHover</code>: Used to specify the indicator displayed on the stats hover if the Pokemon has is female.
 +
** Default <code>&bMale &l♂</code>.
 +
* <code>femaleGenderHover</code>: Used to specify the indicator displayed on the stats hover if the Pokemon has is a male.
 +
** Default <code>&dFemale &l♀</code>.
 +
* <code>genderlessGenderHover</code>: Used to specify the indicator displayed on the stats hover if the Pokemon is genderless.
 +
** Default <code>Genderless</code>.
 +
* <code>natureBenefitsHover</code>: Used to specify the indicator displayed on the stats hover, showing the stat benefits of the Pokémon's nature.  
 +
** Default <code>&8[&a+%1 &8| &c-%2&8]</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Stat Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Increased Stat || <code>%1</code> || Displayed the increase stat as a result of the nature.
 +
|-
 +
| Decreased Stat || <code>%2</code> || Displayed the decreased stat as a result of the nature.
 +
|}
 +
</spoiler>
 +
* <code>natureNeutralHover</code>: Used to specify the indicator displayed on the stats hover if the Pokemon's nature does not impact the stats/is neutral.
 +
** Default <code>&8[&7Neutral&8]</code>.
 +
* <code>unbreedableHover</code>: Used to specify the indicator displayed on the stats hover if the Pokémon is unbreedable ([[Pokémon Spec]]).
 +
** Default <code>&cUnbreedable</code>.
 +
* <code>unbreedableEggHover</code>: Used to specify the indicator displayed on the stats hover if the Pokémon is unbreedable ([[Undiscovered]] [[Egg Groups]]).
 +
** Default <code>&4Unbreedable</code>.
 +
* <code>breedableHover</code>: Used to specify the indicator displayed on the stats hover if the Pokémon is breedable.
 +
** Default <code>&aBreedable</code>.
 +
* <code>noItemHover</code>: Used to specify the indicator displayed on the stats hover if the Pokémon has no held item.
 +
** Default <code>&eNone</code>.
 +
* <code>noAttackHover</code>: Used to specify the indicator displayed on the stats hover if a move slot is blank/empty.
 +
** Default <code>&8&l&m---</code>.
 +
* <code>a</code>: Used to specify the indefinite artificial for consonants in the broadcasts (currently unused).  
 +
** Default <code>a</code>.
 +
* <code>an</code>: Used to specify the indefinite artificial for vowels in the broadcasts (currently unused).  
 +
** Default <code>an</code>.
  
−
==== Victory nodes ====
+
===Broadcasts Folder===
−
Shown when a player defeats an opponent of the given type.
+
The <code>broadcasts</code> folder is used to store the multiple <code>.json</code> files used to specify which broadcasts are enabled/disabled in each dimension. Each file required the same structure/contents but the messages can be customized to your heart's desire!
−
* <code>pixelmonbroadcasts.notify.victory.shiny</code>
 
−
* <code>pixelmonbroadcasts.notify.victory.legendary</code>
 
−
* <code>pixelmonbroadcasts.notify.victory.shinylegendary</code>
 
−
* <code>pixelmonbroadcasts.notify.victory.ultrabeast</code>
 
−
* <code>pixelmonbroadcasts.notify.victory.shinyultrabeast</code>
 
−
* <code>pixelmonbroadcasts.notify.victory.boss</code>
 
−
* <code>pixelmonbroadcasts.notify.victory.trainer</code>
 
−
* <code>pixelmonbroadcasts.notify.victory.bosstrainer</code>
 
−
* <code>pixelmonbroadcasts.notify.victory.pvp</code>
 
  
−
==== Hatch nodes ====
+
* <code>id</code>: Used to specify the unique ID/name of the broadcasts file. We recommend that the id is the dimension's name/purpose where possible.  
−
Shown when an egg of the given type hatches.
+
* <code>weight</code>: Used to specify the priority of the broadcasts.
−
* <code>pixelmonbroadcasts.notify.hatch.normal</code>
+
* <code>dimension</code>: Used to specify dimensions the specified broadcasts will be available. To disable specific broadcasts in a specific dimension, remove that dimension's ID from all other broadcast files and create a new separate one with the broadcasts you want disabled as empty.
−
* <code>pixelmonbroadcasts.notify.hatch.shiny</code>
 
−
* <code>pixelmonbroadcasts.notify.hatch.legendary</code>
 
−
* <code>pixelmonbroadcasts.notify.hatch.shinylegendary</code>
 
−
* <code>pixelmonbroadcasts.notify.hatch.ultrabeast</code>
 
−
* <code>pixelmonbroadcasts.notify.hatch.shinyultrabeast</code>
 
  
−
==== Draw nodes ====
+
====Spawn Events====
−
Shown when a battle of the given type ends in a draw.
+
* <code>spawnedWormhole</code>: Used to specify the broadcast for when an Ultra Wormhole has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
−
* <code>pixelmonbroadcasts.notify.draw.pvp</code>
+
** Default: <code>&5An Ultra Wormhole &5has opened in a &f%1 biome &5somewhere in the &f%2&5!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Biome Name || <code>%1</code> || Displays the biome the Wormhole spawned in.
 +
|-
 +
| Dimension Name || <code>%2</code> || Displays the name of the dimension (specified in the <code>config.json</code>) the Wormhole spawned in.
 +
|}
 +
</spoiler>
 +
* <code>spawnedDrownedBoss</code>: Used to specify the broadcast for when a Drowned Boss has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
 +
** Default: <code>&3A Drowned, &f%1&3, Boss has spawned in a &f%2 biome &3somewhere in the &f%3&3!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Pokémon || <code>%1</code> || Displays the Form and Species of the Boss.
 +
|-
 +
| Biome Name || <code>%2</code> || Displays the name of the biome the Boss spawned in.
 +
|-
 +
| Dimension Name || <code>%3</code> || Displays the name of the dimension (specified in the <code>config.json</code>) the Boss spawned in.
 +
|}
 +
</spoiler>
 +
* <code>spawnedUltimateBoss</code>: Used to specify the broadcast for when an Ultimate Boss has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
 +
** Default: <code>&bAn Ultimate, &f%1&b, Boss has spawned in a &f%2 biome &bsomewhere in the &f%3&b!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Pokémon || <code>%1</code> || Displays the Form and Species of the Boss.
 +
|-
 +
| Biome Name || <code>%2</code> || Displays the name of the biome the Boss spawned in.
 +
|-
 +
| Dimension Name || <code>%3</code> || Displays the name of the dimension (specified in the <code>config.json</code>) the Boss spawned in.
 +
|}
 +
</spoiler>
 +
* <code>spawnedLegendaryBoss</code>: Used to specify the broadcast for when a Legendary Boss has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
 +
** Default: <code>&6A Legendary, &f%1&6, Boss has spawned in a &f%2 biome &6somewhere in the &f%3&6!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Pokémon || <code>%1</code> || Displays the Form and Species of the Boss.
 +
|-
 +
| Biome Name || <code>%2</code> || Displays the name of the biome the Boss spawned in.
 +
|-
 +
| Dimension Name || <code>%3</code> || Displays the name of the dimension (specified in the <code>config.json</code>) the Boss spawned in.
 +
|}
 +
</spoiler>
 +
* <code>spawnedEpicBoss</code>: Used to specify the broadcast for when an Epic Boss has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
 +
** Default: <code>&5An Epic, &f%1&5, Boss has spawned in a &f%2 biome &5somewhere in the &f%3&5!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Pokémon || <code>%1</code> || Displays the Form and Species of the Boss.
 +
|-
 +
| Biome Name || <code>%2</code> || Displays the name of the biome the Boss spawned in.
 +
|-
 +
| Dimension Name || <code>%3</code> || Displays the name of the dimension (specified in the <code>config.json</code>) the Boss spawned in.
 +
|}
 +
</spoiler>
 +
* <code>spawnedHauntedBoss</code>: Used to specify the broadcast for when a Haunted Boss has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
 +
** Default: <code>&dA Haunted, &f%1&d, Boss has spawned in a &f%2 biome &dsomewhere in the &f%3&d!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Pokémon || <code>%1</code> || Displays the Form and Species of the Boss.
 +
|-
 +
| Biome Name || <code>%2</code> || Displays the name of the biome the Boss spawned in.
 +
|-
 +
| Dimension Name || <code>%3</code> || Displays the name of the dimension (specified in the <code>config.json</code>) the Boss spawned in.
 +
|}
 +
</spoiler>
 +
* <code>spawnedRareBoss</code>: Used to specify the broadcast for when a Rare Boss has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
 +
** Default: <code>&9A Rare, &f%1&9, Boss has spawned in a &f%2 biome &9somewhere in the &f%3&9!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Pokémon || <code>%1</code> || Displays the Form and Species of the Boss.
 +
|-
 +
| Biome Name || <code>%2</code> || Displays the name of the biome the Boss spawned in.
 +
|-
 +
| Dimension Name || <code>%3</code> || Displays the name of the dimension (specified in the <code>config.json</code>) the Boss spawned in.
 +
|}
 +
</spoiler>
 +
* <code>spawnedUncommonBoss</code>: Used to specify the broadcast for when an Uncommon Boss has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
 +
** Default: <code>&aAn Uncommon, &f%1&a, Boss has spawned in a &f%2 biome &asomewhere in the &f%3&a!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Pokémon || <code>%1</code> || Displays the Form and Species of the Boss.
 +
|-
 +
| Biome Name || <code>%2</code> || Displays the name of the biome the Boss spawned in.
 +
|-
 +
| Dimension Name || <code>%3</code> || Displays the name of the dimension (specified in the <code>config.json</code>) the Boss spawned in.
 +
|}
 +
</spoiler>
 +
* <code>spawnedCommonBoss</code>: Used to specify the broadcast for when a Common Boss has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
 +
** Default: <code>&7A Common, &f%1&7, Boss has spawned in a &f%2 biome &7somewhere in the &f%3&7</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Pokémon || <code>%1</code> || Displays the Form and Species of the Boss.
 +
|-
 +
| Biome Name || <code>%2</code> || Displays the name of the biome the Boss spawned in.
 +
|-
 +
| Dimension Name || <code>%3</code> || Displays the name of the dimension (specified in the <code>config.json</code>) the Boss spawned in.
 +
|}
 +
</spoiler>
 +
* <code>spawnedLegendary</code>: Used to specify the broadcast for when a Legendary has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
 +
** Default: <code>&aA %1%2&aLegendary, &d%3&a, has spawned in a &d%4 biome &asomewhere in the &d%5&a!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Shiny || <code>%1</code> || Displays an indicator (specified in the <code>lang.json</code>) if the Pokémon is shiny.
 +
|-
 +
| Custom Texture || <code>%2</code> || Displays an indicator (specified in the <code>lang.json</code>) if the Pokémon is Custom Texture.
 +
|-
 +
| Pokémon || <code>%3</code> || Displays the Form and Species of the Legendary.
 +
|-
 +
| Biome Name || <code>%4</code> || Displays the name of the biome the Legendary spawned in.
 +
|-
 +
| Dimension Name || <code>%5</code> || Displays the name of the dimension (specified in the <code>config.json</code>) the Legendary spawned in.
 +
|}
 +
</spoiler>
 +
* <code>spawnedUltraBeast</code>: Used to specify the broadcast for when an Ultra Beast has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
 +
** Default: <code>&5A %1%2&5Ultra Beast, &e%3&5, has spawned in a &e%4 biome &5somewhere in the &e%5&5!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Shiny || <code>%1</code> || Displays an indicator (specified in the <code>lang.json</code>) if the Pokémon is shiny.
 +
|-
 +
| Custom Texture || <code>%2</code> || Displays an indicator (specified in the <code>lang.json</code>) if the Pokémon is Custom Texture.
 +
|-
 +
| Pokémon || <code>%3</code> || Displays the Form and Species of the Ultra Beast.
 +
|-
 +
| Biome Name || <code>%4</code> || Displays the name of the biome the Ultra Beast spawned in.
 +
|-
 +
| Dimension Name || <code>%5</code> || Displays the name of the dimension (specified in the <code>config.json</code>) the Ultra Beast spawned in.
 +
|}
 +
</spoiler>
 +
* <code>spawnedCustomTexture</code>: Used to specify the broadcast for when a Custom Texture has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
 +
** Default: <code>&7A %1 &9%2&7 has spawned in a &9%3 biome &7somewhere in the &9%4&7!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Custom Texture || <code>%1</code> || Displays an indicator (specified in the <code>lang.json</code>) if the Pokémon is Custom Texture.
 +
|-
 +
| Pokémon || <code>%2</code> || Displays the Form and Species of the Custom Texture.
 +
|-
 +
| Biome Name || <code>%3</code> || Displays the name of the biome the Custom Texture spawned in.
 +
|-
 +
| Dimension Name || <code>%4</code> || Displays the name of the dimension (specified in the <code>config.json</code>) the Custom Texture spawned in.
 +
|}
 +
</spoiler>
 +
* <code>spawnedShiny</code>: Used to specify the broadcast for when a Shiny has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
 +
** Default: <code>&eA Shiny &6%1&e &ehas spawned in a &6%2 biome &esomewhere in the &6%3&e!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Pokémon || <code>%1</code> || Displays the Form and Species of the Shiny.
 +
|-
 +
| Biome Name || <code>%2</code> || Displays the name of the biome the Shiny spawned in.
 +
|-
 +
| Dimension Name || <code>%3</code> || Displays the name of the dimension (specified in the <code>config.json</code>) the Shiny spawned in.
 +
|}
 +
</spoiler>
  
−
==== Evolution nodes ====
+
==== Caught Events ====
−
Shown when a player's Pokémon finishes evolving.
+
* <code>caughtLegendary</code>: Used to specify the broadcast for when a Legendary has been caught. If blank, nothing will be broadcasted when it is caught and it won't be logged.
−
* <code>pixelmonbroadcasts.notify.evolve</code>
+
** Default: <code>&aA %1%2&aLegendary &d%3&a, with &d%4% IVs&a, was caught by &d%5&a!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Shiny || <code>%1</code> || Displays an indicator (specified in the <code>lang.json</code>) if the Pokémon is shiny.
 +
|-
 +
| Custom Texture || <code>%2</code> || Displays an indicator (specified in the <code>lang.json</code>) if the Pokémon is Custom Texture.
 +
|-
 +
| Pokémon || <code>%4</code> || Displays the Form and Species of the Legendary.
 +
|-
 +
| IV Percentage|| <code>%5</code> || Displays the Pokémon's IV Percentage.
 +
|-
 +
| Player || <code>%6</code> || Displayed the name of the player who caught the Legendary.
 +
|}
 +
</spoiler>
 +
* <code>caughtUltraBeast</code>: Used to specify the broadcast for when an Ultra Beast has been caught. If blank, nothing will be broadcasted when it is caught and it won't be logged.
 +
** Default: <code>&5An %1%2&5Ultra Beast &e%3&5, with &e%4% IVs&5, was caught by &e%5&5!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Shiny || <code>%1</code> || Displays an indicator (specified in the <code>lang.json</code>) if the Pokémon is shiny.
 +
|-
 +
| Custom Texture || <code>%2</code> || Displays an indicator (specified in the <code>lang.json</code>) if the Pokémon is Custom Texture.
 +
|-
 +
| Pokémon || <code>%3</code> || Displays the Form and Species of the Ultra Beast.
 +
|-
 +
| IV Percentage|| <code>%4</code> || Displays the Pokémon's IV Percentage.
 +
|-
 +
| Player || <code>%5</code> || Displayed the name of the player who caught the Ultra Beast.
 +
|}
 +
</spoiler>
 +
* <code>caughtHA</code>: Used to specify the broadcast for when a Hidden Ability has been caught. If blank, nothing will be broadcasted when it is caught and it won't be logged.
 +
** Default: <code>&4A %1%2&4Hidden Ability &8(&6%3&8) &6%4&4, with &6%5% IVs&4, was caught by &6%6&4!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Shiny || <code>%1</code> || Displays an indicator (specified in the <code>lang.json</code>) if the Pokémon is shiny.
 +
|-
 +
| Custom Texture || <code>%2</code> || Displays an indicator (specified in the <code>lang.json</code>) if the Pokémon is Custom Texture.
 +
|-
 +
| Hidden Ability|| <code>%3</code> || Displays the Ability name of the Pokémon. Will be the Hidden Ability's name.
 +
|-
 +
| Pokémon || <code>%4</code> || Displays the Form and Species of the Custom Texture.
 +
|-
 +
| IV Percentage|| <code>%5</code> || Displays the Pokémon's IV Percentage.
 +
|-
 +
| Player || <code>%6</code> || Displayed the name of the player who caught the Custom Texture.
 +
|}
 +
</spoiler>
 +
* <code>caughtCustomTexture</code>: Used to specify the broadcast for when a Custom Texture has been caught. If blank, nothing will be broadcasted when it is caught and it won't be logged.
 +
** Default: <code>&7A %1%2&9%3&7, with &9%4% IVs&7, was caught by &9%5&7!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Shiny || <code>%1</code> || Displays an indicator (specified in the <code>lang.json</code>) if the Pokémon is shiny.
 +
|-
 +
| Custom Texture || <code>%2</code> || Displays an indicator (specified in the <code>lang.json</code>) if the Pokémon is Custom Texture.
 +
|-
 +
| Pokémon || <code>%3</code> || Displays the Form and Species of the Custom Texture.
 +
|-
 +
| IV Percentage|| <code>%4</code> || Displays the Pokémon's IV Percentage.
 +
|-
 +
| Player || <code>%5</code> || Displayed the name of the player who caught the Custom Texture.
 +
|}
 +
</spoiler>
 +
* <code>caughtShiny</code>: Used to specify the broadcast for when a Shiny has been caught. If blank, nothing will be broadcasted when it is caught and it won't be logged.
 +
** Default: <code>&eA Shiny &6%1&e, with &6%2% IVs&e, was caught by &6%3&e!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Pokémon || <code>%1</code> || Displays the Form and Species of the Shiny.
 +
|-
 +
| IV Percentage|| <code>%2</code> || Displays the Pokémon's IV Percentage.
 +
|-
 +
| Player || <code>%3</code> || Displayed the name of the player who caught the Shiny.
 +
|}
 +
</spoiler>
  
−
==== Pokémon fainting nodes ====
+
==== Defeated Events ====
−
Shown when a Pokémon in a player's party faints. Probably useless outside of Nuzlocke setups.
+
* <code>defeatedDrownedBoss</code>: Used to specify the broadcast for when a Drowned Boss is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
−
* <code>pixelmonbroadcasts.notify.faint</code>
+
** Default: <code>&f%1 &3defeated the Drowned, &f%2&3, Boss...</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Player || <code>%1</code> || Displayed the name of the player who defeated the Boss.
 +
|-
 +
| Pokémon || <code>%2</code> || Displays the Form and Species of the Boss.
 +
|}
 +
</spoiler>
 +
* <code>defeatedUltimateBoss</code>: Used to specify the broadcast for when an Ultimate Boss is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
 +
** Default: <code>&f%1&b defeated the Ultimate, &f%2&b, Boss...</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Player || <code>%1</code> || Displayed the name of the player who defeated the Boss.
 +
|-
 +
| Pokémon || <code>%2</code> || Displays the Form and Species of the Boss.
 +
|}
 +
</spoiler>
 +
* <code>defeatedLegendaryBoss</code>: Used to specify the broadcast for when a Legendary Boss is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
 +
** Default: <code>&f%1&6 defeated the Legendary, &f%2&6, Boss...</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Player || <code>%1</code> || Displayed the name of the player who defeated the Boss.
 +
|-
 +
| Pokémon || <code>%2</code> || Displays the Form and Species of the Boss.
 +
|}
 +
</spoiler>
 +
* <code>defeatedEpicBoss</code>: Used to specify the broadcast for when an Epic Boss is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
 +
** Default: <code>&f%1&5 defeated the Epic, &f%2&5, Boss...</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Player || <code>%1</code> || Displayed the name of the player who defeated the Boss.
 +
|-
 +
| Pokémon || <code>%2</code> || Displays the Form and Species of the Boss.
 +
|}
 +
</spoiler>
 +
* <code>defeatedHauntedBoss</code>: Used to specify the broadcast for when a Haunted Boss is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
 +
** Default: <code>&f%1&d defeated the Haunted, &f%2&d, Boss...</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Player || <code>%1</code> || Displayed the name of the player who defeated the Boss.
 +
|-
 +
| Pokémon || <code>%2</code> || Displays the Form and Species of the Boss.
 +
|}
 +
</spoiler>
 +
* <code>defeatedRareBoss</code>: Used to specify the broadcast for when a Rare Boss is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
 +
** Default: <code>&f%1&9 defeated the Rare, &f%2&9, Boss...</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Player || <code>%1</code> || Displayed the name of the player who defeated the Boss.
 +
|-
 +
| Pokémon || <code>%2</code> || Displays the Form and Species of the Boss.
 +
|}
 +
</spoiler>
 +
* <code>defeatedUncommonBoss</code>: Used to specify the broadcast for when an Uncommon Boss is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
 +
** Default: <code>&f%1&a defeated the Uncommon, &f%2&a, Boss...</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Player || <code>%1</code> || Displayed the name of the player who defeated the Boss.
 +
|-
 +
| Pokémon || <code>%2</code> || Displays the Form and Species of the Boss.
 +
|}
 +
</spoiler>
 +
* <code>defeatedCommonBoss</code>: Used to specify the broadcast for when a Common Boss is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
 +
** Default: <code>&f%1&7 defeated the Common, &f%2&7, Boss...</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Player || <code>%1</code> || Displayed the name of the player who defeated the Boss.
 +
|-
 +
| Pokémon || <code>%2</code> || Displays the Form and Species of the Boss.
 +
|}
 +
</spoiler>
 +
* <code>defeatedLegendary</code>: Used to specify the broadcast for when a Legendary is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
 +
** Default: <code>&d%1 &adefeated the %2%3&aLegendary &d%4&a...</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Player || <code>%1</code> || Displayed the name of the player who defeated the Legendary.
 +
|-
 +
| Shiny || <code>%2</code> || Displays an indicator (specified in the <code>lang.json</code>) if the Pokémon is Shiny.
 +
|-
 +
| Custom Texture || <code>%3</code> || Displays an indicator (specified in the <code>lang.json</code>) if the Pokémon is Legendary.
 +
|-
 +
| Pokémon || <code>%4</code> || Displays the Form and Species of the Legendary.
 +
|}
 +
</spoiler>
 +
* <code>defeatedUltraBeast</code>: Used to specify the broadcast for when an Ultra Beast is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
 +
** Default: <code>&e%1 &5defeated the %2%3&5Ultra Beast &e%4&5...</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Player || <code>%1</code> || Displayed the name of the player who defeated the Ultra Beast.
 +
|-
 +
| Shiny || <code>%2</code> || Displays an indicator (specified in the <code>lang.json</code>) if the Pokémon is Shiny.
 +
|-
 +
| Custom Texture || <code>%3</code> || Displays an indicator (specified in the <code>lang.json</code>) if the Pokémon is Custom Texture.
 +
|-
 +
| Pokémon || <code>%4</code> || Displays the Form and Species of the Ultra Beast.
 +
|}
 +
</spoiler>
 +
* <code>defeatedHA</code>: Used to specify the broadcast for when a Hidden Ability is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
 +
** Default: <code>&6%1 &4defeated the %2%3&4Hidden Ability &8(&6%4&8) &6%5&4...</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Player || <code>%1</code> || Displayed the name of the player who defeated the Hidden Ability Pokémon.
 +
|-
 +
| Shiny || <code>%2</code> || Displays an indicator (specified in the <code>lang.json</code>) if the Pokémon is Shiny.
 +
|-
 +
| Custom Texture || <code>%3</code> || Displays an indicator (specified in the <code>lang.json</code>) if the Pokémon is Custom Texture.
 +
|-
 +
| Hidden Ability|| <code>%4</code> || Displays the Ability name of the Pokémon. Will be the Hidden Ability's name.
 +
|-
 +
| Pokémon || <code>%5</code> || Displays the Form and Species of the Hidden Ability Pokémon.
 +
|}
 +
</spoiler>
 +
* <code>defeatedCustomTexture</code>: Used to specify the broadcast for when a Custom Texture is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
 +
** Default: <code>&9%1 &7defeated the %2 &9%3&7...</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Player || <code>%1</code> || Displayed the name of the player who defeated the Custom Texture.
 +
|-
 +
| Custom Texture || <code>%2</code> || Displays an indicator (specified in the <code>lang.json</code>) if the Pokémon is Custom Texture.
 +
|-
 +
| Pokémon || <code>%3</code> || Displays the Form and Species of the Custom Texture.
 +
|}
 +
</spoiler>
 +
* <code>defeatedShiny</code>: Used to specify the broadcast for when a Shiny is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
 +
** Default: <code>&6%1 &edefeated the Shiny &6%2&e...</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Player || <code>%1</code> || Displayed the name of the player who defeated the Shiny.
 +
|-
 +
| Pokémon || <code>%2</code> || Displays the Form and Species of the Shiny.
 +
|}
 +
</spoiler>
  
−
==== Trade nodes ====
+
==== Hatched Events ====
−
Shown when a trade completes.
+
* <code>hatchedLegendary</code>: Used to specify the broadcast for when a Legendary is hatched from an egg. If blank, nothing will be broadcasted when it is hatched and it won't be logged.
−
* <code>pixelmonbroadcasts.notify.trade</code>
+
** Default: <code>&d%1 &ahatched a %2%3&aLegendary &d%4&a, with &d%5% IVs&a!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Player || <code>%1</code> || Displayed the name of the player who hatched the Shiny.
 +
|-
 +
| Pokémon || <code>%2</code> || Displays the Form and Species of the Shiny.
 +
|-
 +
| IV Percentage|| <code>%3</code> || Displays the Pokémon's IV Percentage.
 +
|}
 +
</spoiler>
 +
* <code>hatchedUltraBeast</code>: Used to specify the broadcast for when an Ultra Beast is hatched from an egg. If blank, nothing will be broadcasted when it is hatched and it won't be logged.
 +
** Default: <code>&e%1 &5hatched an %2%3&5Ultra Beast &e%4&5, with &e%5% IVs&5!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Player || <code>%1</code> || Displayed the name of the player who hatched the Shiny.
 +
|-
 +
| Pokémon || <code>%2</code> || Displays the Form and Species of the Shiny.
 +
|-
 +
| IV Percentage|| <code>%3</code> || Displays the Pokémon's IV Percentage.
 +
|}
 +
</spoiler>
 +
* <code>hatchedHA</code>: Used to specify the broadcast for when a Hidden Ability is hatched from an egg. If blank, nothing will be broadcasted when it is hatched and it won't be logged.
 +
** Default: <code>&6%1 &4hatched a %2%3&4Hidden Ability &8(&6%2&8) &6%3&4, with &6%4% IVs&4!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Player || <code>%1</code> || Displayed the name of the player who hatched the Hidden Ability.
 +
|-
 +
| Pokémon || <code>%2</code> || Displays the Form and Species of the Hidden Ability.
 +
|-
 +
| IV Percentage|| <code>%3</code> || Displays the Pokémon's IV Percentage.
 +
|}
 +
</spoiler>
 +
* <code>hatchedCustomTexture</code>: Used to specify the broadcast for when a Custom Texture is hatched from an egg. If blank, nothing will be broadcasted when it is hatched and it won't be logged.
 +
** Default: <code>&9%1 &7hatched a %2 &9%3&7, with &9%4% IVs&7!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Player || <code>%1</code> || Displayed the name of the player who hatched the Custom Texture.
 +
|-
 +
| Custom Texture|| <code>%2</code> || Displays the Custom Texture (specified in the <code>config.json</code>) of the Pokémon.
 +
|-
 +
| Pokémon || <code>%3</code> || Displays the Form and Species of the Custom Texture.
 +
|-
 +
| IV Percentage || <code>%4</code> || Displays the Pokémon's IV Percentage.
 +
|}
 +
</spoiler>
 +
* <code>hatchedShiny</code>: Used to specify the broadcast for when a Shiny is hatched from an egg. If blank, nothing will be broadcasted when it is hatched and it won't be logged.
 +
** Default: <code>&e%1 &6hatched a Shiny &e%2&6, with &e%3% IVs&6!</code>.
 +
** Available Placeholders: <spoiler text="Show">
 +
{| class="wikitable sortable"
 +
|-
 +
! Value to Display !! Placeholder !! Displayed Outcome
 +
|-
 +
| Player || <code>%1</code> || Displayed the name of the player who hatched the Shiny.
 +
|-
 +
| Pokémon || <code>%2</code> || Displays the Form and Species of the Shiny.
 +
|-
 +
| IV Percentage|| <code>%3</code> || Displays the Pokémon's IV Percentage.
 +
|}
 +
</spoiler>
  
 
== Version history ==
 
== Version history ==
 
Please click [[Version history/Pixelmon_Broadcasts|this link]].
 
Please click [[Version history/Pixelmon_Broadcasts|this link]].
 
[[Category:Sidemods]]
 
[[Category:Sidemods]]

Latest revision as of 21:37, 8 February 2022

Pixelmon Broadcasts is a sidemod for Pixelmon which extents the legendary spawned message into a multiple of different Pixelmon events with customizable messages (broadcasts). These events are also logged into the main log file if enabled.


Installation

Minecraft version Pixelmon version Pixelmon Broadcasts version
1.12.2 8.3.6+ 1.2.3
1.12.2 8.3.5+ 1.2.0
1.12.2 8.3.1+ 1.1.1
1.12.2 8.3.0+ 1.0.2
1.12.2 8.2.0+ 0.6.1
1.12.2 8.0.0+ 0.6
1.12.2 7.0.5+ 0.4.1
1.12.2 6.3.4 0.2.2

Servers

  1. Download Pixemon Broadcasts for your version of Minecraft/Pixelmon here.
  2. Place the downloaded .jar in the server's mods folder.
  3. Start the server and wait for it to load.
  4. Open the configuration folder in the server's config/pixelmonbroadcasts and edit the files as desired.
  5. Either restart the server or use /pixelmonbroadcasts reload (see commands for more detail) command to load any changes made.

Clients

  1. Download PixelBroadcasts for your version of Minecraft/Pixelmon here.
  2. Place the downloaded .jar in your game's mods folder.
  3. Start the game and wait for it to load.
  4. Open the configuration folder in the game's config/pixelmonbroadcasts and edit the files as desired. The default setup should be fine though.
  5. Either restart the game or use /pixelmonbroadcasts reload (see commands for more detail) command to load any changes made.

Commands

Note: Command syntax is displayed in the standard Minecraft command format. An explanation of this format can be found here.

  • /pixelmonbroadcasts: The base command used for all subcommands. Displays the sidemod's version if ran by itself.
    • reload: The subcommand to reload all configurations (config, lang and broadcasts folder).

Permissions

  • /pixelmonbroadcasts: None
  • /pixelmonbroadcasts reload: pixelmonbroadcasts.admin or pixelmonbroadcasts.admin.reload

Configuration

Note: All configurations are .json files - we recommend you validate them when making significant changes.

Config File

The config.json is intended to allow for as much customization as possible! The contents of this file are either used throughout the plugin.

  • commandName: Used to specify the base. All commandAliases will use this.
    • Default: pixelmonbroadcasts.
  • commandAliases: Used to specify aliases for the commandName.
    • Default: pixelbroadcasts, pbroadcasts.
  • broadcastsDimPlayerOnly: Used to specify if all online players or if only players in the same dimension as the event will see the broadcast.
    • Default: false.
  • logToConsole: Used to specify if additional details regarding the broadcast are logged. These details include player's username, player's UUID, Pokémon, coordinates, dimension ID and dimension name.
    • Default: true.
  • dimensionNames: Used to specify the name of the dimension based on the dimension's ID.
    • Default: "0": "Overworld".
  • customTextureMessage: Used to specify the display for custom textures in the broadcast. The custom texture's name is first specified then the display, supports formatting codes.
    • Default: "shadow": "&8Shadow".
  • customTextureHover: Used to specify the display for custom textures in the hover. The custom texture's name is first specified then the the HEX code.
    • Default: "shadow": "#555555".
  • showHoverStats: Used to specify if hovering over the broadcast will display the stats of the Pokémon. The stats displayed can be changed below.
    • Default: true.
  • statsDisplay: Used to specify the stats of the Pokémon displayed when hovering over the the broadcast.
    • Default: all placeholders are used.
    • Available Placeholders: Show


Lang File

The lang.json is intended to allow for as much customization as possible! The contents of this file are either used by commands, the broadcasts or the hover functionality.

  • prefixNeutral: Used specify the broadcast's neutral prefix.
    • Default &0[&d&lPixelmon&0] &8&l>&7 .
  • prefixPositive: Used specify the broadcast's positive (successes) prefix.
    • Default &0[&d&lPixelmon&0] &8&l>&a .
  • prefixNegative: Used specify the broadcast's negative (error) prefix.
    • Default &0[&d&lPixelmon&0] &8&l>&c .
  • reload: Used to specify the reload message.
    • Default Reloaded configuration!.
  • noPerms: Used to specify the no permission message.
    • Default You don't have permission!.
  • invalidArgs: Used to specify the invalid arguments message.
    • Default Invalid args!.
  • shinyMessage: Used to specify the indicator displayed in the broadcast if the Pokémon is shiny.
    • Default &6Shiny .
  • untradeableHover: Used to specify the indicator displayed on the stats hover if the Pokemon is untradeable.
    • Default &8[&4Untradeable&8].
  • shinyHover: Used to specify the indicator displayed on the stats hover if the Pokemon is shiny.
    • Default &e&l★.
  • hasPokerusHover: Used to specify the indicator displayed on the stats hover if the Pokemon has Pokerus.
    • Default &8[&dPKRS&8].
  • noPokerusHover: Used to specify the indicator displayed on the stats hover if the Pokemon has had Pokerus and been cured.
    • Default &8[&7&mPKRS&8].
  • maleGenderHover: Used to specify the indicator displayed on the stats hover if the Pokemon has is female.
    • Default &bMale &l♂.
  • femaleGenderHover: Used to specify the indicator displayed on the stats hover if the Pokemon has is a male.
    • Default &dFemale &l♀.
  • genderlessGenderHover: Used to specify the indicator displayed on the stats hover if the Pokemon is genderless.
    • Default Genderless.
  • natureBenefitsHover: Used to specify the indicator displayed on the stats hover, showing the stat benefits of the Pokémon's nature.
    • Default &8[&a+%1 &8| &c-%2&8].
    • Available Placeholders: Show
  • natureNeutralHover: Used to specify the indicator displayed on the stats hover if the Pokemon's nature does not impact the stats/is neutral.
    • Default &8[&7Neutral&8].
  • unbreedableHover: Used to specify the indicator displayed on the stats hover if the Pokémon is unbreedable (Pokémon Spec).
    • Default &cUnbreedable.
  • unbreedableEggHover: Used to specify the indicator displayed on the stats hover if the Pokémon is unbreedable (Undiscovered Egg Groups).
    • Default &4Unbreedable.
  • breedableHover: Used to specify the indicator displayed on the stats hover if the Pokémon is breedable.
    • Default &aBreedable.
  • noItemHover: Used to specify the indicator displayed on the stats hover if the Pokémon has no held item.
    • Default &eNone.
  • noAttackHover: Used to specify the indicator displayed on the stats hover if a move slot is blank/empty.
    • Default &8&l&m---.
  • a: Used to specify the indefinite artificial for consonants in the broadcasts (currently unused).
    • Default a.
  • an: Used to specify the indefinite artificial for vowels in the broadcasts (currently unused).
    • Default an.

Broadcasts Folder

The broadcasts folder is used to store the multiple .json files used to specify which broadcasts are enabled/disabled in each dimension. Each file required the same structure/contents but the messages can be customized to your heart's desire!

  • id: Used to specify the unique ID/name of the broadcasts file. We recommend that the id is the dimension's name/purpose where possible.
  • weight: Used to specify the priority of the broadcasts.
  • dimension: Used to specify dimensions the specified broadcasts will be available. To disable specific broadcasts in a specific dimension, remove that dimension's ID from all other broadcast files and create a new separate one with the broadcasts you want disabled as empty.

Spawn Events

  • spawnedWormhole: Used to specify the broadcast for when an Ultra Wormhole has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
    • Default: &5An Ultra Wormhole &5has opened in a &f%1 biome &5somewhere in the &f%2&5!.
    • Available Placeholders: Show
  • spawnedDrownedBoss: Used to specify the broadcast for when a Drowned Boss has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
    • Default: &3A Drowned, &f%1&3, Boss has spawned in a &f%2 biome &3somewhere in the &f%3&3!.
    • Available Placeholders: Show
  • spawnedUltimateBoss: Used to specify the broadcast for when an Ultimate Boss has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
    • Default: &bAn Ultimate, &f%1&b, Boss has spawned in a &f%2 biome &bsomewhere in the &f%3&b!.
    • Available Placeholders: Show
  • spawnedLegendaryBoss: Used to specify the broadcast for when a Legendary Boss has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
    • Default: &6A Legendary, &f%1&6, Boss has spawned in a &f%2 biome &6somewhere in the &f%3&6!.
    • Available Placeholders: Show
  • spawnedEpicBoss: Used to specify the broadcast for when an Epic Boss has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
    • Default: &5An Epic, &f%1&5, Boss has spawned in a &f%2 biome &5somewhere in the &f%3&5!.
    • Available Placeholders: Show
  • spawnedHauntedBoss: Used to specify the broadcast for when a Haunted Boss has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
    • Default: &dA Haunted, &f%1&d, Boss has spawned in a &f%2 biome &dsomewhere in the &f%3&d!.
    • Available Placeholders: Show
  • spawnedRareBoss: Used to specify the broadcast for when a Rare Boss has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
    • Default: &9A Rare, &f%1&9, Boss has spawned in a &f%2 biome &9somewhere in the &f%3&9!.
    • Available Placeholders: Show
  • spawnedUncommonBoss: Used to specify the broadcast for when an Uncommon Boss has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
    • Default: &aAn Uncommon, &f%1&a, Boss has spawned in a &f%2 biome &asomewhere in the &f%3&a!.
    • Available Placeholders: Show
  • spawnedCommonBoss: Used to specify the broadcast for when a Common Boss has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
    • Default: &7A Common, &f%1&7, Boss has spawned in a &f%2 biome &7somewhere in the &f%3&7.
    • Available Placeholders: Show
  • spawnedLegendary: Used to specify the broadcast for when a Legendary has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
    • Default: &aA %1%2&aLegendary, &d%3&a, has spawned in a &d%4 biome &asomewhere in the &d%5&a!.
    • Available Placeholders: Show
  • spawnedUltraBeast: Used to specify the broadcast for when an Ultra Beast has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
    • Default: &5A %1%2&5Ultra Beast, &e%3&5, has spawned in a &e%4 biome &5somewhere in the &e%5&5!.
    • Available Placeholders: Show
  • spawnedCustomTexture: Used to specify the broadcast for when a Custom Texture has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
    • Default: &7A %1 &9%2&7 has spawned in a &9%3 biome &7somewhere in the &9%4&7!.
    • Available Placeholders: Show
  • spawnedShiny: Used to specify the broadcast for when a Shiny has spawned. If blank, nothing will be broadcasted when it spawns and it won't be logged.
    • Default: &eA Shiny &6%1&e &ehas spawned in a &6%2 biome &esomewhere in the &6%3&e!.
    • Available Placeholders: Show


Caught Events

  • caughtLegendary: Used to specify the broadcast for when a Legendary has been caught. If blank, nothing will be broadcasted when it is caught and it won't be logged.
    • Default: &aA %1%2&aLegendary &d%3&a, with &d%4% IVs&a, was caught by &d%5&a!.
    • Available Placeholders: Show
  • caughtUltraBeast: Used to specify the broadcast for when an Ultra Beast has been caught. If blank, nothing will be broadcasted when it is caught and it won't be logged.
    • Default: &5An %1%2&5Ultra Beast &e%3&5, with &e%4% IVs&5, was caught by &e%5&5!.
    • Available Placeholders: Show
  • caughtHA: Used to specify the broadcast for when a Hidden Ability has been caught. If blank, nothing will be broadcasted when it is caught and it won't be logged.
    • Default: &4A %1%2&4Hidden Ability &8(&6%3&8) &6%4&4, with &6%5% IVs&4, was caught by &6%6&4!.
    • Available Placeholders: Show
  • caughtCustomTexture: Used to specify the broadcast for when a Custom Texture has been caught. If blank, nothing will be broadcasted when it is caught and it won't be logged.
    • Default: &7A %1%2&9%3&7, with &9%4% IVs&7, was caught by &9%5&7!.
    • Available Placeholders: Show
  • caughtShiny: Used to specify the broadcast for when a Shiny has been caught. If blank, nothing will be broadcasted when it is caught and it won't be logged.
    • Default: &eA Shiny &6%1&e, with &6%2% IVs&e, was caught by &6%3&e!.
    • Available Placeholders: Show


Defeated Events

  • defeatedDrownedBoss: Used to specify the broadcast for when a Drowned Boss is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
    • Default: &f%1 &3defeated the Drowned, &f%2&3, Boss....
    • Available Placeholders: Show
  • defeatedUltimateBoss: Used to specify the broadcast for when an Ultimate Boss is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
    • Default: &f%1&b defeated the Ultimate, &f%2&b, Boss....
    • Available Placeholders: Show
  • defeatedLegendaryBoss: Used to specify the broadcast for when a Legendary Boss is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
    • Default: &f%1&6 defeated the Legendary, &f%2&6, Boss....
    • Available Placeholders: Show
  • defeatedEpicBoss: Used to specify the broadcast for when an Epic Boss is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
    • Default: &f%1&5 defeated the Epic, &f%2&5, Boss....
    • Available Placeholders: Show
  • defeatedHauntedBoss: Used to specify the broadcast for when a Haunted Boss is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
    • Default: &f%1&d defeated the Haunted, &f%2&d, Boss....
    • Available Placeholders: Show
  • defeatedRareBoss: Used to specify the broadcast for when a Rare Boss is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
    • Default: &f%1&9 defeated the Rare, &f%2&9, Boss....
    • Available Placeholders: Show
  • defeatedUncommonBoss: Used to specify the broadcast for when an Uncommon Boss is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
    • Default: &f%1&a defeated the Uncommon, &f%2&a, Boss....
    • Available Placeholders: Show
  • defeatedCommonBoss: Used to specify the broadcast for when a Common Boss is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
    • Default: &f%1&7 defeated the Common, &f%2&7, Boss....
    • Available Placeholders: Show
  • defeatedLegendary: Used to specify the broadcast for when a Legendary is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
    • Default: &d%1 &adefeated the %2%3&aLegendary &d%4&a....
    • Available Placeholders: Show
  • defeatedUltraBeast: Used to specify the broadcast for when an Ultra Beast is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
    • Default: &e%1 &5defeated the %2%3&5Ultra Beast &e%4&5....
    • Available Placeholders: Show
  • defeatedHA: Used to specify the broadcast for when a Hidden Ability is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
    • Default: &6%1 &4defeated the %2%3&4Hidden Ability &8(&6%4&8) &6%5&4....
    • Available Placeholders: Show
  • defeatedCustomTexture: Used to specify the broadcast for when a Custom Texture is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
    • Default: &9%1 &7defeated the %2 &9%3&7....
    • Available Placeholders: Show
  • defeatedShiny: Used to specify the broadcast for when a Shiny is defeated/faints. If blank, nothing will be broadcasted when it is defeated and it won't be logged.
    • Default: &6%1 &edefeated the Shiny &6%2&e....
    • Available Placeholders: Show


Hatched Events

  • hatchedLegendary: Used to specify the broadcast for when a Legendary is hatched from an egg. If blank, nothing will be broadcasted when it is hatched and it won't be logged.
    • Default: &d%1 &ahatched a %2%3&aLegendary &d%4&a, with &d%5% IVs&a!.
    • Available Placeholders: Show
  • hatchedUltraBeast: Used to specify the broadcast for when an Ultra Beast is hatched from an egg. If blank, nothing will be broadcasted when it is hatched and it won't be logged.
    • Default: &e%1 &5hatched an %2%3&5Ultra Beast &e%4&5, with &e%5% IVs&5!.
    • Available Placeholders: Show
  • hatchedHA: Used to specify the broadcast for when a Hidden Ability is hatched from an egg. If blank, nothing will be broadcasted when it is hatched and it won't be logged.
    • Default: &6%1 &4hatched a %2%3&4Hidden Ability &8(&6%2&8) &6%3&4, with &6%4% IVs&4!.
    • Available Placeholders: Show
  • hatchedCustomTexture: Used to specify the broadcast for when a Custom Texture is hatched from an egg. If blank, nothing will be broadcasted when it is hatched and it won't be logged.
    • Default: &9%1 &7hatched a %2 &9%3&7, with &9%4% IVs&7!.
    • Available Placeholders: Show
  • hatchedShiny: Used to specify the broadcast for when a Shiny is hatched from an egg. If blank, nothing will be broadcasted when it is hatched and it won't be logged.
    • Default: &e%1 &6hatched a Shiny &e%2&6, with &e%3% IVs&6!.
    • Available Placeholders: Show


Version history

Please click this link.

Retrieved from "http://pixelmonmod.com/w/index.php?title=Pixelmon_Broadcasts&oldid=102298"
Powered by MediaWiki

© 2012 - 2025 Pixelmon Mod