Difference between revisions of "PixelHunt Remastered"
(Created page with "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 mee...") |
|||
Line 37: | Line 37: | ||
====Config File==== | ====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 | + | 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. |
<code>config-interface:</code> - Contains information describing the appearance of the PixelHunt UI. | <code>config-interface:</code> - Contains information describing the appearance of the PixelHunt UI. | ||
Line 83: | Line 83: | ||
::: <code>max-i-v-percentage:</code> - The maximum 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]]. | ::: <code>only-legends:</code> - Whether or not the hunt will only require [[Legendaries]]. | ||
+ | |||
+ | <div class="panel-group" id="anaccordion"> | ||
+ | <div class="panel panel-primary> | ||
+ | <div class="panel-heading"> | ||
+ | <h4 class="panel-title">Config Example</h4> | ||
+ | <div class="toccolours" data-target="#panel-1" data-toggle="collapse" style="display: inline; color: blue">Show/Hide</div> | ||
+ | </div> | ||
+ | <div class="panel-collapse collapse" id="panel-1"> | ||
+ | <div class="panel-body"> | ||
+ | <br> | ||
+ | config-interface: | ||
+ | title: '&2PixelHunt' | ||
+ | height: 6 | ||
+ | fill-type: BLOCK | ||
+ | filler-items: | ||
+ | one: | ||
+ | enabled: true | ||
+ | type: minecraft:stained_glass_pane | ||
+ | amount: 1 | ||
+ | damage: 14 | ||
+ | name: ' ' | ||
+ | lore: [] | ||
+ | nbt: {} | ||
+ | spawn-broadcast: | ||
+ | - '&eThe hunt for %pokemon% has started!' | ||
+ | timeout-broadcast: | ||
+ | - '&cThe hunt for %pokemon% has ended!' | ||
+ | extra-lore: | ||
+ | - '' | ||
+ | - '&bTime remaining: %time%' | ||
+ | pre-lore: | ||
+ | - '' | ||
+ | enable-particles: true | ||
+ | hunts: | ||
+ | Easy: | ||
+ | gui-x: 1 | ||
+ | gui-y: 1 | ||
+ | reward-commands: | ||
+ | - give %player% pixelmon:poke_ball 5 | ||
+ | reward-description: | ||
+ | - '&eReward: &c5 PokeBalls' | ||
+ | max-ivs: false | ||
+ | iv-multiplier-enabled: false | ||
+ | iv-multiplier: 1.5 | ||
+ | max-duration-minutes: 60 | ||
+ | generator-config: | ||
+ | blocked-types: | ||
+ | - Ditto | ||
+ | species-requirement: true | ||
+ | allow-legends: false | ||
+ | allow-ultra-beasts: false | ||
+ | gender-requirement: false | ||
+ | growth-requirement: false | ||
+ | nature-requirement: false | ||
+ | potential-growth-requirements: 3 | ||
+ | potential-nature-requirements: 3 | ||
+ | allow-evolutions: false | ||
+ | iv-requirement: false | ||
+ | random-i-v-generation: false | ||
+ | min-i-v-percentage: 30 | ||
+ | max-i-v-percentage: 100 | ||
+ | only-legends: false | ||
+ | random-commands: false | ||
+ | Easy2: | ||
+ | gui-x: 1 | ||
+ | gui-y: 2 | ||
+ | reward-commands: | ||
+ | - give %player% pixelmon:poke_ball 5 | ||
+ | reward-description: | ||
+ | - '&eReward: &c5 PokeBalls' | ||
+ | max-ivs: false | ||
+ | iv-multiplier-enabled: false | ||
+ | iv-multiplier: 1.5 | ||
+ | max-duration-minutes: 60 | ||
+ | generator-config: | ||
+ | blocked-types: | ||
+ | - Ditto | ||
+ | species-requirement: true | ||
+ | allow-legends: false | ||
+ | allow-ultra-beasts: false | ||
+ | gender-requirement: false | ||
+ | growth-requirement: false | ||
+ | nature-requirement: false | ||
+ | potential-growth-requirements: 3 | ||
+ | potential-nature-requirements: 3 | ||
+ | allow-evolutions: false | ||
+ | iv-requirement: false | ||
+ | random-i-v-generation: false | ||
+ | min-i-v-percentage: 30 | ||
+ | max-i-v-percentage: 100 | ||
+ | only-legends: false | ||
+ | random-commands: false | ||
+ | random-commands: false | ||
+ | </p> | ||
+ | </div> | ||
+ | </div> | ||
+ | </div> | ||
+ | </div> | ||
== Version history == | == Version history == |
Revision as of 12:09, 26 November 2021
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.
Contents
Installation
Minecraft version | Pixelmon version | PixelHunt Remastered version |
---|---|---|
1.12.2 | 8.3.3 | 2.0.0 |
Servers
- Download PixelHuntRemastered for your version of Minecraft/Pixelmon here.
- Place the downloaded
.jar
in the server's mods folder. - Start the server and wait for it to load.
- Open the configuration folder in the server's
config/PixelHuntRemastered
and edit the file as desired. - Either restart the server or use the
/hunt reload
command (see commands section for more detail) to load any changes made.
Clients
- Download PixelHuntRemastered for your version of Minecraft/Pixelmon here.
- Place the downloaded
.jar
in the game's mods folder. - Start the server and wait for it to load.
- Open the configuration folder in the game's
.minecraft/config/PixelHuntRemastered
and edit the file as desired. - Either restart the server or use the
/hunt reload
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 here.
Player commands
/hunt
(Aliases:/pixelhunt
,/pokemonhunt
) : This is the Main Command that opens the PixelHunt UI.
Staff commands
/hunt reload
: This command reloads the configuration and all active hunts.
Permissions
/hunt
: There are no required permissions for this default command./hunt reload
:pixel.hunt.remastered.command.reload
Configuration
Note: The configuration file is a .yml
file - It can be validated here when making significant changes.
Config File
The config.yml
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.
config-interface:
- Contains information describing the appearance of the PixelHunt UI.
title:
- The title of the PixelHunt GUI. Supports color codes. Default:''
height:
- The height of the PixelHunt GUI (Number of rows). Default:6
fill-type:
- The type of background item fill of the PixelHunt GUI. There are 4 types:BLOCK
,ALTERNATING
,CHECKERED
andCUSTOM
. Descriptions of these can be found here. Default:BLOCK
filler-items:
- The items used to fill the background of the GUI are under this section, found below.one:
- The first item in the selection that will be used.enabled:
- Whether or not this item is enabled and will show in the UI. Default:true
type:
- The ID of the item. Default:minecraft:stained_glass_pane
amount:
- The amount of the item. Default:1
damage:
- The item meta of the item in the slot. This is usually0
. However, in this case, setting it to14
will show a Red Stained Glass Pane. Default:14
name:
- The name of the item. Supports color codes. Default:' '
lore:
- The lore of the item. Supports color codes.
spawn-broadcast:
- The broadcasts that are sent to all online players when a new hunt is started. Supports color codes. Default: []
timeout-broadcast:
- The broadcasts to send to all online players when the hunt ends (no one found it). Supports color codes. Default: []
extra-lore:
- Adds extra lore to the sprite. Supports color codes and %time%
placeholder.
pre-lore:
- Adds extra lore to the sprite. Supports color codes and %time% placeholder.
enable-particles:
- Whether or not fire particles will show on the hunted species. Default: true
hunts:
- The section that defines all the different difficulties or types of hunts.
Easy:
- The name of the hunt. This can be named anything and will not appear in the UI.gui-x:
- The X position the display will take in the GUI.gui-y:
- The Y position the display will take in the GUI.random-commands:
- If the reward command given on capture is randomly selected from thereward-commands
(if false all commands are executed).reward-commands:
- The commands to reward the player after capturing the Pokémon.reward-description:
- The description of the rewards shown in the lore of the display. Supports color codes.max-ivs:
- Whether or not the IVs of the Pokémon should be maxed out when caught.iv-multiplier-enabled:
- Whether or not the IVs of the Pokémon should be multiplied when caught.iv-multiplier:
- The multiplier if the above is true.1.5
would increase the IVs by 50%.max-duration-minutes:
- The amount of time before the hunt times out and a new one is started.generator-config:
- Contains any settings for the hunt.blocked-types:
- Species that will never appear in the hunt.species-requirement:
- If the Pokémon species is required for the hunt. Should always betrue
.allow-legends:
- If Legendaries should appear in this hunt (typicallyfalse
otherwise incredibly difficult).allow-ultra-beasts:
- If Ultra Beasts should appear in this difficulty (typicallyfalse
otherwise a bit more difficult)gender-requirement:
- If a specific gender should be required.growth-requirement:
- If a specified growth (or number of growths) should be required.nature-requirement:
- If the nature (or natures) should be required.potential-growth-requirements:
- Number of growths to require.potential-nature-requirements:
- Number of natures to require.allow-evolutions:
- If evolutions of the species are allowed (true = easier).iv-requirement:
- If an IV percentage should be required.random-i-v-generation:
- If the IV percentage should be randomly generated.min-i-v-percentage:
- The minimum IV value.max-i-v-percentage:
- The maximum IV value.only-legends:
- Whether or not the hunt will only require Legendaries.
Config Example
config-interface: title: '&2PixelHunt' height: 6 fill-type: BLOCK filler-items: one: enabled: true type: minecraft:stained_glass_pane amount: 1 damage: 14 name: ' ' lore: [] nbt: {} spawn-broadcast: - '&eThe hunt for %pokemon% has started!' timeout-broadcast: - '&cThe hunt for %pokemon% has ended!' extra-lore: - - '&bTime remaining: %time%' pre-lore: - enable-particles: true hunts: Easy: gui-x: 1 gui-y: 1 reward-commands: - give %player% pixelmon:poke_ball 5 reward-description: - '&eReward: &c5 PokeBalls' max-ivs: false iv-multiplier-enabled: false iv-multiplier: 1.5 max-duration-minutes: 60 generator-config: blocked-types: - Ditto species-requirement: true allow-legends: false allow-ultra-beasts: false gender-requirement: false growth-requirement: false nature-requirement: false potential-growth-requirements: 3 potential-nature-requirements: 3 allow-evolutions: false iv-requirement: false random-i-v-generation: false min-i-v-percentage: 30 max-i-v-percentage: 100 only-legends: false random-commands: false Easy2: gui-x: 1 gui-y: 2 reward-commands: - give %player% pixelmon:poke_ball 5 reward-description: - '&eReward: &c5 PokeBalls' max-ivs: false iv-multiplier-enabled: false iv-multiplier: 1.5 max-duration-minutes: 60 generator-config: blocked-types: - Ditto species-requirement: true allow-legends: false allow-ultra-beasts: false gender-requirement: false growth-requirement: false nature-requirement: false potential-growth-requirements: 3 potential-nature-requirements: 3 allow-evolutions: false iv-requirement: false random-i-v-generation: false min-i-v-percentage: 30 max-i-v-percentage: 100 only-legends: false random-commands: false random-commands: false
Version history
There is no version history available for this sidemod just yet.