ClansLite

ClansLite

ClansLite is a light-weight clans plugin for Minecraft servers running Spigot or any of its forks!

ClansLite does not support any grief prevention tools such as land claiming, it does support customisable single chest protections.

Want to try out the very latest dev builds? [Click here] Use the above dev build at your own risk! Please follow any and ALL instructions provided with EACH dev build released!

Use the above dev build at your own risk! Please follow any and ALL instructions provided with EACH dev build released!

###/clan command Aliases: /clans, /c, /cl

The /clan command is the main command of the plugin, with /clan you can do the following:

• /clan create - Creates A new clan if not already in one
• /clan disband - If you are the clan owner, this will destroy your clan
• /clan leave - If you are in a clan, this will remove you from it
• /clan invite - Will invite a player to your clan if they are not already in one
• /clan join - Will add you to a clan that you have been invited too.
• /clan kick - Will kick a player from your clan
• /clan info - Will display information about your current clan
• /clan list - Will list all clans in the server
• /clan prefix - Will change the prefix for your clan in chat
• /clan ally [add|remove] - Will either add or remove an allied clan to yours.
• /clan enemy [add|remove] - Will either add or remove an enemy clan to yours.
• /clan pvp - Will toggle the friendly fire status for your clan
• /clan [sethome|delhome|home] - Will set a clan home location or teleport you or your clan members to this location.
• /clan transfer - Transfer your clan to another owner.
• /clan playerpoints [listall] - View your current player point value or view all players points.
• /clan points [withdraw|deposit] - Deposit or withdraw points from/to your clan.

###/clanchat command Aliases: /clanchat, /clanc, /cchat, /chat

The /clanchat command is for the sole purpose of utilising the per clan chat. The following syntax is accepted:

• /clanchat - This will send a message to only the members of YOUR clan or the clan you are in.

###/clanchest command Aliases: /cchest, /cch, /cht

The /clanchest command is the base command to use the chest protection system, with /clanchest you can do the following:

• /clanchest lock - Lock the single chest that you're looking at.
• /clanchest unlock - Unlock the single chest that you're looking at.
• /clanchest accesslist - See what players have access to that chest.
• /clanchest buylock - Purchase a new chest lock or multiple.

###/clanchatspy command Aliases: /cs, /ccs, /spy

The /clanchatspy command allows admins to spy on the secret clan chats, with /clanchatspy you can do the following:

• /clanchatspy - Toggle the clan chat spying ability.

###/clanadmin command Aliases: /ca, /cla

The /clanadmin command is purely for server admins only. 4 arguments are implemented which are:

• /clanadmin save - which will save all current clan info to the clans.yml data file.
• /clanadmin reload - This reloads the plugins config.yml & the messages.yml files from disk.
• /clanadmin disband - This allows admins to delete any clans using the clans owner name.
• /clanadmin disband byname: - This allows admins to delete any clans using the clans name.
• /clanadmin info - This allows admins to see all the info about the provided clan.
• /clanadmin playerinfo - This allows admins to see all the info about the provided player's clan.
• /clanadmin visithome - This allows admins to visit the provided clans home location.
• /clanadmin about - This give you an overview of the plugin's core information.

###Permissions

plugin.yml

```
name: ClansLite
version: 1.6.1

commands:
  clan:
    description: Create, delete and manage clans!
    usage: "Usage: /clan [create|disband|invite|kick|info|list|prefix|transfer|ally|enemy|sethome|delhome|home|points|playerpoints]"
    aliases:
     - clans
      - c
      - cl
  topclans:
    description: View the top clans on the server.
    usage: "Usage: /topclans"
    aliases:
     - topc
      - tc
  clanadmin:
    description: Admin commands for clans.
    usage: "Usage: /clanadmin [save|reload|about]"
    permission: clanslite.admin
    aliases:
     - ca
      - cla
  clanchat:
    description: Send a message to your clan members only.
    usage: "Usage: /clanchat <message>"
    aliases:
     - clanc
      - cchat
      - chat
  clanchatspy:
    description: Allows admins to see ALL clan chat messages.
    usage: "Usage: /clanchatspy"
    aliases:
     - cs
      - ccs
      - spy
  clanchest:
    description: Protect your clan chests.
    usage: "Usage: /clanchest [lock|unlock|accesslist|buylock]"
    aliases:
     - cchest
      - cch
      - cht

permissions:
  clanslite.*:
    default: op
    description: "The main permission that allows access to ALL ClansLite features (Admin features included)."
    children:

      clanslite.admin:
        description: "The admin permission that grants ALL admin features."
        children:
          clanslite.chat.spy:
            default: op
            description: "The permission to use the `/clanchatspy` command and feature."
          clanslite.update:
            default: op
            description: "The permission to receive in game notification if a plugin update is available."
          clanslite.maxclansize.*:
            default: op
            description: "The ability to have an unlimited number of clan members."
          clanslite.points.listall:
            default: op
            description: "The ability to use the `/clan playerpoints listall` command to see all players points."

          clanslite.command.chat:
            default: true
            description: "The ability to use the `/clanchat <message>` command."

          clanslite.command.chest.*:
            default: op
            description: "The ability to use all `/clanchest` commands."
            children:
              clanslite.command.chest.accesslist:
                default: true
                description: "The ability to use the `/clanchest accesslist` command."
              clanslite.command.chest.buylock:
                default: true
                description: "The ability to use the `/clanchest buylock` command."
              clanslite.command.chest.lock:
                default: true
                description: "The ability to use the `/clanchest lock` command."
              clanslite.command.chest.unlock:
                default: true
                description: "The ability to use the `/clanchest unlock` command."

          clanslite.command.clan.*:
            default: op
            description: "The ability to use all `/clan` commands."
            children:
              clanslite.command.clan.ally:
                default: true
                description: "The ability to use the `/clan ally` command."
              clanslite.command.clan.create:
                default: true
                description: "The ability to use the `/clan create` command."
              clanslite.command.clan.delhome:
                default: true
                description: "The ability to use the `/clan delhome` command."
              clanslite.command.clan.disband:
                default: true
                description: "The ability to use the `/clan disband` command."
              clanslite.command.clan.enemy:
                default: true
                description: "The ability to use the `/clan enemy` command."
              clanslite.command.clan.home:
                default: true
                description: "The ability to use the `/clan home` command."
              clanslite.command.clan.info:
                default: true
                description: "The ability to use the `/clan info` command."
              clanslite.command.clan.invite:
                default: true
                description: "The ability to use the `/clan invite` command."
              clanslite.command.clan.join:
                default: true
                description: "The ability to use the `/clan join` command."
              clanslite.command.clan.kick:
                default: true
                description: "The ability to use the `/clan kick` command."
              clanslite.command.clan.leave:
                default: true
                description: "The ability to use the `/clan leave` command."
              clanslite.command.clan.list:
                default: true
                description: "The ability to use the `/clan list` command."
              clanslite.command.clan.playerpoints:
                default: true
                description: "The ability to use the `/clan playerpoints` command."
              clanslite.command.clan.points:
                default: true
                description: "The ability to use the `/clan points` command."
              clanslite.command.clan.prefix:
                default: true
                description: "The ability to use the `/clan prefix` command."
                children:
                  clanslite.command.clan.prefix.prefixcolors:
                    default: true
                    description: "The ability to add colours and styling to the clan prefix."
              clanslite.command.clan.pvp:
                default: true
                description: "The ability to use the `/clan pvp` command."
              clanslite.command.clan.sethome:
                default: true
                description: "The ability to use the `/clan sethome` command."
              clanslite.command.clan.top:
                default: true
                description: "The ability to use the `/clan top` command."
              clanslite.command.clan.transfer:
                default: true
                description: "The ability to use the `/clan transfer` command."

          clanslite.bypass.*:
            default: op
            description: "The master bypass permission that allows bypassing of ALL internal limits and protections."
            children:
              clanslite.bypass.homecooldown:
                default: op
                description: "The ability to bypass the `/clan home` cooldown timer."
              clanslite.bypass.homedelay:
                default: op
                description: "The ability to bypass the `/clan home` warm up delay timer."
              clanslite.bypass.chatcooldown:
                default: op
                description: "The ability to bypass the `/clanchat <message>` cooldown timer."
              clanslite.bypass.chests:
                default: op
                description: "The ability to bypass the protections on any locked chests."
              clanslite.bypass.pvp:
                default: op
                description: "The ability to bypass the friendly fire status set by a clan."
```
  

Configs

config.yml

messages.yml

clangui.yml

###Chat prefix ClansLite exposes a variable of {CLAN} to use in Essentials Chat or similar.

Simply add the {CLAN} placeholder into the chat.format string in the EssentialsX config.yml in the location you'd like it to appear in your chat. Reload EssentialsX or restart the server and the clan prefix should appear like magic!

If you have issues with the {CLAN} placeholder not working, please see this guide for a fix

###Placeholder API Full list of current available placeholders:

To be able to use these The latest release of PlaceholderAPI MUST be installed! Without it, only the {CLAN} will be available for use with EssentialsX Chat.

• %clansLite_pluginVersion%

• %clansLite_pluginAuthor%

• %clansLite_baseServerVersion%

• %clansLite_serverPackage%

• %clansLite_clanName%

• %clansLite_clanPrefix%

• %clansLite_friendlyFire%

• %clansLite_clanHomeSet%

• %clansLite_clanMembersSize%

• %clansLite_clanAllySize%

• %clansLite_clanEnemySize%

• %clansLite_playerPointBalance%

• %clansLite_clanPointBalance%

• %clansLite_clanChestMaxAllowed%

• %clansLite_clanChestCurrentLocked%

• %clansLite_topClanName_<number>%

• %clansLite_topClanValue_<number>%

• %clansLite_topPlayerName_<number>%

• %clansLite_topPlayerValue_<number>%

  NO PAPI ECLOUD DOWNLOAD IS REQUIRED! ALL PLACEHOLDERS ARE INTERNAL TO CLANSLITE

###API Implementation ClansLite has a full featured API that allows any developer to access the internals of the plugin and add functionality that I haven't thought of yet!

To see how to use this, check out the ClansLite Wiki.

To Do

• Add clan chat system - DONE v1.2.2
• Add command tab completion - DONE v1.3.0-BETA
• Add GUI system - DONE v1.3.0-BETA
• Add admin ability to visit clan homes - DONE v1.5.3
• Add admin view of clan chats - DONE v1.3.9
• Add clan chest protection system - DONE v1.3.9
• Add ability for admins to delete clans - DONE v1.3.1
• Add numerical value for clan members list - DONE v1.2.4
• Add public announcement when a clan is created - DONE v1.2.4

Please report any issues and feel free to join my discord

DO NOT POST ISSUES OR ERRORS IN THE REVIEWS SECTION! ANY POSTED IN THERE WILL BE IGNORED! PLEASE POST IN THE DISCUSSION THREAD OR JOIN OUR DISCORD AND CREATE A SUPPORT TICKET!