Join our discord
In partnership with NodeCraft Logo NodeCraft


You are not logged in! Create an account or login to contribute! Log in here!

Better Dex Rewards

From Pixelmon Wiki

Better Dex Rewards is a Pixelmon sidemod that adds the ability for server owners to create PokéDex tiers that will reward players based on their PokéDex progress. This sidemod is a replacement for the SimpleDexRewards sidemod that is no longer maintained.

Installation

Minecraft version Pixelmon version Better Dex Rewards version
1.12.2 8.3.3 2.1.3

Better Dex Rewards is a Forge sidemod, which means it can be installed on any type of server software that supports mods, such as Sponge or Magma/Mohist. An SQL database is required for this sidemod to function. Guides for setting one up locally can be found here and here. Alternatively, server hosts may be able to provide one. It's recommended to contact them or read up on their documentation to see if this is possible.
The SQL information should be entered in the config.yml.

Servers

  1. Download Better Dex Rewards for your version of Minecraft/Pixelmon here.
  2. Place the downloaded .jar in the server's mods folder of your server directory. (This directory is where the world folder and logs folder can be found)
  3. Start the server and wait for it to load.
  4. Open the configuration folder in the server's config/BetterDexRewards and edit the files as desired.
  5. Restart the server to load any changes made.

Clients

  1. Download Better Dex Rewards for your version of Minecraft/Pixelmon here.
  2. Place the downloaded .jar in the mods folder of your game's directory. (This directory is where the world folder and logs folder can be found)
  3. Start the server and wait for it to load.
  4. Open the configuration folder in the game's .minecraft/config/BetterDexRewards and edit the files as desired.
  5. Restart the server 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.

  • /dex (Aliases: /dexrewards, /betterdexrewards, /dexr, /dexr, /derewards, /pokedex) : Opens the main PokéDex Rewards GUI. This has no permissions.

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 Better Dex Rewards GUIs, GUI Items, Settings, Rewards and more.

database: - The SQL database information.

pool-name: - The name identifier of the database (Default value recommended). Default: BetterDexRewards
ip: - The IP of the database (Must be inserted).
port: - The port for the database (Should stay default most of the time). Default: 3306
username: - The username of the database (Must be inserted).
password: - The password of the database (Must be inserted).
database: - The name of the database (Must be inserted).
max-pool-size: - The pool size of the database (Should stay default most of the time) Default: 30

config-interface: - The section that defines the properties of the Dex GUIs.

title: - The title of the Dex GUIs. Supports color codes.
height: - The height of the Dex GUIs (Number of rows). Default: 6
fill-type: - The type of background item fill for the Dex GUIs. There are 4 types: BLOCK, ALTERNATING, CHECKERED and CUSTOM. 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 GUI. 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 usually 0. However, in this case, setting it to 14 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.
nbt: - The NBT of the item.

info-item: - The item that is used to display information about PokéDex Rewards. Properties found below.

x-pos: - The X position of the item in the GUI.
y-pos: - The Y position of the item in the GUI.
enabled: - Whether or not this item is enabled.
type: - The ID of the item.
amount: - The amount of the item.
damage: - The item meta of the item in the slot.
name: - The name of the item. Supports color codes.
lore: - The lore of the item. Supports color codes.
nbt: - The NBT of the item.

missing-item: - Display item to see Missing Pokémon (Pokémon to be caught). Contains the same properties as info-item.
ranks-item: - Display item to see the different PokéDex ranks/tiers. Contains the same properties as info-item.
percentage-item: - Display item to see the PokéDex Percentage. Contains the same properties as info-item.
back-button: - Display item for the back button in the UIs. Contains the same properties as info-item.
previous-page-button: - Display item for the previous page button in the UIs. Contains the same properties as info-item.
next-page-button: - Display item for the next page button in the UIs. Contains the same properties as info-item.
message-delay-seconds: - The interval (in seconds) of the claim-reminder-message (default every minute). Default: 60
reward-stages: - The stages players get rewards at.

one: - A PokéDex reward stage. It's properties will be located below.
x-pos: - The X position of the item in the GUI.
y-pos: - The Y position of the item in the GUI.
display-item: - The item that is normally used to display the reward stage.
enabled: - Whether or not this item is enabled.
type: - The ID of the item.
amount: - The amount of the item.
damage: - The item meta of the item in the slot.
name: - The name of the item. Supports color codes.
lore: - The lore of the item. Supports color codes.
nbt: - The NBT of the item.
complete-item: - The item that is used to display a completed reward stage. Contains the same properties as display-item.
to-claim-item: - The item that is used to display a claimable reward stage. Contains the same properties as display-item.
required-percentage: - The percentage required to complete this reward stage.
reward-commands: - The commands to perform upon claiming this reward stage.
reward-messages: - The messages to send upon claiming this reward stage.

claim-reminder-message: - The message sent to remind the player they've not claimed their reward yet.
claim-update-message: - The message sent to the player when a new reward stage is available to be claimed.
missing-pokemon-item: - The item to display the missing Pokemon. This item should mostly stay in the default state or have minor edits made to prevent any issues.

enabled: - Whether or not this item is enabled.
type: - The ID of the item.
amount: - The amount of the item.
damage: - The item meta of the item in the slot.
name: - The name of the item. Supports color codes and the following placeholders: %pokemon%, %pokedex%
lore: - The lore of the item. Supports color codes and the following placeholders: %biomes%, %spawn_times%, %catch_rate%
nbt: - The NBT of the item. Supports the following placeholder: %sprite%

Sample Config

Show/Hide


database:
    pool-name: BetterDexRewards
    ip: 0.0.0.0
    port: 3306
    username: admin
    password: password
    database: servername
    max-pool-size: 30
config-interface:
    title: '&c&lPokeDex &8&lRewards'
    height: 6
    fill-type: BLOCK
    filler-items:
        one:
            enabled: true
            type: minecraft:stained_glass_pane
            amount: 1
            damage: 3
            name: ' '
            lore: []
            nbt: {}
info-item:
    x-pos: 7
    y-pos: 1
    enabled: true
    type: '340'
    amount: 1
    damage: 0
    name: '&eInfo:'
    lore:
    - '&fCatch Pokemon to fill up'
    - '&fyour Pokedex and earn rewards!'
    nbt: {}
missing-item:
    x-pos: 5
    y-pos: 1
    enabled: true
    type: '5024'
    amount: 1
    damage: 0
    name: '&eMissing Pokemon'
    lore: []
    nbt:
        ndex:
            type: short
            data: '201'
ranks-item:
    x-pos: 3
    y-pos: 1
    enabled: true
    type: '5500'
    amount: 1
    damage: 0
    name: '&ePokeDex Ranks'
    lore: []
    nbt: {}
percentage-item:
    x-pos: 1
    y-pos: 1
    enabled: true
    type: '6256'
    amount: 1
    damage: 0
    name: '&eCurrent PokeDex Percentage'
    lore:
    - '&eComplete: &a%percentage%'
    nbt: {}
back-button:
    x-pos: 4
    y-pos: 5
    enabled: true
    type: '4579'
    amount: 1
    damage: 0
    name: '&eBack'
    lore: []
    nbt: {}
previous-page-button:
    x-pos: 0
    y-pos: 5
    enabled: true
    type: '262'
    amount: 1
    damage: 0
    name: '&ePrevious Page'
    lore: []
    nbt: {}
next-page-button:
    x-pos: 8
    y-pos: 5
    enabled: true
    type: '262'
    amount: 1
    damage: 0
    name: '&eNext Page'
    lore: []
    nbt: {}
message-delay-seconds: 600
reward-stages:
    tenpercent:
        x-pos: 2
        y-pos: 2
        display-item:
            enabled: true
            type: pixelmon:poke_ball
            amount: 1
            damage: 0
            name: '&e10% Dex Reward'
            lore:
            - '&b- 20 Great Balls'
            nbt: {}
        complete-item:
            enabled: true
            type: minecraft:barrier
            amount: 1
            damage: 0
            name: '&cYou''ve already completed this!'
            lore: []
            nbt: {}
        to-claim-item:
            enabled: true
            type: pixelmon:poke_ball
            amount: 1
            damage: 0
            name: '&e10% Dex Reward'
            lore:
            - '&aClick to Claim!'
            - '&b- 20 Great Balls'
            nbt: {}
        required-percentage: 10.0
        reward-commands:
        - give %player% minecraft:great_ball 20
        reward-messages:
        - '&a&l(!) &eYou have completed 10% of the dex!'
    twentypercent:
        x-pos: 6
        y-pos: 2
        display-item:
            enabled: true
            type: pixelmon:poke_ball
            amount: 1
            damage: 0
            name: '&e20% Dex Reward'
            lore:
            - '&b- 20 Great Balls'
            nbt: {}
        complete-item:
            enabled: true
            type: minecraft:barrier
            amount: 1
            damage: 0
            name: '&cYou''ve already completed this!'
            lore: []
            nbt: {}
        to-claim-item:
            enabled: true
            type: pixelmon:poke_ball
            amount: 1
            damage: 0
            name: '&e20% Dex Reward'
            lore:
            - '&aClick to Claim!'
            - '&b- 20 Great Balls'
            nbt: {}
        required-percentage: 20.0
        reward-commands:
        - give %player% minecraft:great_ball 20
        reward-messages:
        - '&a&l(!) &eYou have completed 20% of the dex!'
claim-reminder-message:
- '&e&l(!) &eYou have a PokeDex reward level you can claim!'
claim-update-message:
- '&e&l(!) &eYou have a new PokeDex reward level you can claim!'
missing-pokemon-item:
    enabled: true
    type: pixelmon:ui_element
    amount: 1
    damage: 0
    name: '&e%pokemon% §f- %pokedex%'
    lore:
    - '&eBiomes'
    - '&f%biomes%'
    - ' '
    - '&eTimes: %spawn_times%'
    - '&eCatch Rate: '
    - '%catch_rate%'
    nbt:
        UIImage:
            type: string
            data: '%sprite%'
        UIImageR:
            type: float
            data: '0'
        UIImageG:
            type: float
            data: '0'
        UIImageB:
            type: float
            data: '0'
        UIImageA:
            type: float
            data: '1'

Version history

There is no version history available for this sidemod just yet.

Retrieved from "http://pixelmonmod.com/w/index.php?title=Better_Dex_Rewards&oldid=101284"
Powered by MediaWiki

© 2012 - 2025 Pixelmon Mod