Configuration

Guide to setting up the Quest's configuration file

1KB

config.yml

Open

Demo config.yml

✔️Optional Dependencies

Vault: If your server runs vault, this is where you let the plugin know that you want vault implemented into the Quests system. To do so, open the config.yml file and search for:

# If your vault currency has a symbol, set it here.
# If none, leave blank
currency-symbol: $

✔️MySQL / SQLite

SQL:
  # If enabled: true, Quests will use MySQL server, otherwise will default to SQLite
  enabled: false
  # Data if using MySQL, if you are using SQLite, ignore this section.
  host: host
  database: database
  username: username
  password: password
  port: 3306

If you happen to switch between using MySQL and SQLite, the data will not transfer between the two. If you swap, please fully restart the server, using /reload (which is not recommended) has the potential to cause a lot of problems.

✔️Quest Limits

# Config section for if you want to limit the amount of quests players 
# can do for a specific period of time
limits:
  # Time in minutes between the quests reseting, default is 1440 (1 day)
  reset: 1440
  # Default number of quests a player can do per a given time period
  default: 10
  # Players with permission "quests.vip" will have this amount of quests per period
  vip: 15
  # Players with permission "quests.pro" will have this amount of quests per period
  pro: 20
  

✔️Leveling

# Xp level steps
levels: []

# Example
# Adds 10 levels
# Xp required per level shown below 
levels: [100, 200, 300, 500, 750, 1000, 2000, 3000, 5000, 7500, 10000]

✔️Merchant

merchant:  
  #Merchant UI name
  ui-name: Merchant

✔️Quest Chances

merchant:  
  # Chances for each rarity of quest, takes an decimal input
  # Legendary chance is implied from equation: 1 - (epic chance)
  chances:
    common: 55     # 55% chance Common
    uncommon: 20   # 20% chance Uncommon
    rare: 15       # 15% chance Rare
    epic: 8        #  8% chance Epic
    legendary: 2   #  2% chance Legendary

The logic behind the chance calculations are as follows: Imagine a hat containing the various types of quest rarities. There are 55 common 'tickets', 20 uncommon, 15 rare, 8 epic, and 2 legendary. To determine the quest rarity, we reach in and select a ticket at random. Therefore, when changing these values, the odds of each rarity must be calculated as:

✔️Skills

merchant:
  skills:
    reset:
      # If dont want people to reset perks, set enabled to false, default is true
      cost: 15000
    # For every level added to 'Chronos Orb', how many seconds are reduced
    # Default value: 3 seconds per level
    cooldown: 3
    # For every level added to 'Bonus Xp', % increased
    # Default is +3% per level
    xp: 3
    # For every level added to 'Midas' Touch', % increased
    # Default is +5% per level (If Vault is enabled)
    gold: 5
    # For every level added to 'Escalating Odds', will increase 
    # config section "merchent.chances" by 0.5 for all rarities, but common
    odds: 0.5

✔️Quest Content

merchant:  
  # Customise Quests
  quests-items:
  
    # Configuration section for each rarity
    common:
    
      # 'Amount' takes an integer input
      # Determines amount of different materials for quest requirements
      # Values can change for each rarity type
      amount: 3
      
      # If Vault is enabled, gives monetary range of quest completion reward
      # If Vault is disabled, ignore these values
      reward:
      - 10 # Minimum Value
      - 20 # Maximum Value
      
      # Can take either decimal or Integer value (e.g. 15 or 15.5)
      # Amount of xp gained on quest completion
      xp: 15.0
      
    uncommon:
      amount: 2
      reward: 
      - 30
      - 45
      xp: 25

✔️Adding Quest Components

merchant:
  quests-items:
    # Add materials to be included in quests, based on rarity
    common:
      # To specify what items are requirements
      # Template => MATERIAL: [min, max]
      IRON_ORE: 
      - 5
      - 10
      REDSTONE:
      - 30
      - 45
      GOLD_INGOT:
      - 20
      - 35
    uncommon:
      EMERALD:
      - 2
      - 3
      DIAMOND_BLOCK:
      - 5
      - 10
    rare:
      OBSIDIAN:
      - 40
      - 150
    epic:
      BEACON:
      - 20
      - 35
    legendary:
      EMERALD_BLOCK:
      - 10
      - 20
      STONE:
      - 1000
      - 2500
    # If `amount` is set at 1, when getting a common quest, the player will
    # randomly recieve the task of getting either 5 to 10 iron ore, 
    # 30 to 45 redstone, or 20 to 25 gold ingots
    
    # You can add as many, or as few materials as you like, given that the amount
    # specified for that rarity is less than total materials

To find out what items you are able to use as per your version, please refer to: Minecraft Material Versions: 1.9 - 1.12 , 1.13 - 1.14, 1.15 - 1.16

✔️NPC Skins

merchant:
  skin:
    uuid: a39ef57a387c4cd1974059b732ebc7a5
    # UUID indicates the uuid of the player's skin you want to use for the npc.
    # Refer below for instructions how to find the uuid associated with a skin.

Finding Skin UUID Value

If you know the UUID of the skin you want to use, simply replace the default id in the config.yml.

If you have the player name of the skin you want to use, go to MCUUID and enter the player name. Click 'Lookup'. Once the new page has loaded, copy the 'Trimmed UUID' value and paste it in your config.yml

You can use these sites to find player skins for your NPC: NameMC

✔️NPC Locations

merchant:
  location:
  - {world_name}/x/y/z/yaw/pitch/"NPC Name"

There may come a time when you wish to edit/remove the location of already placed NPC's. All NPC's are stored under the above directory. When editing locations in the config, be sure to run the command "/merchant reload" to refresh the plugin and update/save all changes.