Pages

Configuration Guide

AutoViP features a configuration file to allow customization of almost every aspect of the plugin. You can edit configuration file manually then reloading the config (/av reload). Always verify that your YAML syntax is correct here or use correct program to edit the config file!

Config

general:
  mysql:
    enable: true
    host: 'localhost'
    db: 'db_name'
    user: 'db_username'
    password: 'db_password'
  getViP:
    money: 100
    xp: 100
    message: 'The player has come to VIP Group'
    endmessage: 'The player has come to Default Group'
  ViPgroup: 'VIP'
  Defaultgroup: 'Default'
  Items:
  - 264 64
  Commands:
  - manuadd <player> <group>
  - god <player>
  EndCommands:
  - manuadd <player> <group>
  - god <player>

Configuration keys

mysql
  • enable (Boolean) - Will enable or disable the use o MySQL by the plugin.
  • host (String) - Determine IP or name of MySQL server.
  • db (String) - Set the name of MySQL database to connect.
  • user (String) - Set the username of database.
  • password (String) - Set the password of database.
getViP
  • money (Integer) - Set the amount of money to give when player is promoted. (Required: Essentials Economy)
  • xp (Integer) - Set the amount of exp to give when player is promoted. (Required: Essentials Economy)
  • message (String) - Set the message when player is promoted.
  • endmessage (String) - Set the message player is demoted.
ViPgroup (String)
  • Sets the name of the group that the player will be promoted.
Defaultgroup (String)
  • Sets the name of the group that the player will be demoted.
Items (Array)
  • These are the items you want to give the player when it is promoted. You can use the item name or item ID and set the amount to give.
Commands (Array)
  • These are commands you want to execute when player is promoted. You can use <player> to get the player display name or <group> to pass name seted in ViPgroup in this config. (Be sure you have the plugin of the commands listed here)
EndCommands
  • These are commands you want to execute when player is demoted. You can use <player> to get the player display name or <group> to pass name seted in Defaultgroup in this config. (Be sure you have the plugin of the commands listed here)

Configuration Tutorial

  1. Open the config.yml located in the AutoViP folder in your plugins directory in your favorite text editor.
  2. Edit the values accordingly.
  3. Add or edit the settings and configure them to your liking!
  4. Copy and paste your config into a YAML syntax checker such as the one found here; fix any errors that occur.
  5. Re-paste your "fixed" config back into the text editor.
  6. Save your file then reload the config from console or from in-game by doing /av reload!
  7. Give the appropriate permission to the players or groups to execute commands of plugin.

Value Types

  • Boolean - A boolean is like a toggle and can consist of either true or false.
  • String - Any string of text that is enclosed by ' '.
  • Array - An array usually consists of multiple values started with - .