Task Import Configuration Guide

In the AI era, creating tasks via GUI is becoming increasingly inefficient. The task import feature was added in 2.10.0.
You can feed this document to AI to generate tasks in the correct format.
This document explains in detail how to batch import tasks into the PlayerTask plugin via the import.yml configuration file.

Command

/plk import

After execution, it reads the plugins/PlayerTask/import.yml file and imports tasks. Newly added tasks will have their id automatically backfilled into the config file.

---

Sharing Platform

This is a task configuration sharing platform made specifically for this plugin. Everyone is welcome to use and contribute more tasks.

Click to view (opens new window)

---

Config File Structure

tasks:
  task_key_1:
    # id: 1                  # Optional — if id exists, updates existing task; if no id, creates new (auto-backfilled after import)
    taskName: "&fTask Name"  # Required, supports color codes
    type: everyday           # Optional, task type, default: everyday
    rarity: normal           # Optional, task rarity, default: normal
    description: "Task description"   # Optional, task description text
    enableCommand: "say hello" # Optional, command executed when accepting NPC task
    demands: # Required, task objective list
      - type: blockBreak
        amount: 10
        itemStack: OAK_LOG
    rewards: # Required, task reward list
      - type: vault
        amount: 100

---

Task Types (type)

Type Value	Description	Notes
everyday	Daily task	Default, randomly refreshed daily
npc	NPC task	Requires NPC plugin
reel	Scroll task	Triggered by task scroll item

---

Task Rarity (rarity)

Rarity Value	Description	Color Code
normal	Normal task	&f White
advanced	Advanced task	&9 Blue
rare	Rare task	&5 Purple
rarer	Rarer task	&d Pink
epic	Epic task	&e Yellow
mythical	Mythical task	&e&l Bold Yellow

---

Task Objective Types (demands)

Basic Format

demands:
  - type: objective_type
    amount: quantity
    itemStack: item/mob/material_id

All Objective Types

1. craftItem - Craft Items

Player needs to craft specified items.

- type: craftItem
  amount: 5
  itemStack: DIAMOND_SWORD    # Minecraft item ID

2. blockBreak - Mine Blocks

Player needs to mine specified blocks.

- type: blockBreak
  amount: 64
  itemStack: STONE            # Minecraft block ID

3. Fish - Fishing

Player needs to catch specified items.

- type: Fish
  amount: 10
  itemStack: COD              # Item obtained from fishing

4. Interact - Place Blocks

Player needs to place specified blocks.

- type: Interact
  amount: 20
  itemStack: TORCH            # Block to place

5. kill - Kill MythicMobs Monsters

Requires MythicMobs plugin.

- type: kill
  amount: 5
  itemStack: SkeletonKing     # MythicMobs monster ID

6. killNormal - Kill Normal Monsters

Kill vanilla Minecraft monsters.

- type: killNormal
  amount: 10
  itemStack: zombie           # Monster type, lowercase

7. killPlayer - Kill Players

PVP task, kill other players.

- type: killPlayer
  amount: 3
  itemStack: player_name

8. killMp - Kill MonsterPlus Monsters

Requires MonsterPlus plugin.

- type: killMp
  amount: 5
  itemStack: boss_dragon      # MonsterPlus monster ID

9. consume - Consume/Eat Items

Player needs to eat specified items.

- type: consume
  amount: 10
  itemStack: COOKED_BEEF      # Food item ID

10. submit - Submit Items

Player needs to submit specified items (items are consumed).

- type: submit
  amount: 32
  itemStack: IRON_INGOT       # Item to submit

11. enchantment - Enchant Items

Player needs to enchant items to specified level.

- type: enchantment
  amount: 3                     # Enchantment level
  itemStack: SHARPNESS:1        # Enchantment type:level (level optional, defaults to max)

12. shear - Shear

Player needs to shear wool or other shearable entities.

- type: shear
  amount: 10
  itemStack: wool            # Options: wool / mushroom_stew

13. breed - Breed Animals

Player needs to breed specified animals.

- type: breed
  amount: 5
  itemStack: cow              # Animal type, lowercase

14. tame - Tame Animals

Player needs to tame specified animals.

- type: tame
  amount: 2
  itemStack: wolf             # Animal type, lowercase

15. chat - Send Chat Messages

Requires PlayerChat plugin. Player needs to send messages containing specified content.

- type: chat
  amount: 1
  itemStack: 'hello'            # Message content keyword

16. interaction - Interact

Player needs to interact with specified blocks (right-click).

- type: interaction
  amount: 10
  itemStack: CHEST            # Block type

17. command - Execute Commands

Player needs to execute specified commands.

- type: command
  amount: 1
  itemStack: spawn           # Command content without /

---

Task Reward Types (rewards)

Basic Format

rewards:
  - type: reward_type
    amount: quantity
    itemStack: additional_param   # Required for some types
    description: "Reward description"   # Optional, displayed in GUI

All Reward Types

1. vault - Money Reward

Requires Vault and economy plugin.

- type: vault
  amount: 500                 # Money amount
  description: "500 coins"   # Optional

2. playerPoints - Points Reward

Requires PlayerPoints plugin.

- type: playerPoints
  amount: 100                 # Points amount
  description: "100 points"

3. coin - Task Coin Reward

PlayerTask built-in currency.

- type: coin
  amount: 50                  # Task coin amount
  description: "50 task coins"

4. itemStack - Item Reward

Give player specified items.

- type: itemStack
  amount: 1                   # Item quantity
  itemStack: DIAMOND          # Item ID
  description: "Diamond x1"

5. command - Command Reward

Execute console command, supports variables.

- type: command
  amount: 1                   # Execution count
  itemStack: 'give ${player} diamond 5'    # Command
  description: "Get 5 diamonds"

Command format notes:

• ${player} will be replaced with the player name

6. player_currency_xxx - PlayerCurrency Multi-Currency

Requires PlayerCurrency plugin.

- type: ply_point  # ply + currency ID
  amount: 100
  description: "100 points" # Optional description

---

Complete Configuration Example

tasks:
  # Beginner task - Lumberjack
  lumberjack:
    taskName: "&fForest Lumberjack"
    type: everyday
    rarity: normal
    description: "Chop various trees to gather wood"
    demands:
      - type: blockBreak
        amount: 20
        itemStack: OAK_LOG
      - type: blockBreak
        amount: 10
        itemStack: BIRCH_LOG
    rewards:
      - type: vault
        amount: 100
      - type: coin
        amount: 10

  # Intermediate task - Monster Hunter
  monster_hunter:
    taskName: "&9Monster Hunter"
    type: everyday
    rarity: advanced
    description: "Clear dangerous monsters"
    demands:
      - type: killNormal
        amount: 15
        itemStack: zombie
      - type: killNormal
        amount: 10
        itemStack: skeleton
    rewards:
      - type: vault
        amount: 300
      - type: itemStack
        amount: 5
        itemStack: IRON_INGOT
        description: "Iron Ingot x5"

  # Advanced task - Master Miner
  master_miner:
    taskName: "&5Master Miner"
    type: everyday
    rarity: rare
    description: "Dig deep underground for precious ores"
    demands:
      - type: blockBreak
        amount: 10
        itemStack: DIAMOND_ORE
      - type: blockBreak
        amount: 20
        itemStack: GOLD_ORE
    rewards:
      - type: vault
        amount: 1000
      - type: command
        amount: 1
        itemStack: 'give ${player} diamond 3'
        description: "Diamond x3"

  # Epic task - Beast Tamer
  beast_tamer:
    taskName: "&eBeast Tamer"
    type: everyday
    rarity: epic
    description: "Tame wild animals as your companions"
    demands:
      - type: tame
        amount: 3
        itemStack: wolf
      - type: breed
        amount: 5
        itemStack: cow
    rewards:
      - type: vault
        amount: 2000
      - type: coin
        amount: 100
      - type: playerPoints
        amount: 50
        description: "50 points"

  # NPC task example
  npc_fishing_quest:
    taskName: "&dFisherman's Request"
    type: npc
    rarity: rarer
    description: "Help the fisherman collect fish"
    enableCommand: "say ${player} accepted the fisherman's request"
    demands:
      - type: Fish
        amount: 20
        itemStack: COD
      - type: Fish
        amount: 10
        itemStack: SALMON
    rewards:
      - type: vault
        amount: 500
      - type: itemStack
        amount: 1
        itemStack: FISHING_ROD
        description: "Fishing Rod x1"

---

Notes

1. Task keys (e.g., lumberjack, monster_hunter) are only keys in the config file and won't be shown to players.

2. id field:

   • No need to fill id on first import — the system will auto-generate and backfill it
   • On subsequent imports, tasks with id will be updated, tasks without id will be added

3. itemStack case:

   • Block/item IDs: recommended uppercase (e.g., DIAMOND_ORE)
   • Monster/animal types: must be lowercase (e.g., zombie, wolf)
   • MythicMobs IDs: keep as-is

4. Color codes:

   • Use & symbol, e.g., &a green, &c red, &e yellow
   • &l bold, &o italic, &n underline

5. Command rewards:

   • Supports PlaceholderAPI variables

6. Deduplication:

   • Import automatically checks for existing task objectives and rewards
   • Identical objectives/rewards will be reused, not duplicated

---