Configurations

Guide for Configuration

All of the configurations options are stored in the SocialCitizens.yml. It is where you will edit all the actions and requirements per NPC. On this page, You will learn about the configuration structure.

NPC ID

The ID of the NPC where the actions will work

# Should always be the first line per Citizen configuration.
0:

How to get the ID of an NPC?

To get the id of an NPC, you must select the NPC first by looking at it then typing /npc select Once you have successfully selected the NPC, your next command should be /npc id, the feedback is the ID of the NPC that you will then input in the configuration. In the case above, the NPC ID is 0.

Types of Click

There are two types of click, left-click and right-click. Please take note that the actions and requirement for left-click and right-click is separated. You will learn more about this later on.

Left Click Usage

# Make sure the spelling is correct
0:
  left-click-actions:
# Below should be the actions

Right Click Usage

# Make sure the spelling is correct
0:
  right-click-actions:
#  Below should be the actions

Actions

The actions per click are paginated. It means that there are groups of actions that will be triggered at once. To move into the next action, the player has to click the NPC again. You can create as many pages of action you'd like.

0:
  left-click-actions:
    # You can name a page what ever you'd like.
    first-page:
      - "[message] This is the 1st page"
    this-will-execute-second:  
      - "[message] This is the 2nd page"
    you-name-it:  
      - "[message] This is the 3rd page"

A page will only be moved if the player has clicked the NPC. You can use delay if you want automated messaging.

Learn more about the types of actions in the actions section.

Actions

Requirements

Requirements