QuestCreator - Plugin storage system and configs

Oct 19, 2017
QuestCreator - Plugin storage system and configs
  • [​IMG]

    Table of contents :

    1. Commands and permissions
    2. Plugin storage system and configuration
    3. Create your first quest : settings, actions and tasks
    4. Variables system
    5. Advanced quest configuration
    6. NPCs
    7. Runnable jar GUI and developers API


    2. Plugin storage system and configuration

    The plugin stores his configuration (and data, if you don't use MySQL) to a specific directory, which is :
    /plugins/pyrrh4/

    The questcreator_config.pyrml file is the main plugin configuration.

    Code (Text):

    #----------------------------------------------------------------------------------------------------
    # Configuration file for QuestCreator
    #----------------------------------------------------------------------------------------------------

    # Locale

    locale: questcreator_en_US.yml

    #----------------------------------------------------------------------------------------------------
    # Settings
    #----------------------------------------------------------------------------------------------------

    settings:

      # Save the current quests on plugin disable ?
      quests_save_on_disable: true
     
      # Data save interval
      data_save_interval: 180

      # Cancel quests after X inactivity minutes (set it to -1 to disable this option)
      cancel_delay: -1

      # Max active quests per player (experimental)
      # This could be confusing if this is > to 1, but it's your choice !
      max_active_quests_player: 1

      # Action bar settings
      action_bar_enable: true
      action_bar: '&a$QUEST &7| &a$OBJECTIVE &7| &a$PROGRESSION&7/&a$GOAL'

      # Play sound when the rewards of a quest are given
      # The sounds names can change between the versions ! (default version used is 1.11)
      sound_rewards_enable: true
      sound_rewards: ENTITY_EXPERIENCE_ORB_PICKUP
     
      # Ephemerial quests (when the player quits the server, the quest is cancelled)
      ephemerial_quests: false

    #----------------------------------------------------------------------------------------------------
    # Levelling
    #----------------------------------------------------------------------------------------------------

    levelling:

      # Enable levelling
      enable: true

    # Levels
    #  Formatting : '{identifier} {xp needed} $NAME'
    # The identifiers needs to be in levels order, like in the default example
      levels:
        - 1 0 &0Beginner
        - 2 100 &8Novice
        - 3 300 &7Apprentice
        - 4 600 &3Aspirant
        - 5 1000 &1Adventurer
        - 6 1800 &9Experimented
        - 7 3200 &5Expert
        - 8 6400 &aMaster
        - 9 10000 &bMentor

    #----------------------------------------------------------------------------------------------------
    # Variables
    #----------------------------------------------------------------------------------------------------
    # This is the variables that can affect the player's quests. You can use them in all the quests
    #  for example for making multiple choices and dialogs that affect the current quest or even
    #  other quests.
    # Every variable can be assigned with everything on one line (numbers, strings, booleans or
    #  whatever). Lists aren't allowed. And please note that even if you set a number or a boolean,
    #  it'll be considered as a string.
    # The variables names AND values are both case sensivite.
    # Please note that those variables are NOT global, which means every value associated to a variable
    #  can be different for each player ! (example, if there is a variable called 'test', this variable
    #  can be associated to value 1 for Notch and associated to value 2 for PYRRH4)
    # Please note too that this section is useful only if you want default values. If you don't register
    #  a variable here, it won't have a default value but you still we able to use it.
    # The formatting is 'var {variable name} default {default value}'
    #----------------------------------------------------------------------------------------------------

    variables:
      - 'var example_want_jump default yes'
      - 'var example_allowed default yes'

    #----------------------------------------------------------------------------------------------------
    # NPCs
    #----------------------------------------------------------------------------------------------------

    # Start quests in this order when clicking a NPC (if no active quests)

    npcs_quests:
      '1':
        - example
        - example-npc

    #----------------------------------------------------------------------------------------------------
    # GUI
    #----------------------------------------------------------------------------------------------------

    gui:

      # GUI name
      name: Available quests

      # Previous page item
      previous_page_item:
        type: 262
        name: '&7Previous page'

      # Next page item
      next_page_item:
        type: 262
        name: '&7Next page'

     

    The /questcreator_quests/ directory is where you can configure all your quests. One file = one quest.

    See in part 3 how to configure a quest.
  • Loading...
  • Loading...