DialogueUtils

DialogueUtils is an innovative side mod designed for the Pixelmon experience in Minecraft Pocket Edition (MCPE). This tool allows you to effortlessly generate dynamic menus by utilizing Pixelmon’s built-in systems for dialogues, choice selections, and input requests, enriching your gameplay.

DialogueUtils 1.0.2 Overview

This mod does not alter the core mechanics of Pixelmon but enhances player interaction through intuitive dialogue features.

Need Assistance?

If you require help or encounter issues, feel free to reach out to @infidelrick on Discord for support.

Key Features

• Basic Dialogues: Show simple text-based messages to players.
• Choice Menus: Offer players a selection of options they can choose from.
• Input Dialogues: Enable players to submit custom text commands directly.

Commands Explained

Simple Dialogue: /dutil simple

Purpose: Present a straightforward dialogue box to a player.
Permissions Needed: dialogueutil.simple
Usage Example:

/dutil simple PlayerName "&eSafari Zone" &eGood Luck {player} &aCatch what you can before your timer expires. Add more time with &e/safari buy #

Choice Dialogue: /dutil choice

Purpose: Dispatch a choice menu to a player using a pre-defined dialogue from dialogues.yml. Choices may trigger commands, have associated costs, and require permissions.
Permissions Needed: dialogueutil.choice
Usage Example:

/dutil choice PlayerName shop

Input Dialogue: /dutil input player|console escape|stay

Purpose: Create a dialogue that allows the player to enter text.
Options Available:

• player|console: Execute the command as a player or from the console.
• escape|stay: Determine if the menu will close upon pressing “Escape”.
• title & message: Use quotes for multi-word text.
• command: Incorporate {player} and {input} as placeholders.

Permissions Needed: dialogueutil.input.player or dialogueutil.input.console
Usage Example:

/dutil input player escape Player123 "&9What's your favorite color?" "Your feedback is valuable:" msg {player} {input} is an excellent choice!

Reload Configuration: /dutil reload

Purpose: Reload all configuration files (including dialogues.yml and config.yml).
Permissions Needed: dialogueutil.admin
Usage Example:

/dutil reload

Helpful Tips

• Utilize color codes (&) to format text in dialogues; for example, &e for yellow or &a for green.
• Verify that permissions are set correctly for each command to prevent access issues.

Configuration Files

config.yml

This file regulates general settings and default messages. Example configuration:

# Enable or disable debugging messages
debug: false
messages:
# Messages for insufficient funds
noMoney:
title: "§cNot Enough Money"
message: "§cYou need {price} to select this option!"
# Fallback message for permission issues
noPermission:
title: "§cPermission Error"
message: "§cYou lack permission: {permission}"

dialogues.yml

This file outlines the configuration for choice menus. Example structure:

dialogues:
# Assign a unique name for each dialogue, used in commands
# Example: /dutil choice [player] shop
shop:
# Supports & color codes
title: "&6Shop Menu"
message: "&eWhat would you like to purchase? &7Check your balance with &6/money"
choices:
# Button text options
  - text: "&aRare Candy &7($1000)"
  # Prefix commands with [console] or [player], defaults to [player]
    commands:
      - "[console]broadcast {player} just received some candy"
      - "[console]give {player} pixelmon:rare_candy 1"
      - "[player]say Ooh, a piece of candy!"
    # Set price in PokeDollars, defaults to `price: 0` if unspecified
    price: 1000
    # Required permission to access the button
    permission: "shop.rare_candy"
    # Message shown for 1.8 seconds if permission is not granted
    failureTitle: "&cNo Permission"
    failureMessage: "&cYou must have the &6shop.rare_candy &cpermission!"
  - text: "&9Master Ball &7($25000)"
    commands:
      - "[console]minecraft:give {player} pixelmon:poke_ball{PokeBallID:\"master_ball\"} 1"
    permission: "group.vip"
    price: 25000
    failureTitle: "&cNo Permission"
    failureMessage: "&cYou need the &6shop.master_ball &cpermission to buy a Master Ball!"
  # Basic action button that simply closes the shop
  - text: "&dExit Shop"

Permission Settings

• dialogueutil.simple: Access to simple dialogues.
• dialogueutil.choice: Access to choice dialogues.
• dialogueutil.input.player: Utilize input dialogues as a player.
• dialogueutil.input.console: Utilize input dialogues as a console.
• dialogueutil.admin: Access to admin-level commands.

Required Dependencies

• Forge: 36.2.39 or newer
• Minecraft: 1.16.5
• Pixelmon: 9.1.12 or newer
• KotlinForForge 1.17.0 is essential.