|
|
Line 1: |
Line 1: |
− | PixelHunt Remastered is a [[Pixelmon]] [[sidemod]] that starts and maintains random Pokémon hunts. Each hunt will have specific requirements that the caught Pokémon must meet in order for a player to claim rewards. Requirements and rewards must be configured. Once a hunt is completed, a broadcasted message will show everybody who completed it and a new hunt will automatically begin.
| + | #REDIRECT [[PixelHunt Remastered]] |
− | | |
− | ==Installation==
| |
− | {{SidemodVersionh}}
| |
− | {{SidemodVersion|1.12.2|8.3.3|2.0.0}}
| |
− | {{SidemodVersionf}}
| |
− | | |
− | ====Servers====
| |
− | # Download PixelHuntRemastered 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 <code>config/PixelHuntRemastered</code> and edit the file as desired. | |
− | # Either restart the server or use the <code>/hunt reload</code> command (see commands section for more detail) to load any changes made.
| |
− | | |
− | ====Clients====
| |
− | # Download PixelHuntRemastered for your version of Minecraft/Pixelmon [https://pixelmonmod.com/downloads.php here].
| |
− | # Place the downloaded <code>.jar</code> in the game's ''mods'' folder.
| |
− | # Start the server and wait for it to load.
| |
− | # Open the configuration folder in the game's <code>.minecraft/config/PixelHuntRemastered</code> and edit the file as desired.
| |
− | # Either restart the server or use the <code>/hunt reload</code> command (see commands section for more detail) 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 [https://minecraft.fandom.com/wiki/Commands#Command_Guide here].''
| |
− | ====Player commands====
| |
− | * <code>/hunt</code> (Aliases: <code>/pixelhunt</code>, <code>/pokemonhunt</code>) : This is the Main Command that opens the PixelHunt UI.
| |
− | | |
− | ====Staff commands====
| |
− | * <code>/hunt reload</code> : This command reloads the configuration and all active hunts.
| |
− | | |
− | ==Permissions==
| |
− | *<code>/hunt</code> : There are no required permissions for this default command.
| |
− | *<code>/hunt reload</code> : <code>pixel.hunt.remastered.command.reload</code>
| |
− | | |
− | | |
− | ==Configuration==
| |
− | ''Note: The configuration file is a <code>.yml</code> file - It can be [http://www.yamllint.com/ validated here] when making significant changes.''
| |
− | | |
− | ====Config File====
| |
− | The <code>config.yml</code> contains all of the information for the PixelHunt UI, Broadcasts, Duration, Rewards and more. Fields that don't have a default value must be added into the config. An <span style="color: darkorange; font-weight: 600">example config</span> can be ''[https://pastebin.com/pQDVMvdR found here]''.
| |
− | | |
− | <code>config-interface:</code> - Contains information describing the appearance of the PixelHunt UI.
| |
− | : <code>title:</code> - The title of the PixelHunt GUI. Supports color codes. <span style="color: lightseagreen; font-weight: 600">Default:</span> <code><nowiki>''</nowiki></code>
| |
− | : <code>height:</code> - The height of the PixelHunt GUI (Number of rows). <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>6</code>
| |
− | : <code>fill-type:</code> - The type of background item fill of the PixelHunt GUI. There are 4 types: <code>BLOCK</code>, <code>ALTERNATING</code>, <code>CHECKERED</code> and <code>CUSTOM</code>. Descriptions of these can be ''[https://github.com/Daniel-Forge-Development/API/wiki/GUI-Settings found here]''. <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>BLOCK</code>
| |
− | : <code>filler-items:</code> - The items used to fill the background of the GUI are under this section, found below.
| |
− | :: <code>one:</code> - The first item in the selection that will be used.
| |
− | ::: <code>enabled:</code> - Whether or not this item is enabled and will show in the UI. <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>true</code>
| |
− | ::: <code>type:</code> - The ID of the item. <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>minecraft:stained_glass_pane</code>
| |
− | ::: <code>amount:</code> - The amount of the item. <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>1</code>
| |
− | ::: <code>damage:</code> - The item meta of the item in the slot. This is usually <code>0</code>. However, in this case, setting it to <code>14</code> will show a <span style="color: red">Red</span> Stained Glass Pane. <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>14</code>
| |
− | ::: <code>name:</code> - The name of the item. Supports color codes. <span style="color: lightseagreen; font-weight: 600">Default:</span> <code><nowiki>' '</nowiki></code>
| |
− | ::: <code>lore:</code> - The lore of the item. Supports color codes.
| |
− | <code>spawn-broadcast:</code> - The broadcasts that are sent to all online players when a new hunt is started. Supports color codes. <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>[]</code><br>
| |
− | <code>timeout-broadcast:</code> - The broadcasts to send to all online players when the hunt ends (no one found it). Supports color codes. <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>[]</code><br>
| |
− | <code>extra-lore:</code> - Adds extra lore to the sprite. Supports color codes and <code>%time%</code> placeholder.<br>
| |
− | <code>pre-lore:</code> - Adds extra lore to the sprite. Supports color codes and %time% placeholder.<br>
| |
− | <code>enable-particles:</code> - Whether or not fire particles will show on the hunted species. <span style="color: lightseagreen; font-weight: 600">Default:</span> <code>true</code><br>
| |
− | <code>hunts:</code> - The section that defines all the different difficulties or types of hunts.
| |
− | : <code>Easy:</code> - The name of the hunt. This can be named anything and will not appear in the UI.
| |
− | :: <code>gui-x:</code> - The X position the display will take in the GUI.
| |
− | :: <code>gui-y:</code> - The Y position the display will take in the GUI.
| |
− | :: <code>random-commands:</code> - If the reward command given on capture is randomly selected from the <code>reward-commands</code> (if false all commands are executed).
| |
− | :: <code>reward-commands:</code> - The commands to reward the player after capturing the Pokémon.
| |
− | :: <code>reward-description:</code> - The description of the rewards shown in the lore of the display. Supports color codes.
| |
− | :: <code>max-ivs:</code> - Whether or not the IVs of the Pokémon should be maxed out when caught.
| |
− | :: <code>iv-multiplier-enabled:</code> - Whether or not the IVs of the Pokémon should be multiplied when caught.
| |
− | :: <code>iv-multiplier:</code> - The multiplier if the above is true. <code>1.5</code> would increase the IVs by 50%.
| |
− | :: <code>max-duration-minutes:</code> - The amount of time before the hunt times out and a new one is started.
| |
− | :: <code>generator-config:</code> - Contains any settings for the hunt.
| |
− | ::: <code>blocked-types:</code> - Species that will never appear in the hunt.
| |
− | ::: <code>species-requirement:</code> - If the Pokémon species is required for the hunt. Should '''always''' be <code>true</code>.
| |
− | ::: <code>allow-legends:</code> - If [[Legendaries]] should appear in this hunt (typically <code>false</code> otherwise incredibly difficult).
| |
− | ::: <code>allow-ultra-beasts:</code> - If [[Ultra Beasts]] should appear in this difficulty (typically <code>false</code> otherwise a bit more difficult)
| |
− | ::: <code>gender-requirement:</code> - If a specific gender should be required.
| |
− | ::: <code>growth-requirement:</code> - If a specified growth (or number of growths) should be required.
| |
− | ::: <code>nature-requirement:</code> - If the nature (or natures) should be required.
| |
− | ::: <code>potential-growth-requirements:</code> - Number of growths to require.
| |
− | ::: <code>potential-nature-requirements:</code> - Number of natures to require.
| |
− | ::: <code>allow-evolutions:</code> - If evolutions of the species are allowed (true = easier).
| |
− | ::: <code>iv-requirement:</code> - If an IV percentage should be required.
| |
− | ::: <code>random-i-v-generation:</code> - If the IV percentage should be randomly generated.
| |
− | ::: <code>min-i-v-percentage:</code> - The minimum IV value.
| |
− | ::: <code>max-i-v-percentage:</code> - The maximum IV value.
| |
− | ::: <code>only-legends:</code> - Whether or not the hunt will only require [[Legendaries]].
| |
− | | |
− | == Version history ==
| |
− | There is no version history available for this sidemod just yet.
| |
− | | |
− | [[Category:Sidemods]]
| |