Bukkit

Installation & Setup Considerations

Custom-Ranks Dependency Chart

• [CUSTOM-RANKS API]
• Custom-Ranks relies on Permissions-Ex for nearly all of its features this is a MANDATORY plugin
• Make sure you configure Pex to log Users in the Permissions.yml file!!
• [CUSTOMRANKS CHAT API]
• Chat relies on Towny as the plugin creates channels specifically for this plugin
• It relies on Vault compatible economy plugin for charging players money while executing certain chat related commands
• [CUSTOMRANKS MERCHANT RANKS API]
• Merchant ranks depend on ChestShop plugin as customers are logged through ChestShop Transactions
• If you enable features that depend on these plugins you will need these plugins installed!
• If you have features enabled in the config and these plugins are not detected Custom-Ranks will disable itself and send a message to console

New Installation

• For your first download simply place the jar in your plugins folder, start your server and then stop your server. Navigate to the Custom-Ranks folder in your plugins directory, open the config.yml file with a text editor and configure the plugins options. See the Setup Considerations section

• Navigate to your essentials folder and open the config.yml, under ignored commands add the command - jail

Updating To A New Version

• If you are updating to a new version and you have player data in the Database it its recommended that you create a backup of your .db file or. . create a backup in MySQL. Create a backup of the UsersConfig.yml and the Config.yml, delete the custom-ranks jar file and its folder, install the new version, then import your backup files to the custom-ranks folder. * note that it is important to read the updated files change-log to see how the updated version will impact your data. (some updates will not affect certian plugin files check the Change-Log

Setup Considerations

• Make sure you set the permission nodes for this plugin accordingly in Pex for your groups.
• Ensure you have the appropriate groups in Pex and that they are spelled and capitalized to match the permissions file
• All permission groups in pex should have a rank ladder name associated with them, here is an example of a compatible permission file

  Newcomer:
    options:
      default: true
      build: true
      prefix: '&7[&8Newcomer&7]'
      rank: ''
      rank-ladder: intro
    permissions:
    - essentials.kit
    - essentials.motd
    - essentials.spawn
    - essentials.tpa
    - essentials.tpaccept
    - essentials.tpdeny
  Settler:
    options:
      build: true
      prefix: '&7[&eSettler&7]'
      rank: ''
      rank-ladder: earned
    permissions:
    - customranks.title.me
    - customranks.color.me
  Trader:
    options:
      build: true
      prefix: '&7[&aTrader&7]'
      rank: ''
      rank-ladder: earned
    permissions:
    - customranks.title.me
    - customranks.color.me
  Sponsor:
    options:
      build: true
      prefix: '&2[S]'
      rank: ''
      rank-ladder: donationrank
    permissions:
    - essentials.fly
    - essentials.workbench
  Admin:
    options:
      build: true
      prefix: '&7[&8|&4|&8|&4Admin&8|&4|&8|&7]'
      rank: ''
      rank-ladder: staffrank
    permissions:
    - customranks.rank.promote
    - customranks.rank.demote
    - customranks.rank.info
    - customranks.mod.chat
    - customranks.admin.prefix
    - customranks.donor.info
    - customranks.channel.broadcast
    - customranks.channel.view
    - customranks.plugin.help
    - customranks.find.player
    - customranks.reload.config
    inheritance:
    - Mod
    - Resident

• Server reloading is not recommended for this plugin, If you need to reload your server it is recommended that you perform a full restart instead.
• Use caution when editing the config file. Avoid adding white spaces after values, deleting single quotes, or altering the space between the Key Value seporator ": "
• Most importantly make sure you configure the "Config.yml" file fully and properly to prevent errors :-)