Difference between revisions of "Pixelmon Broadcasts"

Revision as of 17:17, 9 March 2019

Warning: This sidemod is a work in progress, and may cause issues. Proceed with caution, and report any bugs.

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.

Installation

Minecraft version	Pixelmon version	Pixelmon Broadcasts version
1.12.2	7.0.3+	0.4
1.12.2	6.3.4	0.2.2

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 Pixelmon Broadcasts for your version of Minecraft and Pixelmon.
Place the downloaded .jar file in the mods folder, along with SpongeForge.
Start the server and wait for it to load.
Open the configuration files in the server's config/PixelmonBroadcasts folder, and edit to taste.
Use the /pixelmonbroadcasts reload command to load any changes into Pixelmon Broadcasts.
Add the permissions for the broadcasts and commands you want people to have access to to LuckPerms.

Commands

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

/pixelmonbroadcasts or /pbroadcasts: Shows subcommands that the player has access to. Clickable.
- toggle: Prints a list with clickable toggles for all available broadcasts, based on permissions.
- reload: Reloads all config settings, messages and broadcasts.

Permissions

Command nodes

These nodes will give players access to specific subcommands.

pixelmonbroadcasts.command.toggle - grants access to the per-player broadcast toggle menu
pixelmonbroadcasts.command.staff.reload - allows the use of /pixelmonbroadcasts reload, should be staff-only

Action nodes

pixelmonbroadcasts.action.staff.teleport - allows people with this permission to teleport to an event's source

Notifier nodes

These nodes will allow players to see the matching broadcasts, and will allow them to toggle said broadcasts for themselves if the toggle permission was also given.

Blackout nodes

Shown when a player's party is wiped out by an opponent of the given type. Works well with the SafePlace sidemod.

pixelmonbroadcasts.notify.blackout.normal
pixelmonbroadcasts.notify.blackout.shiny
pixelmonbroadcasts.notify.blackout.legendary
pixelmonbroadcasts.notify.blackout.shinylegendary
pixelmonbroadcasts.notify.blackout.ultrabeast
pixelmonbroadcasts.notify.blackout.shinyultrabeast
pixelmonbroadcasts.notify.blackout.boss
pixelmonbroadcasts.notify.blackout.trainer
pixelmonbroadcasts.notify.blackout.bosstrainer

Catch nodes

Shown when a Pokémon of the given type is caught.

pixelmonbroadcasts.notify.catch.normal
pixelmonbroadcasts.notify.catch.shiny
pixelmonbroadcasts.notify.catch.legendary
pixelmonbroadcasts.notify.catch.shinylegendary
pixelmonbroadcasts.notify.catch.ultrabeast
pixelmonbroadcasts.notify.catch.shinyultrabeast

Challenge nodes

Shown when a player starts fighting an opponent of the given type.

pixelmonbroadcasts.notify.challenge.shiny
pixelmonbroadcasts.notify.challenge.legendary
pixelmonbroadcasts.notify.challenge.shinylegendary
pixelmonbroadcasts.notify.challenge.ultrabeast
pixelmonbroadcasts.notify.challenge.shinyultrabeast
pixelmonbroadcasts.notify.challenge.boss
pixelmonbroadcasts.notify.challenge.trainer
pixelmonbroadcasts.notify.challenge.bosstrainer
pixelmonbroadcasts.notify.challenge.pvp

Forfeit nodes

Shown when a player forfeits a battle with an opponent of the given type.

pixelmonbroadcasts.notify.forfeit.shiny
pixelmonbroadcasts.notify.forfeit.legendary
pixelmonbroadcasts.notify.forfeit.shinylegendary
pixelmonbroadcasts.notify.forfeit.ultrabeast
pixelmonbroadcasts.notify.forfeit.shinyultrabeast
pixelmonbroadcasts.notify.forfeit.boss
pixelmonbroadcasts.notify.forfeit.trainer
pixelmonbroadcasts.notify.forfeit.bosstrainer

Spawn nodes

Shown when an entity of the given type spawns in the world.

pixelmonbroadcasts.notify.spawn.shiny
pixelmonbroadcasts.notify.spawn.legendary
pixelmonbroadcasts.notify.spawn.shinylegendary
pixelmonbroadcasts.notify.spawn.ultrabeast
pixelmonbroadcasts.notify.spawn.shinyultrabeast
pixelmonbroadcasts.notify.spawn.wormhole
pixelmonbroadcasts.notify.spawn.boss

Victory nodes

Shown when a player defeats an opponent of the given type.

pixelmonbroadcasts.notify.victory.shiny
pixelmonbroadcasts.notify.victory.legendary
pixelmonbroadcasts.notify.victory.shinylegendary
pixelmonbroadcasts.notify.victory.ultrabeast
pixelmonbroadcasts.notify.victory.shinyultrabeast
pixelmonbroadcasts.notify.victory.boss
pixelmonbroadcasts.notify.victory.trainer
pixelmonbroadcasts.notify.victory.bosstrainer
pixelmonbroadcasts.notify.victory.pvp

Hatch nodes

Shown when an egg of the given type hatches.

pixelmonbroadcasts.notify.hatch.normal
pixelmonbroadcasts.notify.hatch.shiny
pixelmonbroadcasts.notify.hatch.legendary
pixelmonbroadcasts.notify.hatch.shinylegendary
pixelmonbroadcasts.notify.hatch.ultrabeast
pixelmonbroadcasts.notify.hatch.shinyultrabeast

Draw nodes

Shown when a battle of the given type ends in a draw.

pixelmonbroadcasts.notify.pvp.draw

Evolution nodes

Shown when a player's Pokémon finishes evolving.

pixelmonbroadcasts.notify.evolve

Pokémon fainting nodes

Shown when a Pokémon in a player's party faints. Probably useless outside of Nuzlocke setups.

pixelmonbroadcasts.notify.faint

Trade nodes

Shown when a trade completes.

pixelmonbroadcasts.notify.trade

Version history

Please click this link.

@@ Line 3: / Line 3: @@
 [[File:Pbr_broadcasts.png|300px|thumb]]
 [[File:Pbr_toggles.png|300px|thumb]]
-Pixelmon Broadcasts is a [[sidemod]] for [[Pixelmon]] that adds an assortment of configurable messages for tons of Pixelmon events, and also logs these events to console if set up to do so.
+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.
 == Installation ==
 {{SidemodVersionh}}
-{{SidemodVersion|1.12.2|7.0.0|0.3}}
+{{SidemodVersion|1.12.2|7.0.3+|0.4}}
 {{SidemodVersion|1.12.2|6.3.4|0.2.2}}
 {{SidemodVersionf}}
@@ Line 25: / Line 25: @@
 * <code>/pixelmonbroadcasts</code> or <code>/pbroadcasts</code>: Shows subcommands that the player has access to. Clickable.
-** <code>toggle</code>: Opens a window with clickable toggles for all available broadcasts, based on permissions.
+** <code>toggle</code>: Prints a list with clickable toggles for all available broadcasts, based on permissions.
 ** <code>reload</code>: Reloads all config settings, messages and broadcasts.
@@ Line 33: / Line 33: @@
 * <code>pixelmonbroadcasts.command.toggle</code> - grants access to the per-player broadcast toggle menu
 * <code>pixelmonbroadcasts.command.staff.reload</code> - allows the use of /pixelmonbroadcasts reload, should be staff-only
+=== Action nodes ===
+* <code>pixelmonbroadcasts.action.staff.teleport</code> - allows people with this permission to teleport to an event's source
 === Notifier nodes ===
@@ Line 41: / Line 44: @@
 * <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.legendary</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>
@@ Line 51: / Line 56: @@
 * <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.legendary</code>
+* <code>pixelmonbroadcasts.notify.catch.ultrabeast</code>
+* <code>pixelmonbroadcasts.notify.catch.shinyultrabeast</code>
 ==== Challenge nodes ====
 Shown when a player starts fighting an opponent of the given type.
 * <code>pixelmonbroadcasts.notify.challenge.shiny</code>
+* <code>pixelmonbroadcasts.notify.challenge.legendary</code>
 * <code>pixelmonbroadcasts.notify.challenge.shinylegendary</code>
-* <code>pixelmonbroadcasts.notify.challenge.legendary</code>
+* <code>pixelmonbroadcasts.notify.challenge.ultrabeast</code>
+* <code>pixelmonbroadcasts.notify.challenge.shinyultrabeast</code>
 * <code>pixelmonbroadcasts.notify.challenge.boss</code>
 * <code>pixelmonbroadcasts.notify.challenge.trainer</code>
@@ Line 67: / Line 76: @@
 Shown when a player forfeits a battle with an opponent of the given type.
 * <code>pixelmonbroadcasts.notify.forfeit.shiny</code>
+* <code>pixelmonbroadcasts.notify.forfeit.legendary</code>
 * <code>pixelmonbroadcasts.notify.forfeit.shinylegendary</code>
-* <code>pixelmonbroadcasts.notify.forfeit.legendary</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>
@@ Line 76: / Line 87: @@
 Shown when an entity of the given type spawns in the world.
 * <code>pixelmonbroadcasts.notify.spawn.shiny</code>
+* <code>pixelmonbroadcasts.notify.spawn.legendary</code>
 * <code>pixelmonbroadcasts.notify.spawn.shinylegendary</code>
-* <code>pixelmonbroadcasts.notify.spawn.legendary</code>
+* <code>pixelmonbroadcasts.notify.spawn.ultrabeast</code>
+* <code>pixelmonbroadcasts.notify.spawn.shinyultrabeast</code>
+* <code>pixelmonbroadcasts.notify.spawn.wormhole</code>
 * <code>pixelmonbroadcasts.notify.spawn.boss</code>
@@ Line 83: / Line 97: @@
 Shown when a player defeats an opponent of the given type.
 * <code>pixelmonbroadcasts.notify.victory.shiny</code>
+* <code>pixelmonbroadcasts.notify.victory.legendary</code>
 * <code>pixelmonbroadcasts.notify.victory.shinylegendary</code>
-* <code>pixelmonbroadcasts.notify.victory.legendary</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 ====
+Shown when an egg of the given type hatches.
+* <code>pixelmonbroadcasts.notify.hatch.normal</code>
+* <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 ====
@@ Line 94: / Line 119: @@
 * <code>pixelmonbroadcasts.notify.pvp.draw</code>
-==== Hatch nodes ====
+==== Evolution nodes ====
-Shown when an egg of the given type hatches.
+Shown when a player's Pokémon finishes evolving.
-* <code>pixelmonbroadcasts.notify.hatch.normal</code>
+* <code>pixelmonbroadcasts.notify.evolve</code>
-* <code>pixelmonbroadcasts.notify.hatch.shiny</code>
+==== Pokémon fainting nodes ====
+Shown when a Pokémon in a player's party faints. Probably useless outside of Nuzlocke setups.
+* <code>pixelmonbroadcasts.notify.faint</code>
 ==== Trade nodes ====
-Shown when a trade completes. Currently does not do anything special for shiny Pokémon.
+Shown when a trade completes.
-* <code>pixelmonbroadcasts.notify.trade.normal</code>
+* <code>pixelmonbroadcasts.notify.trade</code>
 == Version history ==
 Please click [[Version history/Pixelmon_Broadcasts|this link]].
 [[Category:Sidemods]]