Difference between revisions of "Wonder Trade"

Latest revision as of 13:22, 6 February 2022

Wonder Trade is a Pixelmon sidemod that is loosely based on the Wonder Trade feature from Pokémon X and Pokémon Y.

Installation

Minecraft version	Pixelmon version	Wonder Trade version
1.12.2	8.3.4+	5.2.0
1.12.2	8.3.3	4.6.4
1.12.2	8.3.1+	4.6.3
1.12.2	7.0.2+	4.6.2
1.12.2	6.2+	4.5.2
1.10.2	5.0-5.1	4.4.6
1.8.9	4.3	4.3.3

WonderTrade is a Forge sidemod, meaning it can be installed on different types of servers that support mods, such as Sponge or Mohist/Magma. An SQL database is required for the sidemod to function along with Placeholder API. Guides for setting up an SQL database locally can be found here and here. If you are hosting your server through a server host, they may be able to provide you with one. It is recommended to contact them or read their documentation regarding this. Wonder Trade is server-side and does not need to be installed by each individual player to be used. The SQL database information should be entered in the config.yml file.

Servers

Download Wonder Trade for your version of Minecraft here.
Place the downloaded jar file in the servers mods folder of your server directory.
Start the server and wait for it to load
Open the configuration folder in the servers config/WondertradeForge folder and edit the files as desired
Restart the server to apply any changes made.

Overview

Wonder Trade generates a "pool" of Pokémon that will be swapped for specified Pokémon in players' parties if they choose to conduct a wonder trade. This pool consists of a specified number of Pokémon that can be modified in Wonder Trade's config file (config.yml). The Pokémon generated in this pool are completely random and not affected by the normal rarities of Pokémon in the wild, meaning that Pokémon normally unobtainable in the wild can be in the wonder trade pool. Legendary Pokémon and Shiny Pokémon may also be generated in the pool. The chance for a Shiny Pokémon to appear in the pool is also configurable in the config.

A player conducting a wonder trade will receive a random Pokémon from the pool in exchange for a specified Pokémon from the player's party. The Pokémon that the player trades away will then be placed in the pool, making it possible for other players to possibly receive this Pokémon from their own wonder trades. Per player, a wonder trade can only be done once within a certain time interval (1 hour by default) that can be changed in the config file. If a player receives or gives away a Legendary or shiny Pokémon on Wonder Trade, a server-wide message will be shown advertising this and encouraging players to try wonder trading. This and all other Wonder Trade messages can be modified through the locale file or turned off in the config file.

Commands

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

/wt (Aliases: /wondertrade): This command will open up the Wondertrade GUI if the player has no cooldown. This has no permission node.
/reload: This command will reload the configuration (and locale) values.
/regenpool (Aliases: /rp: This command can be used to generate the WonderTrade pool of Pokemon using the default generation settings
/resetcooldown <player> (Aliases: /rc): This command will reset the targetted user's WonderTrade cooldown
/admin (Aliases: /view, /adminview, av): This command will open up the WonderTrade pool via the GUI

Permission nodes

wonder.trade.command.reload: Allows use of the /reload command.
wonder.trade.command.regenerate.pool: Allows use of the /regenpool command.
wonder.trade.command.reset.cooldown: Allows the use of the /resetcooldown command.
wonder.trade.forge.command.admin: Allows the use of the /admin command.

Config File

Note: The configuration file is a .yml file - It can be validated here when making significant changes.

The config.yml contains all of the settings for WonderTrade including broadcast settings, generator settings, database details, and pool details.

broadcast-settings:

always-broadcast: - Always broadcast regardless of what the pokemon specs are. Default: true

broadcast-legends - Broadcast if the pokemon is a legend (will broadcast anyway if aways-broadcast is true) Default: true

broadcast-ultra-beasts: - Broadcast if the pokemon is an ultra beast (will broadcast anyway if aways-broadcast is true) Default: true

broadcast-shinies: - Broadcast if the pokemon is shiny (will broadcast anyway if aways-broadcast is true) Default: true

default-generator-settings:

blocked-types: - List of blocked pokemon Default: Hoopa

allow-legends: - Should legends generate in the pool Default: true

allow-ultra-beasts: - Should ultra beasts generate in the pool Default: true

shiny-chance: - Chance of a shiny appearing in the pool Default: 0.05

database-details - SQL database login for saving user data

pool-name - The name identifier of the database (Default value recommended) Default: WonderTrade

ip: - The IP of the database (Must add your own)

port: - The port of the datavase (Should stay as default) Default: 3306

username: - The username of the database (Must add your own)

password: - The password of the database (Must add your own)

database: - Name of the database (Must add your own)

cooldown-seconds - The user cooldown in seconds Default: 3600
min-required-level - The min level required to trade with WonderTrade Default: 30
number-in-pool - Number of Pokemon in pool Default: 30
persistent-pool - If the pool should stay after the server reboots Default: true

Locale Config

Note: The configuration file is a .yml file - It can be validated here when making significant changes.

The local.yml file contains all messages used by WonderTrade and can be changed to your liking.

For all chat messages, '&' color formatting works. For example, "&2" will create green text. Additionally, leaving a message blank in the config will disable that message.

pokemon-broadcast: - What to broadcast when a Pokemon is added to WonderTrade
shiny-replacement: - Text to show if Pokemon added is a SHINY
ultra-beast-replacement: - Text to show if Pokemon added is an Ultra beast
legend-replacement: - Text to show if Pokemon added is a legendary
trade-successful: - Message sent to player when they complete the trade
cooldown-message: - Message sent to the player when on cooldown

Sample Locale Config

pokemon-broadcast:
- ' '
- '&e%forge_name%&7 added a &e%is_shiny%%is_ultra_beast%%is_legend%&b%pokemon%&7 to the &b&lWonderTrade'
- ' '
shiny-replacement: 'Shiny '
ultra-beast-replacement: 'UltraBeast '
legend-replacement: 'Legend '
trade-successful: '&e&l(!) &eWonderTrade was successful! Check your party to see what
    you got'
cooldown-message: '&c&l(!) &cYou cannot use the WonderTrade yet. You''re still on
    cooldown'

Version history

Version history/Wonder Trade

@@ Line 1: / Line 1: @@
-Wonder Trade is a Pixelmon sidemod that is loosely based on the Wonder Trade feature from ''Pokémon X and Y''.
+Wonder Trade is a [[Pixelmon]] [[sidemod]] that is loosely based on the Wonder Trade feature from ''Pokémon X'' and ''Pokémon  Y''.
 ==Installation==
-Any version of Pixelmon from 3.1.1 upwards is compatible with this mod. On servers, the mod is server-side and does not need to be installed by each individual player to be used.
+{{SidemodVersionh}}
-===''Minecraft'' launcher===
+{{SidemodVersion|1.12.2|8.3.4+|5.2.0}}
-#Download Wonder Trade [http://pixelmonmod.com/downloads.php here].
+{{SidemodVersion|1.12.2|8.3.3|4.6.4}}
-#Place the downloaded jar file in the mods folder.
+{{SidemodVersion|1.12.2|8.3.1+|4.6.3}}
-===[[Pixelmon launcher]]===
+{{SidemodVersion|1.12.2|7.0.2+|4.6.2}}
-#Edit your profile and choose the "Add Official Sidemod" option.
+{{SidemodVersion|1.12.2|6.2+|4.5.2}}
-#Select Wonder Trade from the list.
+{{SidemodVersion|1.10.2|5.0-5.1|4.4.6}}
+{{SidemodVersion|1.8.9|4.3|4.3.3}}
+{{SidemodVersionf}}
+WonderTrade is a Forge sidemod, meaning it can be installed on different types of servers that support mods, such as Sponge or Mohist/Magma. '''An SQL database is required for the sidemod to function along with Placeholder API'''. Guides for setting up an SQL database locally can be found [https://dev.mysql.com/doc/mysql-getting-started/en/ here] and [https://docs.oracle.com/en/java/java-components/advanced-management-console/2.22/install-guide/mysql-database-installation-and-configuration-advanced-management-console.html#JSAMI-GUID-12323233-07E3-45C2-B77A-F35B3BBA6592 here]. If you are hosting your server through a server host, they may be able to provide you with one. It is recommended to contact them or read their documentation regarding this. Wonder Trade is server-side and does not need to be installed by each individual player to be used. The SQL database information should be entered in the <code>config.yml</code> file.
+===Servers===
+#Download Wonder Trade for your version of ''Minecraft'' [https://pixelmonmod.com/downloads.php here].
+#Place the downloaded jar file in the servers mods folder of your server directory.
+#Start the server and wait for it to load
+#Open the configuration folder in the servers <code>config/WondertradeForge</code> folder and edit the files as desired
+#Restart the server to apply any changes made.
 ==Overview==
-Wonder Trade generates a "pool" of Pokémon that will be swapped for specified Pokémon in players' parties if they choose to conduct a wonder trade. This pool consists of a specified number of Pokémon that can be modified in Wonder Trade's config file (wondertrade.cfg). The Pokémon generated in this pool are completely random and not affected by the normal rarities of Pokémon in the wild, meaning that Pokémon normally unobtainable in the wild can be in the wonder trade pool. [[Legendary Pokémon]] and [[Shiny Pokémon]] may also be generated in the pool. The chance of a Legendary Pokémon being generated can be modified in the Wonder Trade config file, while the Shiny Pokémon generation rate is based on the rate set in the Pixelmon [[config]] file. The levels of the Pokémon in the pool are all between a shared level range (and not each Pokémon's regular wild level range) that can also be modified in the Wonder Trade config file.
+Wonder Trade generates a "pool" of Pokémon that will be swapped for specified Pokémon in players' parties if they choose to conduct a wonder trade. This pool consists of a specified number of Pokémon that can be modified in Wonder Trade's config file (config.yml). The Pokémon generated in this pool are completely random and not affected by the normal rarities of Pokémon in the wild, meaning that Pokémon normally unobtainable in the wild can be in the wonder trade pool. [[Legendary Pokémon]] and [[Shiny Pokémon]] may also be generated in the pool. The chance for a [[Shiny]] Pokémon to appear in the pool is also configurable in the config.
-A player conducting wonder trades will receive a random Pokémon from the pool in exchange for a specified Pokémon from the player's party. The Pokémon that the player trades away will then be placed in the pool, making it possible for other players to possibly receive this Pokémon from their own wonder trades. Per player, a wonder trade can only be done once within a certain time interval (1 hour by default) that can be changed in the config file. Additionally, it is possible to set a default cool-down for specific players using the /wtsetcooldown command, with this time overriding the global default. If a player receives or gives away a Legendary or shiny Pokémon on Wonder Trade, a server-wide message will be shown advertising this and encouraging players to try wonder trading. This and all other Wonder Trade messages can be modified or turned off through the Wonder Trade config file.
+A player conducting a wonder trade will receive a random Pokémon from the pool in exchange for a specified Pokémon from the player's party. The Pokémon that the player trades away will then be placed in the pool, making it possible for other players to possibly receive this Pokémon from their own wonder trades. Per player, a wonder trade can only be done once within a certain time interval (1 hour by default) that can be changed in the config file. If a player receives or gives away a Legendary or shiny Pokémon on Wonder Trade, a server-wide message will be shown advertising this and encouraging players to try wonder trading. This and all other Wonder Trade messages can be modified through the locale file or turned off in the config file.
 ==Commands==
 {{CommandSyntax}}
-*/wt <slot>: This command will warn the player that use of Wonder Trade will take away specified Pokémon and replace them with other Pokémon. It will then prompt the player to use the command "/wt <slot> confirm". "/wondertrade" can also be used to invoke this command.
+*<code>/wt</code> (Aliases: <code>/wondertrade</code>): This command will open up the Wondertrade GUI if the player has no cooldown. This has no permission node.
-**/wt <slot> confirm: This command will conduct a wonder trade with the Pokémon in the specified party slot. If the slot used is not the same as that used in /wt <slot>, the trade will not occur.
+*<code>/reload</code>: This command will reload the configuration (and locale) values.
-*/wtadmin add <Pokémon> [s]: This command will add a randomly generated instance of the specified Pokémon to the pool. The optional parameter ''s'' will make the Pokémon [[Shiny]] and can be omitted. If the Pokémon added is Shiny or [[Legendary]], a server-side broadcast will appear stating that the player has added a Shiny or Legendary Pokémon to the pool. As the pool is a constant size, adding new Pokémon will delete other Pokémon from the pool.
+*<code>/regenpool</code> (Aliases: <code>/rp</code>: This command can be used to generate the WonderTrade pool of Pokemon using the default generation settings
-*/wtadmin delete <Pokémon>: This command will remove all Pokémon in the pool that are of the specified Pokémon species. Randomly generated Pokémon will replace the removed Pokémon.
+*<code>/resetcooldown <''player''></code> (Aliases: <code>/rc</code>): This command will reset the targetted user's WonderTrade cooldown
-*/wtadmin purge: This command will remove all Pokémon from the pool and randomly generate an entirely new pool of Pokémon.
+*<code>/admin</code> (Aliases: <code>/view</code>, <code>/adminview</code>, <code>av</code>): This command will open up the WonderTrade pool via the GUI
-*/wtadmin list: This command will show a list of all Pokémon in the pool along with their levels and whether or not they are Shiny.
-*/wtadmin print: This command will display a server-wide message that advertises Wonder Trade, showing how many Pokémon are in the pool and (if applicable) how many Shiny Pokémon and Legendary Pokémon are in the pool.
-*/wtsetcooldown <player> <minutes>: This command will set the cool-down after wonder trading for the specified player to the specified number of minutes. This will override the global default in the config.
 ===Permission nodes===
-====Bukkit====
+*<code>wonder.trade.command.reload</code>: Allows use of the <code>/reload</code> command.
-*/wt: com.wondertrademod.wondertrade.commands.WonderTrade
+*<code>wonder.trade.command.regenerate.pool</code>: Allows use of the <code>/regenpool</code> command.
-*/wtadmin: com.wondertrademod.wondertrade.commands.WonderTradeAdmin
+*<code>wonder.trade.command.reset.cooldown</code>: Allows the use of the <code>/resetcooldown</code> command.
-====Sponge====
+*<code>wonder.trade.forge.command.admin</code>: Allows the use of the <code>/admin</code> command.
-*/wt: wondertrade.command.wondertrade
-*/wtadmin: wondertrade.command.wtadmin
+==Config File==
-*/wtsetcooldown: wondertrade.command.wtsetcooldown
+''Note: The configuration file is a <code>.yml</code> file - It can be [http://www.yamllint.com/ validated here] when making significant changes.''
+The <code>config.yml</code> contains all of the settings for WonderTrade including broadcast settings, generator settings, database details, and pool details.
+<code>broadcast-settings:</code>
+:<code>always-broadcast:</code> - Always broadcast regardless of what the pokemon specs are. <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>true</code>
+:<code>broadcast-legends</code> - Broadcast if the pokemon is a legend (will broadcast anyway if aways-broadcast is true) <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>true</code>
+:<code>broadcast-ultra-beasts:</code> - Broadcast if the pokemon is an ultra beast (will broadcast anyway if aways-broadcast is true) <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>true</code>
+:<code>broadcast-shinies:</code> - Broadcast if the pokemon is shiny (will broadcast anyway if aways-broadcast is true) <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>true</code>
+<code>default-generator-settings:</code>
+:<code>blocked-types:</code> - List of blocked pokemon <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>Hoopa</code>
+:<code>allow-legends:</code> - Should legends generate in the pool <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>true</code>
+:<code>allow-ultra-beasts:</code> - Should ultra beasts generate in the pool <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>true</code>
+:<code>shiny-chance:</code> - Chance of a shiny appearing in the pool <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>0.05</code>
+<code>database-details</code> - SQL database login for saving user data
+:<code>pool-name</code> -  The name identifier of the database (Default value recommended) <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>WonderTrade</code>
+:<code>ip:</code> - The IP of the database (Must add your own)
+:<code>port:</code> - The port of the datavase (Should stay as default) <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>3306</code>
+:<code>username:</code> - The username of the database (Must add your own)
+:<code>password:</code> - The password of the database (Must add your own)
+:<code>database:</code> - Name of the database (Must add your own)
+<code>cooldown-seconds</code> - The user cooldown in seconds <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>3600</code> <br>
+<code>min-required-level</code> - The min level required to trade with WonderTrade <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>30</code> <br>
+<code>number-in-pool</code> - Number of Pokemon in pool <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>30</code> <br>
+<code>persistent-pool</code> - If the pool should stay after the server reboots <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>true</code> <br>
+==Locale Config==
+''Note: The configuration file is a <code>.yml</code> file - It can be [http://www.yamllint.com/ validated here] when making significant changes.''
+The <code>local.yml</code> file contains all messages used by WonderTrade and can be changed to your liking.
+For all chat messages, '&' color formatting works. For example, "&2" will create green text. Additionally, leaving a message blank in the config will disable that message.
+<code>pokemon-broadcast:</code> - What to broadcast when a Pokemon is added to WonderTrade<br>
+<code>shiny-replacement:</code> - Text to show if Pokemon added is a SHINY <br>
+<code>ultra-beast-replacement:</code> - Text to show if Pokemon added is an Ultra beast <br>
+<code>legend-replacement:</code> - Text to show if Pokemon added is a legendary <br>
+<code>trade-successful:</code> - Message sent to player when they complete the trade <br>
+<code>cooldown-message:</code> - Message sent to the player when on cooldown <br>
+'''Sample Locale Config'''
+ <nowiki>
+pokemon-broadcast:
+- ' '
+- '&e%forge_name%&7 added a &e%is_shiny%%is_ultra_beast%%is_legend%&b%pokemon%&7 to the &b&lWonderTrade'
+- ' '
+shiny-replacement: 'Shiny '
+ultra-beast-replacement: 'UltraBeast '
+legend-replacement: 'Legend '
+trade-successful: '&e&l(!) &eWonderTrade was successful! Check your party to see what
+    you got'
+cooldown-message: '&c&l(!) &cYou cannot use the WonderTrade yet. You''re still on
+    cooldown'</nowiki>
-==Config settings==
-===General settings===
-*Time Between Announcements: Time (in minutes) between messages advertising wonder trade, showing how many Pokémon are in the pool and how many [[Shiny Pokémon]] and [[Legendary Pokémon]] are in the pool. The announcement can also be manually invoked with the "/wtadmin print" command.
-*Time Between Uses: How often, in minutes, an individual player is allowed to wonder trade.
-*Chance of Legendary in pool: Chance ({{frac|''x''}}) of a [[Legendary Pokémon]] being randomly generated in the pool (10,000 by default). Setting this field to 0 prevents  Legendary Pokémon from being generated in the pool. This does not affect players that deposit their own Legendary Pokémon into the pool.
-*Min Level/Max Level: Minimum and maximum level that a randomly generated Pokémon in the pool can be. Pokémon inserted into the pool by players are not affected by this level range (5-40 by default).
-*Pool Size: How many Pokémon are in the pool at a time. This number is consistent and the pool will adjust to /wtadmin deletion and addition commands by removing Pokémon from the pool or adding Pokémon to the pool.
-===Chat message settings===
+==Version history==
-For all chat messages, '&' color formatting works. For example, "&2" will create green text. Additionally, leaving a message blank in the config will disable that message. Line breaks can be added using "::" (e.g., "This is the first line::This is the second line").
+[[Version history/Wonder Trade]]
-*Announcer message: The message announced every interval.
+[[Category:Sidemods]]
-*Current pool message: The message sent after the main announcer message. Any occurrences of "POOLSIZE" in the message will be replaced in chat messages with the pool size.
-*Global legendary received message: The global message sent when a player receives a [[Legendary Pokémon]]. "PLAYERNAME" and"POKEMONNAME" will be replaced with the recipient and Legendary Pokémon names (respectively) in chat.
-*Global shiny received message: The global message sent when a player receives a [[Shiny Pokémon]]. "PLAYERNAME" and "POKEMONNAME" will be replaced with the recipient and Shiny Pokémon names (respectively) in chat.
-*Legendaries in pool message: The message following the announcer which declares how many [[Legendary Pokémon]] are in the pool. "LEGENDARYCOUNT" will be replaced with the number, and "ISARE" will be replaced with either "is'' or "are" to be grammatically correct for the number of Legendary Pokémon.
-*Legendary added to pool message: The global message displayed when a player adds a [[Legendary Pokémon]] to the pool. "PLAYERNAME" will be replaced with the player's name, and "POKEMONNAME" will be replaced with the name of the Legendary Pokémon being added.
-*Personal shiny received message: Message sent to specific players upon receiving a [[Shiny Pokémon]]. "POKEMONNAME" will be replaced with the Pokémon received.
-*Received from WT message: Message sent to specific players upon receiving a Pokémon from Wonder Trade. "POKEMONNAME" will be replaced with the name of the Pokémon received.
-*Shinies in pool message: The message following the announcer which declares how many [[Shiny Pokémon]] are in the pool. "SHINYCOUNT" will be replaced with the number, and "ISARE" will be replaced with either "is" or "are" to be grammatically correct for the number of Shiny Pokémon.
-*Shiny added to pool message: The global message displayed when a player adds a [[Shiny Pokémon]] to the pool. "PLAYERNAME" will be replaced with the player's name, and "POKEMONNAME" will be replaced with the name of the Shiny Pokémon being added.
-*Try your luck message: Final message of the announcer.

Difference between revisions of "Wonder Trade"

Difference between revisions of "Wonder Trade"

Latest revision as of 13:22, 6 February 2022

Contents

Installation

Servers

Overview

Commands

Permission nodes

Config File

Locale Config

Version history