Configuration files

Configuration files

The config file

The config file contains information and general setting for the RPG-NPC plugin.

Config file for RPG-NPC v2.2.6:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
#Config file.
settings:
#Tool to select looking positions of NPCs.
    tool: 280
#NPC reaction time, the faster the more RAM it uses:
    npcreactiontime: 2.0
#Settings for the database
database:
#Interval in minutes between saving the players.
    player-saving-interval: 60
#Settings for the Quest books
books:
    questinfobook:
#Price of the quest information book.
        price: 100.0
        refresh:
#Should the quest information book resfresh after the player opened it?
            onOpen: false
#Should the quest information book resfresh after the player accepted a quest?
            onAccept: false
        spawn:
#Should the quest information book spawn after the player accepted a quest?
            onAccept: false
    questlogbook:
#Price of the quest log book.
        price: 100.0
    questlistbook:
#Price of the quest list book.
        price: 100.0
#Global book options: (for every player)
    global:
        respawn: 
#Should books respawn when the player respawns from death?
            onRespawn: false 
#Should books respawn when the player logs in?
            onLogin: false
#Should books spawn when the player logs in for the first time?
            onFirstLogin: false
updater:
#State of the updater, by default it's off
#When you turn the updater on it will only function as notifier.
#If you want the updater function to download the new version
#set no-download to false.
    state: false
#If there is a download show the progress?
    show-progress: false
#Should we only check for a new update?
#If this is set to true the update will not be downloaded.
    no-download: true
#Is the updater allowed to notify you trough the console?
    allow-output: true
statistics:
#Allow RPG-NPC to anonymously gather information and send it to McStats.org?
    state: false
players:
#Global player statistics.
    global:
#Permissions that will hand out an bonus to the accepted quest limit of the player.
#Example:
#    limitedquestsperms:
#        premium: 5
#
#If you add the permissions rpg.limitedquests.premium to the player he will receive
#5 extra slots to accept quests.
        limitedquestsperms:
          premium: 5
#Global and general amount of accepted quests -1 for unlimited.
        limitedquests: -1
#To disable a command alias set the flag to false.
commands:
    rpg: true
    rn: true
    rp: true
    quest: true
    q: true
    aQuest: true


The npc file

The NPC file contains information about all the NPCs that were created using the RPG-NPC plugin.

npc:
  '0':
    name: Bob
    prefix: The old man
    suffix: Marley
    skinURL: http://www.minecraftskins.com/newuploaded_skins/skin_2012100806063875504.png
    quest:
    - Apprentice_woodcutter
    intromessage:
    - Hi, I'm looking for some supplies!
    - You mind looking for some?
    location:
    - '41.182678136986034'
    - '69.0'
    - '258.7877055719556'
    - '-2.6739535'
    - '-46.300644'
    - world
    looklocation:
    - '-28.0'
    - '75.0'
    - '330.0'
    gear:
    - '0'
    - '0'
    - '0'
    - '0'
    - '0'
    fight: '6'
    look: '3'
'0'
This is the NPCs ID.
Name
The NPC name, this will be displayed above the NPCs head.
Suffix/Prefix
Pre- and Suffix will be shown when rightclicking the NPC.
SkinURL
Change the NPCs skin with the given .PNG image.
Quest
A list of all quests the NPC has.
Intromessage
A list of all messages shown when right-clicking the NPC.
Location
The location of the NPC.
Looklocation
The default looking location of the NPC.
Gear
The gear the NPC wears
  • Item in hand
  • Helmet
  • Chest armor
  • Leggings
  • Boots
Fight
The range the NPC will look for aggressive mobs.
Look
The range the NPC will look around himself.


The quest file

The quest file contains the quests that are linked to the NPCs.

Small quest

  Apprentice_woodcutter:
    type: Chain
    objective:
      '0':
        type: break
        goal: '17'
        amount: 5
        reward:
        - e:5
        required: true



Big quest

  Marksman_scavenger:
    type: Chain
    objective:
      '0':
        type: break
        goal: '5'
        amount: 5
        reward:
        - e:5
        required: true
      '1':
        type: collect
        goal: '5'
        amount: 5
        reward:
        - e:5
        required: true
      '2':
        type: place
        goal: '5'
        amount: 5
        reward:
        - b:4:20
        required: false
    onAccept:
      message:
      - Bring me some planks!
      reward:
      - e:5
      - p:some.permission
      - b:5:30
      penalty:
      - e:5
      - p:some.permission
      - b:5:20
    onDrop:
      message:
      - No planks no payment!
      penalty:
      - e:5
      - p:some.permission
      - b:5:5
      teleport:
      - '195.37588522026599'
      - '65.0'
      - '257.379065413005'
      - '13.612771'
      - '216.81628'
      - world
    onComplete:
      message:
      - Great job, mind doing another one?
      teleport:
      - '195.37588522026599'
      - '65.0'
      - '257.379065413005'
      - '13.612771'
      - '216.81628'
      - world
Type
The quest type
Timed
The cooldown in minutes.

Objective
The objectives the quest has.
Objective Type
The type of the objective.
Objective Goal
The goal of the objective.
Objective Amount
Amount of times for the goal to be met.
Objective Rewards
Rewards the player receives for completing the objective.
(Objective)Required
If the objective is required.

onAccept Messages
The message the players receives when accepting the quest.
onAccept Pre-Messages
The message the players receives selecting to accept the quest.
onAccept Penalties
The penalties the player receives when accepting the quest.
onAccept Rewards
The rewards the player gets when accepting the quest.
onAccept Teleport
The teleport location the player gets teleported to when accepting the quest.

onDrop Messages
The message the players receives when dropping the quest.
onDrop Penalties
The penalties the player receives when dropping the quest.
onDrop Teleport
The teleport location the player gets teleported to when dropping the quest.

onComplete Messages
The message the players receives when completing the quest.
onComplete Teleport
The teleport location the player gets teleported to when completing the quest.

Chain lists

chain:
  '0':
  - Apprentice_woodcutter
  - Marksman_scavenger
'0'
The chain ID.


Config inputs

Inputs for reward/penalties. These inputs are very important and when misspelled they will not work. The in-game creation command makes sure you can only insert existing inputs.

Potion Effects

Potion effect inputs start with pe: followed by their Yaml input. The in-game creation command will only ask for their Yaml input, it will automatically assign pe: to it. The Yaml input is not capital sensitive.

Original nameYaml input
BlindnessBLINDNESS
NauseaCONFUSION
StrengthDAMAGE_RESISTANCE
HasteFAST_DIGGING
Fire ResistanceFIRE_RESISTANCE
Instant DamageHARM
Instant HealthHEAL
HungerHUNGER
StrengthINCREASE_DAMAGE
InvisibilityINVISIBILITY
Jump BoostJUMP
Night visionNIGHT_VISION
PoisonPOISON
RegenerationREGENERATION
SlownessSLOW
Mining FatigueSLOW_DIGGING
SpeedSPEED
Water BreathingWATER_BREATHING
WeaknessWEAKNESS
WitherWITHER