Configuration

Aug 11, 2017
Configuration
  • The configuration of the plugin HyUltimatePlugin is separated by feature except for the main config.
    There are only settings on auto updating and auto config backup in the main config file.
    Code (Text):
    #Auto update settings
    AutoUpdate:
      #Enable or not
      Enable: true
      #Delay per update check in seconds
      CheckDelay: 3200
      #Auto update settings for this plugin
      HyUltimatePlugin:
        #Enable or not
        Enable: true
        #Check repeatly or just check once on start
        Repeat: false
        #Plugin yml link
        PluginYmlURL: https://raw.githubusercontent.com/hykilpikonna/HyUltimatePlugin/master/out/production/HyUlt/plugin.yml
        #Latest version download link
        JarURL: https://raw.githubusercontent.com/hykilpikonna/HyUltimatePlugin/master/Build/HyUlt.jar
      #Other settings
      Default:
        #The key name fully explained this
        TimeoutInSeconds: 3
        #Delay per update check in seconds
        CheckDelayInSeconds: 3600
      #Auto update HyEssentials or not
      HyEssentials: true
      #Check for YUM and bypass it's network block
      YumNetworkCheckBypass: true
    AutoBackupConfig:
      #Enable auto config backup or not
      Enable: true
      #Auto config backup only on plugin update or every time it saves
      WhenPluginUpdate: true
    #DO NOT CHANGE THIS
    Plugins:
      HyUltXChat:
        PluginYmlURL: https://raw.githubusercontent.com/hykilpikonna/HyUltimatePlugin/master/out/production/HyUltXChat/plugin.yml
        JarURL: https://raw.githubusercontent.com/hykilpikonna/HyUltimatePlugin/master/Build/HyUltXChat.jar
      HyUltXFix:
        PluginYmlURL: https://raw.githubusercontent.com/hykilpikonna/HyUltimatePlugin/master/out/production/HyUltXFix/plugin.yml
        JarURL: https://raw.githubusercontent.com/hykilpikonna/HyUltimatePlugin/master/Build/HyUltXFix.jar
      HyUltXFun:
        PluginYmlURL: https://raw.githubusercontent.com/hykilpikonna/HyUltimatePlugin/master/out/production/HyUltXFun/plugin.yml
        JarURL: https://raw.githubusercontent.com/hykilpikonna/HyUltimatePlugin/master/Build/HyUltXFun.jar
      HyUltXUtil:
        PluginYmlURL: https://raw.githubusercontent.com/hykilpikonna/HyUltimatePlugin/master/out/production/HyUltXUtil/plugin.yml
        JarURL: https://raw.githubusercontent.com/hykilpikonna/HyUltimatePlugin/master/Build/HyUltXUtil.jar
    DefaultConfig: false
    ConfigVersion: 0.1.7.9.114
    #Auto update settings
    AutoUpdate:
      #Enable or not
      Enable: true
      #Delay per update check in seconds
      CheckDelay: 3200
      #Auto update settings for this plugin
      HyUltimatePlugin:
        #Enable or not
        Enable: true
        #Check repeatly or just check once on start
        Repeat: false
        #Plugin yml link
        PluginYmlURL: https://raw.githubusercontent.com/hykilpikonna/HyUltimatePlugin/master/out/production/HyUlt/plugin.yml
        #Latest version download link
        JarURL: https://raw.githubusercontent.com/hykilpikonna/HyUltimatePlugin/master/Build/HyUlt.jar
      #Other settings
      Default:
        #The key name fully explained this
        TimeoutInSeconds: 3
        #Delay per update check in seconds
        CheckDelayInSeconds: 3600
      #Auto update HyEssentials or not
      HyEssentials: true
      #Check for YUM and bypass it's network block
      YumNetworkCheckBypass: true
    AutoBackupConfig:
      #Enable auto config backup or not
      Enable: true
      #Auto config backup only on plugin update or every time it saves
      WhenPluginUpdate: true
    #DO NOT CHANGE THIS
    Plugins:
      HyUltXChat:
        PluginYmlURL: https://raw.githubusercontent.com/hykilpikonna/HyUltimatePlugin/master/out/production/HyUltXChat/plugin.yml
        JarURL: https://raw.githubusercontent.com/hykilpikonna/HyUltimatePlugin/master/Build/HyUltXChat.jar
      HyUltXFix:
        PluginYmlURL: https://raw.githubusercontent.com/hykilpikonna/HyUltimatePlugin/master/out/production/HyUltXFix/plugin.yml
        JarURL: https://raw.githubusercontent.com/hykilpikonna/HyUltimatePlugin/master/Build/HyUltXFix.jar
      HyUltXFun:
        PluginYmlURL: https://raw.githubusercontent.com/hykilpikonna/HyUltimatePlugin/master/out/production/HyUltXFun/plugin.yml
        JarURL: https://raw.githubusercontent.com/hykilpikonna/HyUltimatePlugin/master/Build/HyUltXFun.jar
      HyUltXUtil:
        PluginYmlURL: https://raw.githubusercontent.com/hykilpikonna/HyUltimatePlugin/master/out/production/HyUltXUtil/plugin.yml
        JarURL: https://raw.githubusercontent.com/hykilpikonna/HyUltimatePlugin/master/Build/HyUltXUtil.jar
    DefaultConfig: false
    ConfigVersion: 0.1.7.9.114
     

    There would be folders called "Permissions", "Messages", and "Features" in every sub plugin.
    Also, a folder called "Backup" if you have enabled auto backup, and which you can delete anytime, and a folder called "Database" if you enabled any features that save their data in the database.

    Permissions:
    In the permissions config, you can customize every permission node and change the boolean value of if the permissions are required or not.​

    Messages:

    There is a prefix value in every message config file. It changes the prefix of every message in that file.
    The Chinese translation of the language files would be created when the plugin is running for the first time, and the English translation of the language files could be downloaded here.
    Features:
    It is the main config file for every single feature.
    Settings of every feature could be configured there.
    For detailed tutorial for every single feature, take a look at this page
    Backup:
    The backup files are named in a format like this: [email protected] and time.yml
    [​IMG]

    Default Config and Config Version:
    You might already have noticed that there is "DefaultConfig" and "ConfigVersion" in every single config file. They are used to detect the config version. Manually changing the value is not recommended unless you have looked at the source code and sure about that changing it won't have negitive effects.
  • Loading...
  • Loading...