[ A B C D E F G H I L M N O P R S T U W

Guide NPCs

Guide NPCs are a type of SparkQuest NPCs (Non-Player Characters) that can serve as guides in map areas or on quests. Guide NPCs are handled by a custom Denizen script developed by the coder CloudShadow.

  1. Empty at least two slots on your inventory for the Guide items. You’ll also want a spot of any objects you intend to give to the Guide to have the guide give to players.
  2. Get the Guide Spawn Egg and the Waypoint Configure Stick using the following commands:
/ex give guide_spawn_item
/ex give guide_configure_item
  1. With the Guide Spawn Egg in your hand, place on the block where you want to spawn the Guide. The Guide will spawn and you’re ready to begin setting waypoints.
  2. Before you set waypoints, its good to do a little planning about the path and actions the Guide will do. First, you should know that as you set a series of waypoints, the Guide will always stop in the last of the series and wait for a click to continue, or, in the case of the last waypoint, to return to the original position. This means you can control stop-and-wait points along a long path by breaking it into series of waypoints. We recommend setting waypoints in the series and configuring these completely before adding another series. It is helpful to think of the options for each waypoint. You can add to waypoints:
    • talk lines: multiple lines of text that will appear as narrations on the player’s screen.
    • reward to give: load up to 8 items that are given to the player
    • point to look at: select a block and the player will be forced to look at it.
    • wait time: set the time the Guide will wait before moving to the next waypoint.
  3. Switch to the Waypoint Configure Stick. Left-click blocks to set waypoints along the path of the tour. These blocks will appear to become glowstones to mark the path, but will fade away after 5 minutes. Select a series of waypoints keeping in mind that the Guide will pause and wait to be clicked on the last one. The blocks you select for waypoints should be fairly close together (max 10-15 blocks apart). If there is a big distance between waypoints (> 25 blocks) the Guide will likely wander a bit and then just stand there.

Tip: To make the glowstone waypoints reappear, right-click any non-waypoint block with the Waypoint Configure stick.

  1. By default, the last waypoint you placed is selected. You can edit this waypoint or left-click any other waypoint with the Configure Stick to select it. Once you have the correct waypoint selected, right-click in the air with the Configure Stick to open the edit dialog for that waypoint.
  1. Select the items in the Guide settings inventory dialog to setup each waypoint.
    • snow block: when clicked, this toggle whether the Guide is waiting for a player to click it to begin the tour. Click this after you configure all the waypoints to make your Guide ready for tours.
    • paper: enter the talk text editor where you can enter multiple lines of text that will appear as the Guide talking in the chat. (TIP: type out lines first and check spelling, grammar, and readability since editing text in the dialog is difficult.)
    • flint: this clears all the text currently assigned to the waypoint.
    • emerald: this sets up to 8 items that will be given to the player at the waypoint.
    • eye of ender: this sets a block as a point the player must look at when they reach the waypoint.
    • clock: sets how long the guide should wait at the waypoint (in ticks; 20 per second).
  2. Once you’re done configuring your waypoints, click the snow block to make your Guide clickable and ready for tours.

Additional Notes:

  • Selecting a Guide for the guide script and selecting a guide for Citizens2 (/npc) are two different things. You can select an existing Guide for the guide script by right-clicking on an NPC. To select for Citizens2, place your cross hairs on the NPC and type /npc sel.
  • You can use /npc rename [name] to name your Guide whatever you like.
  • You can use /npc skin [player_name] or /npc skin --url [url] to set the Guide’s skin. Check STF MC Skins for current official skins.
  • To remove a Guide, remove the NPC with /npc remove.

Guide Script Actions

  • right-click an npc to select them
  • left-click a block to set a waypoint at it
  • left-click an existing waypoint to select it
  • left-click the air to select the most recently placed waypoint
  • right-click a block to remove a waypoint from it
  • right-click air to configure the current waypoint actions

Issues and Bugs

  • Guide stalls at the bottom of a ladder. The text and a further waypoint is pasted, but the NPC itself never moves to that point. If clicked, NPC disappears without walking back to origin NPC. Try setting another point above ladder. Work around: NPC waits at the top of ladder or use stairs.
  • Guide can’t be taken out of wait mode by the player, even if they’re done their task. It would be nice if a click would take player out of wait mode.

Change Log

0.1.03022021

guide_0.1.20210302Download
  • Changes tour activation text to “Tap me again if you are ready.” (line 175).
  • Set duration of showfake glowstone to 300 seconds (5 minutes) to make path editing easier (lines 71, 84).
  • Lowered the walking speed of the guide (lines 293, 297).
  • Corrected the “Guide walks while talking” issue. Set “wait_time” (line 322) for 4 seconds to slow down each action.
  • Added - lookclose <[new_guide_id]> true (line 332) so guide will look at player every time she pauses to talk.

Related Entries