Configuration | SmartQuests

Last updated 1 month ago

Once the server is started, the plugin generates a subfolder called "SmartQuests" inside which we will find the following configuration files.

config.yml

DATABASE: You can choose between a local database with "sqlite" or a shared database with "mysql" In the case of "sqlite" it is not necessary to fill in access data in the "database" section. LANGUAGE When the plugin starts, the server language is automatically detected. If you need to change the language among those available, replace with the desired language. (You will need to delete the message.yml file and do a /reload . The file will be regenerated in the chosen language.) If your language is not available, you can edit the messages manually. ALIAS It is possible to insert an alias that will perform the same function as the /quests command, with a command of your choice replacing "null". DEFAULT-GUI-CATEGORY: false: The /quests command directly opens the GUI of all available missions. true: The /quests command opens the categories gui directly. GUI -> SIZE-ROWS Allows you to set the size of the GUI. Accepted values: 2 to 6 It is not possible to set only one line as it is necessary to have a navigation bar. The navigation bar contains: "Exit" button, Player head, if > 45 missions two buttons to change page appear (Only on request will be developed the possibility to disable the navigation bar) GUI -> PLAYER-HEAD-ENABLE Enable or disable the display of the player's head in the GUI GUI -> MAX-MISSION-ACTIVE Indicates how many missions can be activated at the same time. The value is changeable in game through the editing GUI. "/quests edit" GUI -> HIDE-COMPLETE-MISSION It is possible to hide missions that have been completed by players by setting "hide-complete-mission" to true. You can change the option in game via the editing GUI. "/quests edit" GUI -> HIDE-LOCK-MISSION Allows you to hide missions that have not yet been unlocked GUI -> FILL It gives you the option to disable GUI bar padding or customize the item GUI -> ITEM Lock: Enter an item ID to display as an icon in locked missions (enter 'none' to display the original mission object) Complete: Enter an item ID to display as an icon upon mission completion (enter 'none' to display the original mission object) MISSION-COMPLETE-SOUND You can customize the type of sound when completing the mission. Enter 'null' to mute the sound Sound example: UPDATES -> CHECK-UPDATE Check if new updates are available UPDATES -> NOTIFY_CHAT_OP Notify OP players in chat that there is an update UPDATE -> AUTO-UPDATE Automatically download the latest updates (if available) UPDATE -> REMOVE-OLD-VERSION Checks for old versions of the plugin and removes them

message.yml

the "message.yml" file contains all the message strings and plugin texts. If your language is among those available, the translated strings will be automatically generated, otherwise the English language will be used as default. In case of future updates the file will not be regenerated, but only the missing messages will be added to the file.

quests.yml

the "quests.yml" file contains all the available missions. Editable by following the guides below:

Edit Quest GUI

Edit Quest File

databases:
  # Types of backend (storage): mysql, sqlite
  backend: sqlite
  host: localhost
  port: 3306
  database: database
  username: root
  password: password

#Available languages: EN, IT, DE, FR, ES, PT
language: EN

alias: 'null'

default-gui-category: false

gui:
  size-rows: 4
  player-head-enable: true
  max-mission-active: 3
  hide-complete-mission: false
  hide-lock-mission: false
  fill:
    enable: true
    item: BLACK_STAINED_GLASS_PANE
  item:
    lock: STRUCTURE_VOID
    complete: none

mission-complete-sound: ENTITY_PLAYER_LEVELUP

symbols:
  complete: ✓
  active: ▶

updates:
  check-update: true
  notify-chat-op: false
  auto-update: true
  remove-old-version: true