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 "PixelEvent"

From Pixelmon Wiki
m (Text replacement - "Pixelmon Reforged" to "Pixelmon Mod")
 
(13 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
PixelEvent is a [[Pixelmon]] [[sidemod]] for creating custom event in a limited time, where players need to make a specific action (Capture or Kill pokemon) with lots of customisation and reward them with a leaderboard system !
+
PixelEvent is a [[Pixelmon]] [[sidemod]] and [https://www.spongepowered.org/ Sponge] plugin for creating custom events within a limited time, wherein players need to make a specific action (either capturing or defeating Pokémon) and are rewarded according to a leaderboard system. The specific actions and rewards are entirely customizable.
  
 
==Installation==
 
==Installation==
 
{{SidemodVersionh}}
 
{{SidemodVersionh}}
−
{{SidemodVersion|1.12.2|7.0+|5.2.0}}
+
{{SidemodVersion|1.12.2|8.1.0|7.3}}
 +
{{SidemodVersion|1.12.2|7.0+|7.2.1}}
 
{{SidemodVersionf}}
 
{{SidemodVersionf}}
−
PixelEvent is Forge Sidemod, which means it's only server-side.
+
PixelEvent is a Sponge plugin, which means it's only server-side.
−
You need Pixelmon, GriefPrevention and SpongeForge to run it.
+
You need Pixelmon Mod, GriefPrevention or GriefDefender and SpongeForge to run it.
−
Grab the jar and put it on the mods folder, configuration will be in /config/PixelEvent
+
Download the plugin jar and put it in the mods folder. Configuration can be found inside /config/PixelEvent after the server is first started with the plugin.
  
 
==Usage==
 
==Usage==
−
First to all, you need to edit the config.cfg file, to change reward command (see [[PixelEvent#Reward configuration|reward module]]). To create easily the event, you can <code>/pea config</code> then follow the explanation. You can click on the message to make your choice. You can check what setting are made with <code>/pe info</code>. Then, if you think everything is good, start the event with <code>/pea start</code>. Example of event you can make :
+
First, the config.cfg file needs to be edited to change the reward command (see [[PixelEvent#Reward configuration|reward module]]). To quickly create the event, you can use <code>/pea config</code> then follow the gui. You can check the existing settings using <code>/pe info</code>. Once you have finished configuring, start the event with <code>/pea start</code>.  
−
*Kill Rattata
+
 
−
*Kill a pokemon type Water
+
Example events:
−
*Capture a Pokémon of Fire type
+
*Defeat Rattata
 +
*Defeat a Water-type Pokémon
 +
*Capture a Fire-type Pokémon
 
*Capture a Caterpie
 
*Capture a Caterpie
−
*Capture a Caterpie with Ultra Ball
+
*Capture a Caterpie with an Ultra Ball
−
*Capture a Pokémon of Water type with Love Ball
+
*Capture a Water-type Pokémon with a Love Ball
  
 
==Commands==
 
==Commands==
 
{{CommandSyntax}}
 
{{CommandSyntax}}
 
===Player commands===
 
===Player commands===
−
* <code>/pixelevent score</code> (or <code>/pe score</code>) : Display the score you have.
+
* <code>/pixelevent score</code> (or <code>/pe score</code>) : Displays your score.
−
* <code>/pixelevent info</code> (or <code>/pe info</code>) : Display all informations of the event.
+
* <code>/pixelevent info</code> (or <code>/pe info</code>) : Display all information about the event.
−
* <code>/pixelevent leaderboard</code> (or <code>/pe leaderboard</code>) : Display the leaderboard.
+
* <code>/pixelevent leaderboard</code> (or <code>/pe leaderboard</code>) : Displays the leaderboard.
 +
* <code>/pixelevent togglemsg</code> (or <code>/pe togglemsg</code>) : Hide point message.
  
 
===Staff commands===
 
===Staff commands===
−
* <code>/pixeleventadmin wiki</code> (or <code>/pea wiki</code>): Send the URL of this wiki page.
+
* <code>/pixeleventadmin discord</code> (or <code>/pea wiki</code>): Send the Discord of the dev of this plugin.
−
* <code>/pixeleventadmin start</code> (or <code>/pea start</code>): Start the event.
+
* <code>/pixeleventadmin wiki</code> (or <code>/pea wiki</code>): Sends the URL of this wiki page.
−
* <code>/pixeleventadmin stop</code> (or <code>/pea stop</code>): Stop the event and cancel it (No reward).
+
* <code>/pixeleventadmin config</code> (or <code>/pea config</code>): Do this command for easy setup of the config with a GUI.
−
* <code>/pixeleventadmin settimer [time in minutes]</code> (or <code>/pea settimer [time in minutes]</code>): Change the time of your event.
+
* <code>/pixeleventadmin start</code> (or <code>/pea start</code>): Starts the event.
−
* <code>/pixeleventadmin setball [name of the Ball]</code> (or <code>/pea setball [name of the Ball]</code>): Define a new ball for the event (MasterBall etc).
+
* <code>/pixeleventadmin stop</code> (or <code>/pea stop</code>): Stops the event and cancels it (No reward).
−
* <code>/pixeleventadmin setpokemon [pokemon name]</code> (or <code>/pea setpokemon [pokemon name]</code>): Define a new pokemon for the event (Magikarp etc).
+
* <code>/pixeleventadmin timer</code> (or <code>/pea timer</code>): Changes the time for your event.
−
* <code>/pixeleventadmin settype [Pokemon type]</code> (or <code>/pea settype [Pokemon type]</code>): Define a new type for the event (Water etc).
+
* <code>/pixeleventadmin ball</code> (or <code>/pea ball</code>): Change balls settings for the Capture Event.
−
* <code>/pixeleventadmin setevent [Capture/Kill]</code> (or <code>/pea setevent [Capture/Kill]</code>): Define a new Event (Capture or Kill).
+
* <code>/pixeleventadmin setpokemon <''Pokémon name/all''></code> (or <code>/pea setpokemon <''Pokémon name/all''></code>): Define a new Pokémon for the event (Magikarp etc or no restriction with 'all').
 +
* <code>/pixeleventadmin type</code> (or <code>/pea type</code>): Change types settings for the event (Water for example).
 +
* <code>/pixeleventadmin event</code> (or <code>/pea event</code>): Change the event (Capture or Kill).
 
* <code>/pixeleventadmin reload</code> (or <code>/pea reload</code>): Reload the config and the lang file.
 
* <code>/pixeleventadmin reload</code> (or <code>/pea reload</code>): Reload the config and the lang file.
−
* <code>/pixeleventadmin debug</code> (or <code>/pea debug</code>): This command will tell you if your config is setup correctly, else it tells you the error in the config.
+
* <code>/pixeleventadmin info</code> (or <code>/pea info</code>): See how the config is actually set.
−
* <code>/pixeleventadmin addclaim</code> (or <code>/pea addclaim</code>): When doing this in a claim, add the claim into the whitelist.
+
* <code>/pixeleventadmin check</code> (or <code>/pea check</code>): This command will tell you if your config is setup correctly, else it tells you the error in the config.
−
* <code>/pixeleventadmin removeclaim</code> (or <code>/pea removeclaim</code>): When doing this in a claim, remove the claim of the whitelist
+
* <code>/pixeleventadmin addclaimwhitelist</code> (or <code>/pea addclaimwhitelist</code>): When doing this in a claim, add the claim into the whitelist.
−
* <code>/pixeleventadmin config</code> (or <code>/pea config</code>): Do this command for easy setup of the config, you can click on the text to valide your choice.
+
* <code>/pixeleventadmin removeclaimwhitelist</code> (or <code>/pea removeclaimwhitelist</code>): When doing this in a claim, remove the claim of the whitelist.
 +
* <code>/pixeleventadmin addclaimblacklist</code> (or <code>/pea addclaimblacklist</code>): When doing this in a claim, add the claim into the blacklist.
 +
* <code>/pixeleventadmin removeclaimblacklist</code> (or <code>/pea removeclaimblacklist</code>): When doing this in a claim, remove the claim of the blacklist.
 
* <code>/pear</code> : Change the config to do random event. You can add -capture to force event to be Capture, -kill and if you put -pokemon/-ball/-type it will force the option to be "all".
 
* <code>/pear</code> : Change the config to do random event. You can add -capture to force event to be Capture, -kill and if you put -pokemon/-ball/-type it will force the option to be "all".
  
Line 49: Line 57:
 
*<code>/pixeleventadmin</code>: <code>pixelevent.command.pixeleventadmin</code>
 
*<code>/pixeleventadmin</code>: <code>pixelevent.command.pixeleventadmin</code>
 
*<code>/pixelevent leaderboard</code> (To bypass the config during the event): <code>pixelevent.command.leaderboard</code>
 
*<code>/pixelevent leaderboard</code> (To bypass the config during the event): <code>pixelevent.command.leaderboard</code>
 +
*<code>/pear</code>: <code>pixelevent.command.pixeleventadminrandom</code>
  
 
==Configuration==
 
==Configuration==
 +
I highly recommand to use the /pea <configname> (like /pea type) to change the config through the GUI.
 
===General configuration===
 
===General configuration===
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
Line 56: Line 66:
 
!Option
 
!Option
 
!Description
 
!Description
−
!Default value
 
 
|-  
 
|-  
 
|timer
 
|timer
−
|Set the timer of the event in minute.
+
|Set the timer of the event in minutes.
−
|5
 
 
|-
 
|-
 
|event
 
|event
 
|Type of event (Capture or Kill).
 
|Type of event (Capture or Kill).
−
|Capture
 
 
|-
 
|-
 
|name
 
|name
−
|Name of the pokemon.
+
|Name of the Pokémon (set all for any pokemon).
−
|All (That's mean every pokemon count for the event specified)
+
|-
 +
|type whitelist
 +
|Type of the Pokémon that players need to capture/kill.
 +
|-
 +
|type blacklist
 +
|Type of the Pokémon that players can't capture/kill.
 
|-
 
|-
−
|type
+
|ball whitelist
−
|Type of the pokemon.
+
|Type of the ball players need to use for the capture event.
−
|All (That's mean every type count for the event specified)
 
 
|-
 
|-
−
|ball
+
|ball blacklist
−
|Type of the ball.
+
|Type of the ball players can't use for the capture event.
−
|All (That's mean every ball count for the event specified)
 
 
|-
 
|-
 
|leaderboard
 
|leaderboard
 
|Set true to allow users to do /leaderboard during the event.
 
|Set true to allow users to do /leaderboard during the event.
−
|false
 
 
|-
 
|-
 
|enablebossbar
 
|enablebossbar
−
|Set true to display bossbar during the event.
+
|Set true to display boss bar during the event.
−
|false
+
|-
 +
|goal
 +
|Set a value to set the goal value, if player reach it, the event is stopped, set 0 to use the time only.
 
|}
 
|}
  
Line 92: Line 103:
 
!Option
 
!Option
 
!Description
 
!Description
−
!Default value
 
 
|-  
 
|-  
 
|allowclaim
 
|allowclaim
−
|Set to true to allow event work in all claim.
+
|Set to true to allow the event to work in all claims.
−
|false
 
 
|-
 
|-
 
|allowwilderness
 
|allowwilderness
−
|Set to true to allow event work in wilderness.
+
|Set to true to allow the event to work in the wilderness.
−
|true
 
 
|-
 
|-
−
|enableclaim
+
|whitelistclaim
−
|Set this to allow custom claim to work for the event.
+
|List of claim UUIDs that you want to make the event work in.
−
|false
 
 
|-
 
|-
−
|whitelistclaim
+
|blacklistclaim
−
|List of claim uuid that you want to make it work.
+
|List of claim UUIDs that you want to make the event won't work.
−
|Empty list.
 
 
|-
 
|-
 
|}
 
|}
Line 116: Line 122:
 
|-
 
|-
 
!Option
 
!Option
−
!Description
+
!Description (Add kill; or capture; above a command to give specific reward depend of Capture or Kill event)
−
!Default value
+
!Example
 
|-  
 
|-  
 
|rewardfirst
 
|rewardfirst
−
|Reward cmd for the winner.
+
|Reward cmd for the winner.  
−
|give %player% minecraft:diamond 20
+
|capture;give %player% minecraft:diamond 20
 
|-
 
|-
 
|rewardsecond
 
|rewardsecond
 
|Reward cmd for the second player.
 
|Reward cmd for the second player.
−
|give %player% minecraft:diamond 15
+
|kill;give %player% minecraft:diamond 15
 
|-
 
|-
 
|rewardthirth
 
|rewardthirth
−
|Reward cmd for the thirth player.
+
|Reward cmd for the third player.
 
|give %player% minecraft:diamond 10
 
|give %player% minecraft:diamond 10
 
|-
 
|-
Line 140: Line 146:
 
|-
 
|-
 
|rewardplaying
 
|rewardplaying
−
|Reward cmd for the all player that do the event/Not execute to the top 5.
+
|Reward cmd for the all players that do the event and get above the minimum score and that aren't in the top 5.
 
|give %player% minecraft:diamond 1
 
|give %player% minecraft:diamond 1
 
|-
 
|-
 
|minscorerewardplaying
 
|minscorerewardplaying
−
|Set how many point players must have to get the rewardplaying reward.
+
|How many points players must have to get the rewardplaying reward.
 
|10
 
|10
 +
|-
 +
|rewardlevel
 +
|Add reward for each level player will have. Format : amount;cmd.
 +
|Empty
 
|}
 
|}
  
 
===Lang configuration===
 
===Lang configuration===
−
You can edit message in the lang.cfg file.
+
You can edit messages in the <code>lang.cfg</code> file.
  
−
After saving, you can <code>/pea reload</code> to reload the lang !
+
After saving, you can <code>/pea reload</code> to reload the language file.
  
−
If you want to put color on your message, use color node <code>§</code>, exemple : <code>§aWell done !</code>
+
If you want to put color in your messages, use color node <code>§</code>, for example: <code>§aWell done!</code>
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
Line 172: Line 182:
 
|-
 
|-
 
|{mtimeleft}
 
|{mtimeleft}
−
|Remaining minute.
+
|Remaining minutes (bossbar).
 
|-
 
|-
 
|{stimeleft}
 
|{stimeleft}
−
|Remaining second.
+
|Remaining seconds (bossbar).
 
|-
 
|-
 
|{player}
 
|{player}
Line 182: Line 192:
 
|{score}
 
|{score}
 
|Score of the player.
 
|Score of the player.
 +
|-
 +
|{level}
 +
|Each level player will exceed.
 +
|-
 +
|{claimlistsize}
 +
|Claim list size for blacklist/whitelist.
 +
|-
 +
|{goal}
 +
|The goal value if different of 0.
 +
|-
 +
|{minutes} & {seconds}
 +
|Time remaining (GUI).
 
|}
 
|}
  
 
[[Category:Sidemods]]
 
[[Category:Sidemods]]

Latest revision as of 10:41, 27 February 2021

PixelEvent is a Pixelmon sidemod and Sponge plugin for creating custom events within a limited time, wherein players need to make a specific action (either capturing or defeating Pokémon) and are rewarded according to a leaderboard system. The specific actions and rewards are entirely customizable.

Installation

Minecraft version Pixelmon version PixelEvent version
1.12.2 8.1.0 7.3
1.12.2 7.0+ 7.2.1

PixelEvent is a Sponge plugin, which means it's only server-side. You need Pixelmon Mod, GriefPrevention or GriefDefender and SpongeForge to run it. Download the plugin jar and put it in the mods folder. Configuration can be found inside /config/PixelEvent after the server is first started with the plugin.

Usage

First, the config.cfg file needs to be edited to change the reward command (see reward module). To quickly create the event, you can use /pea config then follow the gui. You can check the existing settings using /pe info. Once you have finished configuring, start the event with /pea start.

Example events:

  • Defeat Rattata
  • Defeat a Water-type Pokémon
  • Capture a Fire-type Pokémon
  • Capture a Caterpie
  • Capture a Caterpie with an Ultra Ball
  • Capture a Water-type Pokémon with a Love Ball

Commands

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

Player commands

  • /pixelevent score (or /pe score) : Displays your score.
  • /pixelevent info (or /pe info) : Display all information about the event.
  • /pixelevent leaderboard (or /pe leaderboard) : Displays the leaderboard.
  • /pixelevent togglemsg (or /pe togglemsg) : Hide point message.

Staff commands

  • /pixeleventadmin discord (or /pea wiki): Send the Discord of the dev of this plugin.
  • /pixeleventadmin wiki (or /pea wiki): Sends the URL of this wiki page.
  • /pixeleventadmin config (or /pea config): Do this command for easy setup of the config with a GUI.
  • /pixeleventadmin start (or /pea start): Starts the event.
  • /pixeleventadmin stop (or /pea stop): Stops the event and cancels it (No reward).
  • /pixeleventadmin timer (or /pea timer): Changes the time for your event.
  • /pixeleventadmin ball (or /pea ball): Change balls settings for the Capture Event.
  • /pixeleventadmin setpokemon <Pokémon name/all> (or /pea setpokemon <Pokémon name/all>): Define a new Pokémon for the event (Magikarp etc or no restriction with 'all').
  • /pixeleventadmin type (or /pea type): Change types settings for the event (Water for example).
  • /pixeleventadmin event (or /pea event): Change the event (Capture or Kill).
  • /pixeleventadmin reload (or /pea reload): Reload the config and the lang file.
  • /pixeleventadmin info (or /pea info): See how the config is actually set.
  • /pixeleventadmin check (or /pea check): This command will tell you if your config is setup correctly, else it tells you the error in the config.
  • /pixeleventadmin addclaimwhitelist (or /pea addclaimwhitelist): When doing this in a claim, add the claim into the whitelist.
  • /pixeleventadmin removeclaimwhitelist (or /pea removeclaimwhitelist): When doing this in a claim, remove the claim of the whitelist.
  • /pixeleventadmin addclaimblacklist (or /pea addclaimblacklist): When doing this in a claim, add the claim into the blacklist.
  • /pixeleventadmin removeclaimblacklist (or /pea removeclaimblacklist): When doing this in a claim, remove the claim of the blacklist.
  • /pear : Change the config to do random event. You can add -capture to force event to be Capture, -kill and if you put -pokemon/-ball/-type it will force the option to be "all".

Permissions

Player nodes

  • /pixelevent: pixelevent.command.pixelevent

Staff nodes

  • /pixeleventadmin: pixelevent.command.pixeleventadmin
  • /pixelevent leaderboard (To bypass the config during the event): pixelevent.command.leaderboard
  • /pear: pixelevent.command.pixeleventadminrandom

Configuration

I highly recommand to use the /pea <configname> (like /pea type) to change the config through the GUI.

General configuration

Option Description
timer Set the timer of the event in minutes.
event Type of event (Capture or Kill).
name Name of the Pokémon (set all for any pokemon).
type whitelist Type of the Pokémon that players need to capture/kill.
type blacklist Type of the Pokémon that players can't capture/kill.
ball whitelist Type of the ball players need to use for the capture event.
ball blacklist Type of the ball players can't use for the capture event.
leaderboard Set true to allow users to do /leaderboard during the event.
enablebossbar Set true to display boss bar during the event.
goal Set a value to set the goal value, if player reach it, the event is stopped, set 0 to use the time only.

Area configuration

Option Description
allowclaim Set to true to allow the event to work in all claims.
allowwilderness Set to true to allow the event to work in the wilderness.
whitelistclaim List of claim UUIDs that you want to make the event work in.
blacklistclaim List of claim UUIDs that you want to make the event won't work.

Reward configuration

Option Description (Add kill; or capture; above a command to give specific reward depend of Capture or Kill event) Example
rewardfirst Reward cmd for the winner. capture;give %player% minecraft:diamond 20
rewardsecond Reward cmd for the second player. kill;give %player% minecraft:diamond 15
rewardthirth Reward cmd for the third player. give %player% minecraft:diamond 10
rewardfourth Reward cmd for the fourth player. give %player% minecraft:diamond 5
rewardfifth Reward cmd for the fifth player. give %player% minecraft:diamond 3
rewardplaying Reward cmd for the all players that do the event and get above the minimum score and that aren't in the top 5. give %player% minecraft:diamond 1
minscorerewardplaying How many points players must have to get the rewardplaying reward. 10
rewardlevel Add reward for each level player will have. Format : amount;cmd. Empty

Lang configuration

You can edit messages in the lang.cfg file.

After saving, you can /pea reload to reload the language file.

If you want to put color in your messages, use color node §, for example: §aWell done!

Placeholder Description
{event} Replaced by capture/kill.
{pokemon} Name of the Pokémon.
{type} Type of the Pokémon.
{ball} Name of the ball.
{mtimeleft} Remaining minutes (bossbar).
{stimeleft} Remaining seconds (bossbar).
{player} Player's name.
{score} Score of the player.
{level} Each level player will exceed.
{claimlistsize} Claim list size for blacklist/whitelist.
{goal} The goal value if different of 0.
{minutes} & {seconds} Time remaining (GUI).
Retrieved from "http://pixelmonmod.com/w/index.php?title=PixelEvent&oldid=83867"
Powered by MediaWiki

© 2012 - 2025 Pixelmon Mod