main/Server Admins Info
Server Admins Info
Get started by downloading MCClans (Not MCClansAPI!) from the Files and place it with your other plugins.
Dependencies
MCClans has the following dependencies:
- UUIDCacher [required]: Is used to cache player UUIDs and names. This plugin is required for MCClans to function.
- Vault [optional]: Is used to charge players ingame currency for certain functions. This plugin is optional.
Config
-config.yml
| Config option | Parameters | Description |
|---|---|---|
| GENERAL | ||
| debugging | true/false | Display debug messages in console |
| use-permissions | true/false | If set to false, admin command access defaults to players with OP access |
| teleport-delay-seconds | number | Delay before teleporting players to their clan home |
| teleport-cooldown-seconds | number | The time players need to wait before being able to teleport to clan home. Set to 0 to disable |
| re-set-clanhome-cooldown-seconds | number | The time players need to wait before being able to set the clan home again. Set to 0 to disable |
| use-chat-clan-tags | true/false | Display clan tags in chat |
| use-colored-tags-based-on-clan-kdr | true/false | Give a special color to the clan tag brackets for the three highest clans based on KDR |
| allow-ff-protection | true/false | Allow players and clans to enable friendly fire protection |
| log-player-kdr | true/false | Track player kills and deaths |
| blocked-worlds-ff-protection: | worldname1, worldname2, etc. | Friendly fire is disabled in these worlds |
| blocked-worlds-player-kdr: | worldname1, worldname2, etc. | Player kills and deaths are not tracked in these worlds |
| create-backup-after-hours | number | Create a data backup every x hours in the MCClans/data/backup folder. Set to 0 to disable |
| maximum-amount-of-backups-before-removing-oldest | number | Maximum amount of backups to create before removing the oldest |
| remove-inactive-clanplayers-after-days | number | Delete ClanPlayers after x amount of days. Set to 0 to disable |
| remove-inactive-clanowners-including-clan | true/false | Remove ClanPlayers even if they own a clan. This causes the clan to disband |
| clan-tag-regex | ex. '[A-Za-z0-9_]+' | Limit the characters allowed in the clan tag |
| clan-tag-characters-minimum | number | Minimum amount of characters allowed in the clan tag |
| clan-tag-characters-maximum | number | Maximum amount of characters allowed in the clan tag |
| clan-name-regex | ex. '[A-Za-z0-9_]+' | Limit the characters allowed in the clan name |
| clan-name-characters-minimum | number | Minimum amount of characters allowed in the clan name |
| clan-name-characters-maximum | number | Maximum amount of characters allowed in the clan name |
| DATABASE_SETTINGS | ||
| use-database | true/false | Use a database. Data is otherwise stored in the MCClans/data/recent folder, as flatfile |
| dbms-type | mysql/sqlite | Database type |
| database-server-port | number | Database server port |
| database-server | localhost/<ip>/<domain> | Database server location |
| database-name | name | Database name |
| database-server-user | username | Database username |
| database-server-password | password | Database password |
| ECONOMY_SETTINGS | ||
| use-economy | true/false | Charge players configured costs. Requires Vault |
| clan-creation-cost | number | Cost for creating a clan |
| set-clanhome-cost | number | Cost for setting the clan home |
| re-set-clanhome-cost-increase | number | Increase the cost for changing the clan home |
| teleport-cost | number | Cost for teleporting to clan home |
| COMMAND_ALIASES | ||
| command alias | clan command | ex. /clanff: /clan friendlyfire clan toggle. Alias must be one word. Command must start with 'clan' |
Commands
| Command | Description | Clan perm. | Bukkit perm. |
|---|---|---|---|
| USER COMMANDS | |||
| /clan help {page} | Lists all commands available | mcclans.user.help | |
| /clan page <page> | Browse the pages of a table | mcclans.user.page | |
| /clan price | See all the costs associated with clans | mcclans.user.price | |
| /clan create <clanTag> <clanName> | Create a clan | mcclans.user.create | |
| /clan disband | Disband a clan | disband | mcclans.user.disband |
| /clan list | Lists all the clans | mcclans.user.list | |
| /clan leaderboard | Lists all players sorted by KDR | mcclans.user.leaderboard | |
| /clan info {clanTag} | Get the info of a clan | mcclans.user.info | |
| /clan roster {clanTag} | See the members of a clan | mcclans.user.roster | |
| /clan stats {clanTag} | See the statistics of a clan's members | mcclans.user.stats | |
| /clan friendlyfire clan toggle [/clanff] | Toggle the clan's friendly fire protection | friendlyfire | mcclans.user.friendlyfire.clan |
| /clan friendlyfire personal toggle [/personalff] | Toggle your personal friendly fire protection | mcclans.user.friendlyfire.personal | |
| /clan coords | See the coordinates of your clan members | coords | mcclans.user.coords |
| /clan resign | Resign from a clan | mcclans.user.resign | |
| /clan tag color <color> | Change the clan tag color | tag | mcclans.user.tag |
| /clan rank create <rankName> {permissions} | Create a rank | rank | mcclans.user.rank.create |
| /clan rank remove <rankName> | Remove a rank | rank | mcclans.user.rank.remove |
| /clan rank rename <rankName> <newRankName> | Rename a rank | rank | mcclans.user.rank.rename |
| /clan rank view {rankName} | View the properties of the rank or all ranks | rank | mcclans.user.rank.view |
| /clan rank permission set <rankName> <permissions> | Sets the given permissions to a rank | rank | mcclans.user.rank.permission.set |
| /clan rank permission add <rankName> <permissions> | Adds the given permissions to a rank | rank | mcclans.user.rank.permission.add |
| /clan rank permission remove <rankName> <permissions> | Removes the given permissions from a rank | rank | mcclans.user.rank.permission.remove |
| /clan rank permission view | View all available permissions | rank | mcclans.user.rank.permission.view |
| /clan player info {playerName} | Get the info of yourself or another player | mcclans.user.player.info | |
| /clan player setrank <playerName> <rankName> | Set the rank of a member of your clan | setrank | mcclans.user.player.setrank |
| /clan home | Teleport to your clan home | home | mcclans.user.home |
| /clan sethome | Set the location of your clan home | sethome | mcclans.user.sethome |
| /clan invite <playerName> | Invite a player to your clan | invite | mcclans.user.invite |
| /clan accept | Accept a pending clan invite | mcclans.user.accept | |
| /clan decline | Decline a pending clan invite | mcclans.user.decline | |
| /clan remove <playerName> | Remove a player from your clan | remove | mcclans.user.remove |
| /clan ally invite <clanTag> | Invite another clan to become an ally | ally | mcclans.user.ally.invite |
| /clan ally remove <clanTag> | Remove an allied clan | ally | mcclans.user.ally.remove |
| /clan ally inviteable toggle | Toggle if the clan is accepting ally invites | ally | mcclans.user.ally.inviteable |
| /clan ally accept | Accept a pending ally invite | ally | mcclans.user.ally.accept |
| /clan ally decline | Decline a pending ally invite | ally | mcclans.user.ally.decline |
| /clan chat global {message} [/g] | Talk in global chat | mcclans.user.chat.global | |
| /clan chat clan {message} [/cc] | Talk in clan chat | clanchat | mcclans.user.chat.clan |
| /clan chat ally {message} [/ac] | Talk in ally chat | allychat | mcclans.user.chat.ally |
| ADMIN COMMANDS | |||
| /clan admin reload | Reload the configuration | mcclans.admin.reload | |
| /clan admin backup | Backup the database | mcclans.admin.backup | |
| /clan admin create <owner> <clanTag> <clanName> | Create a clan | mcclans.admin.create | |
| /clan admin disband <clanTag> | Disband a clan | mcclans.admin.disband | |
| /clan admin home <clanTag> | Teleport to a clan home | mcclans.admin.home | |
| /clan admin sethome <clanTag> | Set the location of a clan home | mcclans.admin.sethome | |
| /clan admin invite <clanTag> <playerName> | Invite a player to a clan | mcclans.admin.invite | |
| /clan admin remove <clanTag> <playerName> | Remove a player from a clan | mcclans.admin.remove | |
| /clan admin coords <clanTag> | See the coordinates of a clan's members | mcclans.admin.coords | |
| /clan admin tag color <clanTag> <color> | Change a clan tag color | mcclans.admin.tag.color | |
| /clan admin setowner <clanTag> <playerName> | Set the owner of a clan | mcclans.admin.setowner | |
| /clan admin clanplayer setkills <playerName> <high> <medium> <low> | Set the kills of a player | mcclans.admin.clanplayer.setkills | |
| /clan admin clanplayer setdeaths <playerName> <high> <medium> <low> | Set the deaths of a player | mcclans.admin.clanplayer.setdeaths | |
| /clan admin clanplayer transfer <targetClanPlayer> <newPlayerName> | Transfer all player properties to a different player | mcclans.admin.clanplayer.transfer | |
| /clan admin clanplayer remove <playerName> | Remove all player properties | mcclans.admin.clanplayer.remove | |
Miscellaneous info
- Switching the server between online and offline mode is not supported.