Quests and Landmarks

Quests & Landmarks ⚔️

Sculk Companion provides in-game tasks (quests) and spatial memory features (landmarks) that link conversational triggers directly to in-game actions.

---

⚔️ Quest System

Sculk can assign players quests based on conversation flow. A player can only have one active quest at a time.

Quest Types

1. KILL_MOB:
   • Requires the player to hunt down and kill a specific quantity of an entity type (e.g. ZOMBIE, CREEPER, SPIDER).
   • Progress is monitored automatically using server death events.
2. COLLECT_ITEM:
   • Requires the player to gather a specific quantity of an item type (e.g. RAW_COPPER, DIAMOND, COAL).
   • To check progress or complete the quest, the player must chat with Sculk, prompting the AI to call check_quest_status. If they have enough items in their inventory, the plugin consumes the items and marks the quest as complete.

Quest Flow:

• Assignment: The AI calls start_quest(type, target, target_amount, description). The player receives an action-bar notification and a chat description of the task.
• Tracking: When killing target mobs, an action bar displays current progress (e.g., ZOMBIE 3/10) with experience orb pickup sounds.
• Completion: Once target goals are met, the player is notified to return to Sculk. When they report back, the AI confirms completion, calls complete_quest to clear their log, and optionally drops a reward item using gift_item_to_player.

---

📍 Landmark System

The landmark system allows the AI to record coordinates for players and teleport them to those coordinates when requested.

How it works:

1. Saving a Landmark:
   • A player tells Sculk to remember their current spot (e.g., "Remember this location as my portal").
   • The AI calls save_landmark(name).
   • The location is saved under the key portal in their profile, and a sound plays.
2. Teleporting back:
   • The player asks to go back (e.g., "Teleport me to my portal").
   • The AI calls teleport_to_landmark(name).
   • If the landmark exists, the player is teleported, and a sculk particle burst spawns.

Landmark Guidelines

• Landmark names are saved in lowercase and stripped of special characters.
• Teleporting to landmarks is subject to the player's affection level. If their affection is negative, the AI will refuse to teleport them.