Post by bonghead69 on Jan 15, 2012 4:31:03 GMT -5
Main Menu
You can add the name of your server in the configuration to give the main menu a more personalized look. The main menu can be accessed by using the /clan command and will show the player only the commands he has access to at any given time.
•Untrusted members of clans have basic commands
•Trusted members of clans have advanced commands
•Leaders of clans have clan administration commands
•Mods have access to global commands
•Unverified clans have a restricted command list
•Verified clans have an unrestricted command list
•Leaders of verified clans have all clan functionality
•Leaders of verified clans that are also mods have the full set (seen below)
Clan Alliances and Rivalries
Any clan leader can send an request to start an alliance with any other clan with /clan ally add. If the request is accepted by a leader of the second clan, the alliance is formed. The alliance can be broken by any leader of either clan at any time with /clan ally remove, no one needs to accept the removal of an alliance.
Clan rivalries can be started by any clan at any time, no request is needed, rivalries are automatically formed once a clan leader decides he wants one by using /clan rival add. If someone has pissed you off and you want them as rivals, their permission is not needed. To break a clan rivalry on the other hand, you need the acceptance of the other clan, you must use /clan rival remove to send the other clan a request, once one of their leaders accept the rivalry is broken.
You can view a list of all clans and their allies with the /clan alliances command, or their rivals with the /clan rivalries command.
* Example of the clan alliances page
* Example of the clan rivalries page
Kill/Death Ratio
Once a player is part of a verified clan, all his kills will start to be recorded. Deaths by other player's are also recorded. All kills are not equal. Killing a member of a rival clan, of a neutral clan, and a civilian not attached to any clan all carry different weights. Rival: 1.5, Neutral: 1, Civilian: 0.5 (configurable). The weights can also carry negative values, for example if you want to discourage killing civilians, you may want to set the civilian weight to -1 to lower the KDR with every civilian kill.
Each player has a Kill/Death Ratio.score that is calculated and attributed to them. This is the ratio between your kills and your Deaths (your weighted kills divided by your deaths). This is the metric that shows a player's skill level.
For example, If your weighted kills are 1000 points but you died twice as much, say 2000 times, then your KDR will be low (.5), far lower than a player who only killed 20 players but died only 1 time (KDR of 20). This is THE metric that determines how good of a PvPer you are. The higher the KDR the more worth you are to your clan. A noob that has been playing for a few months can amass a huge amount of kills and claim to be good at pvp, but his low ass Kill/Death ratio wont lie.
Kills and Deaths will only be recorded if you are in a verified clan. If you resign from your clan and become a free agent, your kills and deaths will stop being recoded and your KDR will freeze until you join another verified clan.
Your server's players do not need to know the math in order to play. They can just go on their merry way doing what they were doing before, and their KDR will start being calculated which they can then see in their clan's stats page and your server's leaderboard. If they suck at pvp they will be low on the lists, if they are good they will show near the top. They will be able to compare their skill with someone elses based on their KDR.
Friendly Fire
Players in the same clan and players in allied clans have friendly fire protection from each other, they won't be able to hurt each other. Leaders of clans can turn this on and off with the /clan clanff command, you can either allow or block friendly fire. Each player can also turn off his own friendly fire protection at any time using the /clan ff command, he will be able to allow friendly fire or to set it to auto, which is whatever the clanff is. He will not be able to block friendly fire if his clan has allowed it, but he will be able to allow it if his clan has blocked it.
Moderators have access to the /clan globalff command, this command allows you to set the global friendly-fire setting to either allowed or auto. Allowed will effectively allow everyone to harm everyone else, turning off friendly fire protection. This command is useful for when you are having a server-wide tournament and want to ensure that no one is cheating by using the clan protection. Setting globalff back to auto will give back the friendly fire control to each clan's or persons settings.
Clan Types
There are two types of clans, verified and unverified clans. When a player first creates a clan it will be of type unverified. These clans have a reduced feature set, no coords, vitals, stats, etc, they will not show up on any clan listings, and are automatically deleted if none of its members log in for 48 hours (configurable). Their purpose is to give your members quick and easy teaming up abilities without polluting your server with dozens of abandoned one off clans.
Once one of your moderators can verify that the clan is legit, he can upgrade it to verified status. At this point the clan and its members will then be able to enjoy the full feature set of the SimpleClans plugin. Verified clans have an inactivity timer of 7 days (configurable).
Optionally you can disable the clan verification feature in the config to make it so newly created clans are automatically verified.
Clan Tags
When a clan is created, you must give it a name and a tag. The tag will be used as the unique identifier for you clan, will be used in the clan commands, and will pretty much represent your clan. This tag can have color codes which can be later modified. For example, If i wanted to create a clan named "Knights of the Labyrinth" with a red and white tag named "kol", I would use the following create command:
/clan create &4K&Fo&4l Knights of the Labyrinth
Later on if I wanted to modify this tag, for example I wanted to make it all red instead of red and white and all uppercase I would use the modtag command. Note: with the modtag command you can only change colors and case, but not the letters that make up the tag
/clan modtag &4KOL
The colored tag will prefix all clan player's names on chat, don't worry it works alongside your existing prefixes and chat plugins.
Compatible with:
•mChat
•HeroChat
* Staff, GBH, Tol, are clans. The hearts "<3" are group prefixes.
Clan Home-Bases
Clans can set a home-base locations for their clans with /clan home set. The clan must be verified and only the leader is able to use this command, and he is able to use it only once. Once the home base is set it cannot be changed. This is to prevent players setting home bases in the middle of battlefields, enemy camps etc. The only ones who can change it are mods with the /clan home set [tag] command.
Once home is set any member is able to /clan home at any time to teleport back to their home base. Leaders have permissions for a powerful command /clan home regroup, which will teleport all clan members to the home base. This is useful for when your home base is being raided, or when you want to coordinate an event or raid.
Before a player is teleported he must wait a pre-configured amount of seconds on the same block. This is to prevent them from running away from pvp fights. If they move before the warmup time is expired, then the teleport is canceled. Warmup timer for teleport can be configured with the clan.homebase-teleport-wait-secs config setting. If set to 0, the warmup is disabled.
Clan Bulletin Board
All clan activity is logged on the server's log files. The last few events (configurable) are displayed to each clan member when they log in giving them an overview of the clan's activities. This list can also be pulled up at any time with the /clan bb command. Trusted members can add messages to the bulletin board using the /clan bb [msg] command. Messages added to the bulletin board are also announced to any members that are currently online. Each individual player can toggle the display of the bb on join with /clan bb toggle.
Clan Chat
Each clan will automatically have access to clan chat using their tag. For example a team that has a tag named "staff" will be able to use clan chat with the command /staff. The colors and look of the clan chat are fully customizable.
The following functionality is available:
•/[tag] [msg] - Allows you to speak in clan chat
•/[tag] join - Allows you to join this chat, all messages sent will be sent only to the clan chat
•/[tag] leave - Leaves the chat. Your messages will now go to global chat.
•/[tag] off - Disables the display of clan chat messages on your screen. (except those with the "simpleclans.mod.nohide" permission)
•/[tag] on - Enables the display of clan chat messages on your screen.
Ally Chat
You team and its allies are able to talk to each other by using the /ally command. Any messages you send will be visible by your clan and its allies, and you will be able to see any messages sent by your allies.
The following functionality is available:
•/ally [msg] - Allows you to speak in ally chat
•/ally join - Allows you to join this chat, all messages sent will be sent only to the ally chat
•/ally leave - Leaves the chat. Your messages will now go to global chat.
•/ally off - Disables the display of ally messages on your screen. (except those with the "simpleclans.mod.nohide" permission)
•/ally on - Enables the display of ally messages on your screen.
Global Chat
The default minecraft chat, you are here when you no longer in ally or clan chat.
The following functionality is available:
•/global off - Disables the display of global chat messages on your screen. (except those with the "simpleclans.mod.nohide" permission)
•/global on - Enables the display of global chat messages on your screen.
Clan Capes and Titles
If using Spout, you will be able to see capes and in-game titles with the clan tag on all clan players. You can configure the in-game titles can be fully configured, colored vs black and white and the barackets and or separator. Note: Clan tags go away when the player is sneaking. All players inside a clan start with a default cape (configurable), verified clan leaders will be able to choose a unique cape for their clan using the /clan cape command. Individual players can toggle on/off their capes with /clan cape toggle
Inviting Members
Creators of clans will become the first clan leader. They can invite other members into the clan with /clan invite. These members are first added with the untrusted status. These members will not be able to view clan vitals, coords, or stats. This is to prevent players form joining clans just to spy on other clans by writing down coordinates of bases or viewing vitals during battles. Once a player has gained the clan's trust he can be upgraded to trusted status with /clan trust.
You can have multiple leaders on a clan. You can promote other leaders using the /clan promote command. To promote a leader all other leaders must be online and must accept the vote. A leader cannot be promoted unilaterally without the consent of all other leaders. Demotion using the /clan demote command works the same way.
A moderator can completely ban a player form ever joining any clans with the /clan ban/unban command.
* Example of a clan invite request
Clan List
You can view all the clans on your server using the /clan list command. The clans are sorted by KDR.
Leaderboard
With the /clan leaderboard you can compare all clan players. The leaderboard is sorted by KDR, this will tell you who to fear, or what free agent you may want to invite to your clan.
Clan Roster
The /clan roster command shows you the members of your clan. Here you can see your clan's members status as well as when the last time they were seen online was.
Clan Vitals
The /clan vitals command shows you the vitals of all online members of your clan. Here you can see their health, what armor and weapons they are carrying and of what materials, and how many hearts all of their food contains. This comes in handy during battle to know who you need to help and who can bring help to you.
Clan Coordinates
The /clan coords command shows you the distance and coordinates of all online members of you clan, sorted by distance. With this you will be able to know who to call for help during a raid/battle.
Clan Stats
Your clan's stats screen, opened with the /clan stats command, shows you all of your clan members KDR, raw kills, and deaths stats. Leaders show on the top and members on the bottom. Leaders are sorted by KDR, and members are sorted by KDR. This screen tells you who are the strongest leaders, and who are the strongest members. It will also show you the current weights for the different types of kills.
Player Lookup
You can look up your own or another players info using /clan lookup command. This gives you all the data concerning the player, his KDR, his kills and deaths, what clan he belongs to, the date when he joined the clan, his status in the clan, when he was last seen, a list of all past clans hes been part of, and how many days he has been inactive for.
Clan Profile
With the /clan profile command you can view details about any clan. It shows you the clan leaders, how many members are currently online, the KDR, the sum of all kills and deaths of all members of the clan, allies, rivalries, the date founded, and how many days it has been inactive for.
Protection
SimpleClans is deeply integrated with the PreciousStones protection system. You can add your entire clan to any PreciousStones protection field or any kind of field for that matter by using your clan's tag:
/ps allow c:clan
*allow, remove, allowall, removeall work the same way
If you are in a clan, every field that you place will automatically have your clan in the allowed list.
Note: This functionality can be provided by any protection system by hooking into our API
War
If you are using PreciousStones protection then your clans will be able to get into wars. A clan can enter into a war with a rival by sending a war request with /clan war. Once the rival accepts, all fields belonging to all members of on clan, and all fields that have that clan in their allowed list will have no effect on the opposing clan. Both clans will be free to raid the others strongholds with all protection disabled. This will last until one of the clans requests to end the war and the other accepts.
Note: This functionality can be provided by any protection system by hooking into our API
You can add the name of your server in the configuration to give the main menu a more personalized look. The main menu can be accessed by using the /clan command and will show the player only the commands he has access to at any given time.
•Untrusted members of clans have basic commands
•Trusted members of clans have advanced commands
•Leaders of clans have clan administration commands
•Mods have access to global commands
•Unverified clans have a restricted command list
•Verified clans have an unrestricted command list
•Leaders of verified clans have all clan functionality
•Leaders of verified clans that are also mods have the full set (seen below)
Clan Alliances and Rivalries
Any clan leader can send an request to start an alliance with any other clan with /clan ally add. If the request is accepted by a leader of the second clan, the alliance is formed. The alliance can be broken by any leader of either clan at any time with /clan ally remove, no one needs to accept the removal of an alliance.
Clan rivalries can be started by any clan at any time, no request is needed, rivalries are automatically formed once a clan leader decides he wants one by using /clan rival add. If someone has pissed you off and you want them as rivals, their permission is not needed. To break a clan rivalry on the other hand, you need the acceptance of the other clan, you must use /clan rival remove to send the other clan a request, once one of their leaders accept the rivalry is broken.
You can view a list of all clans and their allies with the /clan alliances command, or their rivals with the /clan rivalries command.
* Example of the clan alliances page
* Example of the clan rivalries page
Kill/Death Ratio
Once a player is part of a verified clan, all his kills will start to be recorded. Deaths by other player's are also recorded. All kills are not equal. Killing a member of a rival clan, of a neutral clan, and a civilian not attached to any clan all carry different weights. Rival: 1.5, Neutral: 1, Civilian: 0.5 (configurable). The weights can also carry negative values, for example if you want to discourage killing civilians, you may want to set the civilian weight to -1 to lower the KDR with every civilian kill.
Each player has a Kill/Death Ratio.score that is calculated and attributed to them. This is the ratio between your kills and your Deaths (your weighted kills divided by your deaths). This is the metric that shows a player's skill level.
For example, If your weighted kills are 1000 points but you died twice as much, say 2000 times, then your KDR will be low (.5), far lower than a player who only killed 20 players but died only 1 time (KDR of 20). This is THE metric that determines how good of a PvPer you are. The higher the KDR the more worth you are to your clan. A noob that has been playing for a few months can amass a huge amount of kills and claim to be good at pvp, but his low ass Kill/Death ratio wont lie.
Kills and Deaths will only be recorded if you are in a verified clan. If you resign from your clan and become a free agent, your kills and deaths will stop being recoded and your KDR will freeze until you join another verified clan.
Your server's players do not need to know the math in order to play. They can just go on their merry way doing what they were doing before, and their KDR will start being calculated which they can then see in their clan's stats page and your server's leaderboard. If they suck at pvp they will be low on the lists, if they are good they will show near the top. They will be able to compare their skill with someone elses based on their KDR.
Friendly Fire
Players in the same clan and players in allied clans have friendly fire protection from each other, they won't be able to hurt each other. Leaders of clans can turn this on and off with the /clan clanff command, you can either allow or block friendly fire. Each player can also turn off his own friendly fire protection at any time using the /clan ff command, he will be able to allow friendly fire or to set it to auto, which is whatever the clanff is. He will not be able to block friendly fire if his clan has allowed it, but he will be able to allow it if his clan has blocked it.
Moderators have access to the /clan globalff command, this command allows you to set the global friendly-fire setting to either allowed or auto. Allowed will effectively allow everyone to harm everyone else, turning off friendly fire protection. This command is useful for when you are having a server-wide tournament and want to ensure that no one is cheating by using the clan protection. Setting globalff back to auto will give back the friendly fire control to each clan's or persons settings.
Clan Types
There are two types of clans, verified and unverified clans. When a player first creates a clan it will be of type unverified. These clans have a reduced feature set, no coords, vitals, stats, etc, they will not show up on any clan listings, and are automatically deleted if none of its members log in for 48 hours (configurable). Their purpose is to give your members quick and easy teaming up abilities without polluting your server with dozens of abandoned one off clans.
Once one of your moderators can verify that the clan is legit, he can upgrade it to verified status. At this point the clan and its members will then be able to enjoy the full feature set of the SimpleClans plugin. Verified clans have an inactivity timer of 7 days (configurable).
Optionally you can disable the clan verification feature in the config to make it so newly created clans are automatically verified.
Clan Tags
When a clan is created, you must give it a name and a tag. The tag will be used as the unique identifier for you clan, will be used in the clan commands, and will pretty much represent your clan. This tag can have color codes which can be later modified. For example, If i wanted to create a clan named "Knights of the Labyrinth" with a red and white tag named "kol", I would use the following create command:
/clan create &4K&Fo&4l Knights of the Labyrinth
Later on if I wanted to modify this tag, for example I wanted to make it all red instead of red and white and all uppercase I would use the modtag command. Note: with the modtag command you can only change colors and case, but not the letters that make up the tag
/clan modtag &4KOL
The colored tag will prefix all clan player's names on chat, don't worry it works alongside your existing prefixes and chat plugins.
Compatible with:
•mChat
•HeroChat
* Staff, GBH, Tol, are clans. The hearts "<3" are group prefixes.
Clan Home-Bases
Clans can set a home-base locations for their clans with /clan home set. The clan must be verified and only the leader is able to use this command, and he is able to use it only once. Once the home base is set it cannot be changed. This is to prevent players setting home bases in the middle of battlefields, enemy camps etc. The only ones who can change it are mods with the /clan home set [tag] command.
Once home is set any member is able to /clan home at any time to teleport back to their home base. Leaders have permissions for a powerful command /clan home regroup, which will teleport all clan members to the home base. This is useful for when your home base is being raided, or when you want to coordinate an event or raid.
Before a player is teleported he must wait a pre-configured amount of seconds on the same block. This is to prevent them from running away from pvp fights. If they move before the warmup time is expired, then the teleport is canceled. Warmup timer for teleport can be configured with the clan.homebase-teleport-wait-secs config setting. If set to 0, the warmup is disabled.
Clan Bulletin Board
All clan activity is logged on the server's log files. The last few events (configurable) are displayed to each clan member when they log in giving them an overview of the clan's activities. This list can also be pulled up at any time with the /clan bb command. Trusted members can add messages to the bulletin board using the /clan bb [msg] command. Messages added to the bulletin board are also announced to any members that are currently online. Each individual player can toggle the display of the bb on join with /clan bb toggle.
Clan Chat
Each clan will automatically have access to clan chat using their tag. For example a team that has a tag named "staff" will be able to use clan chat with the command /staff. The colors and look of the clan chat are fully customizable.
The following functionality is available:
•/[tag] [msg] - Allows you to speak in clan chat
•/[tag] join - Allows you to join this chat, all messages sent will be sent only to the clan chat
•/[tag] leave - Leaves the chat. Your messages will now go to global chat.
•/[tag] off - Disables the display of clan chat messages on your screen. (except those with the "simpleclans.mod.nohide" permission)
•/[tag] on - Enables the display of clan chat messages on your screen.
Ally Chat
You team and its allies are able to talk to each other by using the /ally command. Any messages you send will be visible by your clan and its allies, and you will be able to see any messages sent by your allies.
The following functionality is available:
•/ally [msg] - Allows you to speak in ally chat
•/ally join - Allows you to join this chat, all messages sent will be sent only to the ally chat
•/ally leave - Leaves the chat. Your messages will now go to global chat.
•/ally off - Disables the display of ally messages on your screen. (except those with the "simpleclans.mod.nohide" permission)
•/ally on - Enables the display of ally messages on your screen.
Global Chat
The default minecraft chat, you are here when you no longer in ally or clan chat.
The following functionality is available:
•/global off - Disables the display of global chat messages on your screen. (except those with the "simpleclans.mod.nohide" permission)
•/global on - Enables the display of global chat messages on your screen.
Clan Capes and Titles
If using Spout, you will be able to see capes and in-game titles with the clan tag on all clan players. You can configure the in-game titles can be fully configured, colored vs black and white and the barackets and or separator. Note: Clan tags go away when the player is sneaking. All players inside a clan start with a default cape (configurable), verified clan leaders will be able to choose a unique cape for their clan using the /clan cape command. Individual players can toggle on/off their capes with /clan cape toggle
Inviting Members
Creators of clans will become the first clan leader. They can invite other members into the clan with /clan invite. These members are first added with the untrusted status. These members will not be able to view clan vitals, coords, or stats. This is to prevent players form joining clans just to spy on other clans by writing down coordinates of bases or viewing vitals during battles. Once a player has gained the clan's trust he can be upgraded to trusted status with /clan trust.
You can have multiple leaders on a clan. You can promote other leaders using the /clan promote command. To promote a leader all other leaders must be online and must accept the vote. A leader cannot be promoted unilaterally without the consent of all other leaders. Demotion using the /clan demote command works the same way.
A moderator can completely ban a player form ever joining any clans with the /clan ban/unban command.
* Example of a clan invite request
Clan List
You can view all the clans on your server using the /clan list command. The clans are sorted by KDR.
Leaderboard
With the /clan leaderboard you can compare all clan players. The leaderboard is sorted by KDR, this will tell you who to fear, or what free agent you may want to invite to your clan.
Clan Roster
The /clan roster command shows you the members of your clan. Here you can see your clan's members status as well as when the last time they were seen online was.
Clan Vitals
The /clan vitals command shows you the vitals of all online members of your clan. Here you can see their health, what armor and weapons they are carrying and of what materials, and how many hearts all of their food contains. This comes in handy during battle to know who you need to help and who can bring help to you.
Clan Coordinates
The /clan coords command shows you the distance and coordinates of all online members of you clan, sorted by distance. With this you will be able to know who to call for help during a raid/battle.
Clan Stats
Your clan's stats screen, opened with the /clan stats command, shows you all of your clan members KDR, raw kills, and deaths stats. Leaders show on the top and members on the bottom. Leaders are sorted by KDR, and members are sorted by KDR. This screen tells you who are the strongest leaders, and who are the strongest members. It will also show you the current weights for the different types of kills.
Player Lookup
You can look up your own or another players info using /clan lookup command. This gives you all the data concerning the player, his KDR, his kills and deaths, what clan he belongs to, the date when he joined the clan, his status in the clan, when he was last seen, a list of all past clans hes been part of, and how many days he has been inactive for.
Clan Profile
With the /clan profile command you can view details about any clan. It shows you the clan leaders, how many members are currently online, the KDR, the sum of all kills and deaths of all members of the clan, allies, rivalries, the date founded, and how many days it has been inactive for.
Protection
SimpleClans is deeply integrated with the PreciousStones protection system. You can add your entire clan to any PreciousStones protection field or any kind of field for that matter by using your clan's tag:
/ps allow c:clan
*allow, remove, allowall, removeall work the same way
If you are in a clan, every field that you place will automatically have your clan in the allowed list.
Note: This functionality can be provided by any protection system by hooking into our API
War
If you are using PreciousStones protection then your clans will be able to get into wars. A clan can enter into a war with a rival by sending a war request with /clan war. Once the rival accepts, all fields belonging to all members of on clan, and all fields that have that clan in their allowed list will have no effect on the opposing clan. Both clans will be free to raid the others strongholds with all protection disabled. This will last until one of the clans requests to end the war and the other accepts.
Note: This functionality can be provided by any protection system by hooking into our API
Attachments:
