Compare commits
60
Commits
403-db-tables
...
english
| Author | SHA1 | Date | |
|---|---|---|---|
 Minat0_
|
7781156d57 | ||
|
Minat0_
|
274d27265f | ||
|
Minat0_
|
b1bc1b8f21 | ||
 Edson Passos
|
c688bbcd3b | ||
|
Minat0_
|
5dd157f9e2 | ||
|
Edson Passos
|
724599b1c9 | ||
|
Minat0_
|
7902935dfb | ||
|
Edson Passos
|
b833372604 | ||
|
Edson Passos
|
348b24a2d5 | ||
|
Edson Passos
|
ddcec39625 | ||
|
Edson Passos
|
404e6e611d | ||
|
Edson Passos
|
2dc0eced62 | ||
|
Minat0_
|
16ccfd61fd | ||
|
Edson Passos
|
bde5c5804c | ||
|
Edson Passos
|
14b5f9f6bb | ||
|
Edson Passos
|
00c7fe6a71 | ||
|
Edson Passos
|
4943dfe141 | ||
|
Edson Passos
|
c3baf75bd6 | ||
|
Edson Passos
|
c3667f8030 | ||
|
Minat0_
|
4758a61196 | ||
|
Edson Passos
|
ac5a6d1a2c | ||
|
Edson Passos
|
d7fb4b1505 | ||
|
Edson Passos
|
115aa5f65a | ||
|
Minat0_
|
a5cb971071 | ||
|
Minat0_
|
d9476ad0b9 | ||
|
Minat0_
|
26bf3b2e0f | ||
|
Minat0_
|
3da1812fb4 | ||
|
Minat0_
|
07f3bf5a43 | ||
|
Minat0_
|
afa39e1bf7 | ||
|
Minat0_
|
d79c00db88 | ||
|
Edson Passos
|
f9e312737e | ||
 TonyDownpouR
|
5ed8214e7f | ||
|
Edson Passos
|
526cd811de | ||
|
Minat0_
|
d163d1cbdb | ||
|
Minat0_
|
4d6bed3a48 | ||
|
Minat0_
|
ea30033d9a | ||
|
Minat0_
|
efe0c2324a | ||
|
Minat0_
|
5e7ccae224 | ||
 mehmet yılmaz
|
c8e5eef453 | ||
|
mehmet yılmaz
|
5639531744 | ||
|
mehmet yılmaz
|
b2a9a1b1ca | ||
|
mehmet yılmaz
|
2481c31b36 | ||
|
mehmet yılmaz
|
998cc2bab4 | ||
|
mehmet yılmaz
|
73d8bad3fa | ||
|
Edson Passos
|
39d043f900 | ||
|
Edson Passos
|
ea992f032d | ||
|
Minat0_
|
4294e3c71c | ||
|
Minat0_
|
736e43d572 | ||
|
Minat0_
|
cf75690334 | ||
|
Minat0_
|
fb7f60bdef | ||
|
Minat0_
|
ea5d2d1c34 | ||
|
Minat0_
|
f4298452b3 | ||
|
Minat0_
|
c709322afb | ||
|
Minat0_
|
8925fd4c84 | ||
|
Minat0_
|
b28b3f76e6 | ||
|
Minat0_
|
c4f8604da9 | ||
|
Minat0_
|
1e86f6991b | ||
|
Edson Passos
|
53527dc039 | ||
|
Edson Passos
|
44dcef1736 | ||
|
Edson Passos
|
542207261e |
No files matched your search
Binary file not shown.
|
After Width: | Height: | Size: 2.6 MiB |
Binary file not shown.
|
After Width: | Height: | Size: 4.5 MiB |
Binary file not shown.
|
After Width: | Height: | Size: 418 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 243 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 3.8 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 85 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 85 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 85 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 8.6 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.9 MiB |
Binary file not shown.
|
After Width: | Height: | Size: 2.6 MiB |
Binary file not shown.
|
After Width: | Height: | Size: 4.5 MiB |
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 3.8 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 85 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 85 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 40 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 8.6 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.9 MiB |
Binary file not shown.
|
After Width: | Height: | Size: 8.6 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 3.8 KiB |
+1
-2
@@ -2,7 +2,7 @@
|
||||
description: Welcome to the SimpleClans Wiki!
|
||||
---
|
||||
|
||||
# Introduction
|
||||
# 😃 Introduction
|
||||
|
||||
Here you will find a complete set of documentation including installation, configuration, permissions and usage for SimpleClans.
|
||||
|
||||
@@ -21,4 +21,3 @@ If the wiki does not have your answer, feel free to join [the discord](https://d
|
||||
`Issue Tracker`
|
||||
|
||||
If you believe you have found a bug in the plugin, feel free to make an issue on the [issue tracker!](https://github.com/RoinujNosde/SimpleClans/issues) Bugs will be looked into and addressed at the earliest opportunity.
|
||||
|
||||
+23
-16
@@ -1,29 +1,36 @@
|
||||
# Table of contents
|
||||
|
||||
* [Introduction](README.md)
|
||||
* [😃 Introduction](README.md)
|
||||
* [Discord Support](https://discord.gg/CkNwgdE)
|
||||
* [Bugs and Suggestions](https://github.com/RoinujNosde/SimpleClans/issues)
|
||||
* [Javadoc](https://ci.roinujnosde.me/job/SimpleClans/Javadoc/)
|
||||
|
||||
## How to Setup
|
||||
|
||||
* [Configuration](how-to-setup/configuration.md)
|
||||
* [Translation](how-to-setup/translation.md)
|
||||
* [Member Fee](how-to-setup/member-fee.md)
|
||||
* [Clan Upkeep](how-to-setup/clan-upkeep.md)
|
||||
* [Clan Below Player's Name](how-to-setup/clan-below-players-name.md)
|
||||
* [Clan on Tablist](how-to-setup/clan-on-tablist.md)
|
||||
* [📘 Configuration](how-to-setup/configuration.md)
|
||||
* [🍕 Translation](how-to-setup/translation.md)
|
||||
* [💰 Member Fee](how-to-setup/member-fee.md)
|
||||
* [💲 Clan Upkeep](how-to-setup/clan-upkeep.md)
|
||||
* [👇 Clan Below Player's Name](how-to-setup/clan-below-players-name.md)
|
||||
* [👆 Clan on Tablist](how-to-setup/clan-on-tablist.md)
|
||||
|
||||
## Commands and Permissions
|
||||
|
||||
* [Commands](commands-and-permissions/commands.md)
|
||||
* [Permissions](commands-and-permissions/permissions.md)
|
||||
* [Clan Alliances and Rivalries](commands-and-permissions/aliances-and-rivalries.md)
|
||||
* [Ranks with Permissions](commands-and-permissions/ranks-with-permissions.md)
|
||||
* [📌 Commands](commands-and-permissions/commands.md)
|
||||
* [🚦 Permissions](commands-and-permissions/permissions.md)
|
||||
* [🪖 Clan Alliances and Rivalries](commands-and-permissions/aliances-and-rivalries.md)
|
||||
* [🏅 Ranks with Permissions](commands-and-permissions/ranks-with-permissions.md)
|
||||
* [👍 Verified Clan](commands-and-permissions/verified-clan.md)
|
||||
* [⌛ Permanent clan](commands-and-permissions/permanent-clan.md)
|
||||
|
||||
## Integration
|
||||
|
||||
* [🏝️ Land Claiming](integration/land-claiming.md)
|
||||
* [👾 DiscordSRV](integration/discordsrv-integration.md)
|
||||
|
||||
## Other
|
||||
|
||||
* [Known issues](other/known-issues.md)
|
||||
* [SimpleClans API Example](other/simpleclans-api.md)
|
||||
* [PlaceholderAPI Support](other/placeholderapi-support.md)
|
||||
* [Land Claims Plugins](other/land-claims.md)
|
||||
|
||||
* [♟️ API Examples](other/simpleclans-api.md)
|
||||
* [🪜 Placeholders](other/placeholderapi-support.md)
|
||||
* [💸 Logging server economy](other/untitled.md)
|
||||
* [🪓 Known issues](other/known-issues.md)
|
||||
@@ -1,8 +1,4 @@
|
||||
---
|
||||
description: null
|
||||
---
|
||||
|
||||
# Clan Alliances and Rivalries
|
||||
# 🪖 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.
|
||||
|
||||
@@ -12,22 +8,21 @@ You can view a list of all clans and their allies with the `/clan alliances` com
|
||||
|
||||
## Commands
|
||||
|
||||
| Commands | Description |
|
||||
| :--- | :--- |
|
||||
| `/clan ally add [tag]` | Send an request to start an alliance \(acceptance is required\) |
|
||||
| `/clan ally remove [tag]` | Remove alliance \(no acceptance is required\) |
|
||||
| `/clan rival add [tag]` | Starting a rivalry \(no acceptance is required\) |
|
||||
| `/clan rival remove [tag]` | Remove a rivalry \(acceptance is required\) |
|
||||
| `/clan alliances` | List all clans and their allies |
|
||||
| `/clan rivalries` | List all clans and their rivals |
|
||||
| Commands | Description |
|
||||
| -------------------------- | ------------------------------------------------------------- |
|
||||
| `/clan ally add [tag]` | Send an request to start an alliance (acceptance is required) |
|
||||
| `/clan ally remove [tag]` | Remove alliance (no acceptance is required) |
|
||||
| `/clan rival add [tag]` | Starting a rivalry (no acceptance is required) |
|
||||
| `/clan rival remove [tag]` | Remove a rivalry (acceptance is required) |
|
||||
| `/clan alliances` | List all clans and their allies |
|
||||
| `/clan rivalries` | List all clans and their rivals |
|
||||
|
||||
## Permissions
|
||||
|
||||
| Permission | Description |
|
||||
| :--- | :--- |
|
||||
| `simpleclans.member.ally` | Can use ally chat |
|
||||
| `simpleclans.leader.ally` | Can ally his clan with other simpleclans |
|
||||
| `simpleclans.leader.rival` | Can start a rivalry with another clan |
|
||||
| `simpleclans.anyone.alliances` | Can view alliances by clan |
|
||||
| `simpleclans.anyone.rivalries` | Can view rivalries by clan |
|
||||
|
||||
| Permission | Description |
|
||||
| ------------------------------ | ---------------------------------------- |
|
||||
| `simpleclans.member.ally` | Can use ally chat |
|
||||
| `simpleclans.leader.ally` | Can ally his clan with other simpleclans |
|
||||
| `simpleclans.leader.rival` | Can start a rivalry with another clan |
|
||||
| `simpleclans.anyone.alliances` | Can view alliances by clan |
|
||||
| `simpleclans.anyone.rivalries` | Can view rivalries by clan |
|
||||
@@ -1,120 +1,141 @@
|
||||
---
|
||||
description: null
|
||||
---
|
||||
# 📌 Commands
|
||||
|
||||
# Commands
|
||||
|
||||
> Required arguments are marked with `(argument)`
|
||||
> Required arguments are marked with `(argument)` 
|
||||
>
|
||||
> Optional arguments are marked with `[argument]`
|
||||
|
||||
You can check any command description or requirements using: `/clan help [`command`]`
|
||||
|
||||
## Anyone Commands
|
||||
|
||||
| Command | Description | Verified only |
|
||||
| :--- | :--- | :--- |
|
||||
| `/clan` | Opens the GUI or shows the help | No |
|
||||
| `/clan help` | Shows the plugin's commands | No |
|
||||
| `/clan create [tag] [name]` | Creates a new clan | No |
|
||||
| `/accept` | Accepts a request | No |
|
||||
| `/deny` | Denies a request | No |
|
||||
| `/more` | Shows more information | No |
|
||||
| `/clan leaderboard` | Shows the leaderboard | No |
|
||||
| `/clan list [name|size|kdr|founded|active] [asc|desc]` | Lists all clans | No |
|
||||
| `/clan rivalries` | Shows all clan rivalries | No |
|
||||
| `/clan alliances` | Shows all clan alliances | No |
|
||||
| `/clan lookup [player]` | Looks up your or another player's info | No |
|
||||
| `/clan profile [tag]` | Shows another clan's profile | Yes\* |
|
||||
| `/clan roster [tag]` | Shows another clan's roster | Yes\* |
|
||||
| `/clan ff (allow|auto)` | Toggles personal friendly fire | No |
|
||||
| `/clan resetkdr` | Resets your KDR | No |
|
||||
| Command | Description | Verified only |
|
||||
| ----------------------------------------------------------- | -------------------------------------- | ------------- |
|
||||
| `/clan` | Opens the GUI or shows the help | No |
|
||||
| `/clan help` | Shows the plugin's commands | No |
|
||||
| `/clan create [tag] [name]` | Creates a new clan | No |
|
||||
| `/accept` | Accepts a request | No |
|
||||
| `/deny` | Denies a request | No |
|
||||
| `/more` | Shows more information | No |
|
||||
| `/clan leaderboard` | Shows the leaderboard | No |
|
||||
| `/clan list [name\|size\|kdr\|founded\|active] [asc\|desc]` | Lists all clans | No |
|
||||
| `/clan rivalries` | Shows all clan rivalries | No |
|
||||
| `/clan alliances` | Shows all clan alliances | No |
|
||||
| `/clan lookup [player]` | Looks up your or another player's info | No |
|
||||
| `/clan profile [tag]` | Shows another clan's profile | Yes\* |
|
||||
| `/clan roster [tag]` | Shows another clan's roster | Yes\* |
|
||||
| `/clan ff (allow\|auto)` | Toggles personal friendly fire | No |
|
||||
| `/clan resetkdr` | Resets your KDR | No |
|
||||
| `/clan toggle invite` | Toggles personal clan invites | No |
|
||||
|
||||
\\* The target clan
|
||||
\\\* The target clan
|
||||
|
||||
## Members Commands
|
||||
|
||||
### General Commands
|
||||
|
||||
| Command | Description | Verified only |
|
||||
| :--- | :--- | :--- |
|
||||
| `/clan kills [player]` | Shows your or another player's kill counts | Yes |
|
||||
| `/clan toggle` | Toggles personal settings | Yes |
|
||||
| `/clan mostkilled` | Shows server-wide most killed counts | Yes |
|
||||
| `/clan resign` | Resigns from the clan | No |
|
||||
| `/clan fee check` | Checks if the fee is enabled and how much it costs | Yes |
|
||||
| `/clan vitals` | Shows your clan's vitals | Yes |
|
||||
| `/clan stats` | Shows your clan's stats | Yes |
|
||||
| `/clan profile` | Shows your clan's profile | Yes |
|
||||
| `/clan roster` | Shows your clan's roster | Yes |
|
||||
| `/clan coords` | Shows your clan's coords | Yes |
|
||||
| Command | Description | Verified only |
|
||||
| ------------------------ | -------------------------------------------------- | ------------- |
|
||||
| `/clan kills [player]` | Shows your or another player's kill counts | Yes |
|
||||
| `/clan toggle` | Toggles personal settings | Yes |
|
||||
| `/clan mostkilled` | Shows server-wide most killed counts | Yes |
|
||||
| `/clan resign` | Resigns from the clan | No |
|
||||
| `/clan fee check` | Checks if the fee is enabled and how much it costs | Yes |
|
||||
| `/clan vitals` | Shows your clan's vitals | Yes |
|
||||
| `/clan stats` | Shows your clan's stats | Yes |
|
||||
| `/clan profile` | Shows your clan's profile | Yes |
|
||||
| `/clan roster` | Shows your clan's roster | Yes |
|
||||
| `/clan coords` | Shows your clan's coords | Yes |
|
||||
| `/clan bb` | Shows your clan's bulletin board | Yes |
|
||||
| `/clan bb add (message)` | Writes a message to your clan's bulletin board | Yes |
|
||||
|
||||
### Chat Commands
|
||||
|
||||
| Command | Description | Verified only |
|
||||
| :--- | :--- | :--- |
|
||||
| `/. (message)` | Sends a message to your clan's chat | No |
|
||||
| `/. [join|leave|mute]` | Joins/leaves/mutes your clan's chat | No |
|
||||
| `/ally (message)` | Sends a message to the ally chat | No |
|
||||
| `/ally [join|leave|mute]` | Joins/leaves/mutes the ally chat | No |
|
||||
| Command | Description | Verified only |
|
||||
| --------------------------- | ----------------------------------- | ------------- |
|
||||
| `/. (message)` | Sends a message to your clan's chat | No |
|
||||
| `/. [join\|leave\|mute]` | Joins/leaves/mutes your clan's chat | No |
|
||||
| `/ally (message)` | Sends a message to the ally chat | No |
|
||||
| `/ally [join\|leave\|mute]` | Joins/leaves/mutes the ally chat | No |
|
||||
|
||||
### Land Commands
|
||||
|
||||
You can find land commands [here](../integration/land-claiming.md).
|
||||
|
||||
### Bank Commands
|
||||
|
||||
| Command | Description | Verified only |
|
||||
| ------------------------------ | ---------------------------------------------------- | ------------- |
|
||||
| `/clan bank status` | Checks your clans bank balance | Yes |
|
||||
| `/clan bank withdraw (amount)` | Withdraws an amount from your clans bank | Yes |
|
||||
| `/clan bank withdraw all` | Withdraws all from your clans bank | Yes |
|
||||
| `/clan bank deposit (amount)` | Deposits an amount of your money into your clan bank | Yes |
|
||||
| `/clan bank deposit all` | Deposits all of your money into your clan bank | Yes |
|
||||
|
||||
## Leaders Commands
|
||||
|
||||
| Command | Description | Verified only |
|
||||
| :--- | :--- | :--- |
|
||||
| `/clan description (description)` | Modifies the clan's description | Yes |
|
||||
| `/clan invite (player)` | Invites a player | No |
|
||||
| `/clan kick (player)` | Kicks a player from the clan | No |
|
||||
| `/clan trust (player)` | Sets a member as trusted | No |
|
||||
| `/clan untrust (player)` | Sets a member as untrusted | No |
|
||||
| `/clan promote (member)` | Promotes a member to leader | No |
|
||||
| `/clan demote (leader)` | Demotes a leader to member | No |
|
||||
| `/clan setbanner` | Sets the clan's banner | Yes |
|
||||
| `/clan modtag (tag)` | Modifies your clan's tag \(only colors and case\) | |
|
||||
| `/clan clanff (allow|block)` | Toggles clan's friendly fire | No |
|
||||
| `/clan war (start|end) (tag)` | Starts or ends a war | Yes |
|
||||
| `/clan rival (add|remove) (tag)` | Adds or removes a rival | Yes |
|
||||
| `/clan ally (add|remove) (tag)` | Adds or removes an ally | Yes |
|
||||
| `/clan verify` | Verifies your clan | No |
|
||||
| `/clan disband` | Disbands your clan | No |
|
||||
| `/clan fee set (amount)` | Sets the clan's member fee | No |
|
||||
| `/clan regroup me` | Regroups your clan members to your location | Yes |
|
||||
| `/clan regroup home` | Regroups your clan members to your clan's home | Yes |
|
||||
| `/clan home` | Teleports to your clan's home | Yes |
|
||||
| `/clan home clear` | Clears your clan's home | Yes |
|
||||
| `/clan home set` | Sets your clan's home | Yes |
|
||||
| `/clan rank create` | Creates a rank | Yes |
|
||||
| `/clan rank setdisplayname (rank) (displayname)` | Sets the display name of the rank \(it can contain colors and multiple words\) | Yes |
|
||||
| `/clan rank assign (player) (rank)` | Assigns a user to a rank | Yes |
|
||||
| `/clan rank unassign (player)` | Unassigns a user from a rank | Yes |
|
||||
| `/clan rank delete (rank)` | Deletes a rank | Yes |
|
||||
| `/clan rank list` | Lists the clan's ranks | Yes |
|
||||
| `/clan rank permissions` | Lists the available permissions for ranks | Yes |
|
||||
| `/clan rank permissions (rank)` | Lists the rank's permissions | Yes |
|
||||
| `/clan rank permissions add (rank) (permission)` | Adds a permission to the rank | Yes |
|
||||
| `/clan rank permissions remove (rank) (permission)` | Removes a permission from the rank | Yes |
|
||||
| Command | Description | Verified only |
|
||||
| --------------------------------------------------- | ---------------------------------------------------------------------------- | ------------- |
|
||||
| `/clan description (description)` | Modifies the clan's description | Yes |
|
||||
| `/clan invite (player)` | Invites a player | No |
|
||||
| `/clan kick (player)` | Kicks a player from the clan | No |
|
||||
| `/clan trust (player)` | Sets a member as trusted | No |
|
||||
| `/clan untrust (player)` | Sets a member as untrusted | No |
|
||||
| `/clan promote (member)` | Promotes a member to leader | No |
|
||||
| `/clan demote (leader)` | Demotes a leader to member | No |
|
||||
| `/clan setbanner` | Sets the clan's banner | Yes |
|
||||
| `/clan modtag (tag)` | Modifies your clan's tag (only colors and case) | |
|
||||
| `/clan clanff (allow\|block)` | Toggles clan's friendly fire | No |
|
||||
| `/clan war (start\|end) (tag)` | Starts or ends a war | Yes |
|
||||
| `/clan rival (add\|remove) (tag)` | Adds or removes a rival | Yes |
|
||||
| `/clan ally (add\|remove) (tag)` | Adds or removes an ally | Yes |
|
||||
| `/clan verify` | Verifies your clan | No |
|
||||
| `/clan disband` | Disbands your clan | No |
|
||||
| `/clan fee set (amount)` | Sets the clan's member fee | No |
|
||||
| `/clan regroup me` | Regroups your clan members to your location | Yes |
|
||||
| `/clan regroup home` | Regroups your clan members to your clan's home | Yes |
|
||||
| `/clan home` | Teleports to your clan's home | Yes |
|
||||
| `/clan home clear` | Clears your clan's home | Yes |
|
||||
| `/clan home set` | Sets your clan's home | Yes |
|
||||
| `/clan rank create` | Creates a rank | Yes |
|
||||
| `/clan rank setdisplayname (rank) (displayname)` | Sets the display name of the rank (it can contain colors and multiple words) | Yes |
|
||||
| `/clan rank assign (player) (rank)` | Assigns a user to a rank | Yes |
|
||||
| `/clan rank unassign (player)` | Unassigns a user from a rank | Yes |
|
||||
| `/clan rank delete (rank)` | Deletes a rank | Yes |
|
||||
| `/clan rank list` | Lists the clan's ranks | Yes |
|
||||
| `/clan rank permissions` | Lists the available permissions for ranks | Yes |
|
||||
| `/clan rank permissions (rank)` | Lists the rank's permissions | Yes |
|
||||
| `/clan rank permissions add (rank) (permission)` | Adds a permission to the rank | Yes |
|
||||
| `/clan rank permissions remove (rank) (permission)` | Removes a permission from the rank | Yes |
|
||||
| `/clan discord create` | Creates a discord channel for your clan | Yes |
|
||||
| `/clan bb clear` | Clears your clan's bulletin board | Yes |
|
||||
|
||||
## Mod Commands
|
||||
|
||||
| Command | Description |
|
||||
| :--- | :--- |
|
||||
| `/clan place (player) (new clan)` | Places a player in a clan |
|
||||
| `/clan home set (tag)` | Sets a clan's home |
|
||||
| `/clan home tp (tag)` | Teleports to a clan's home |
|
||||
| `/clan ban (player)` | Bans a player from clan commands |
|
||||
| `/clan unban (player)` | Unbans a player from clan commands |
|
||||
| `/clan globalff (allow|auto)` | Toggles the global friendly-fire status |
|
||||
| `/clan verify (tag)` | Verifies a clan |
|
||||
| `/clan disband (tag)` | Disbands a clan |
|
||||
| `/clan mod modtag (clan) (tag)` | Changes colors or case of a clan's tag |
|
||||
| ------------------------------------- | --------------------------------------- |
|
||||
| `/clan mod place (player) (new clan)` | Places a player in a clan |
|
||||
| `/clan mod home set (tag)` | Sets a clan's home |
|
||||
| `/clan mod home tp (tag)` | Teleports to a clan's home |
|
||||
| `/clan mod ban (player)` | Bans a player from clan commands |
|
||||
| `/clan mod unban (player)` | Unbans a player from clan commands |
|
||||
| `/clan mod globalff (allow\|auto)` | Toggles the global friendly-fire status |
|
||||
| `/clan mod verify (tag)` | Verifies a clan |
|
||||
| `/clan mod disband (tag)` | Disbands a clan |
|
||||
| `/clan mod locale (player) (locale)` | Sets a player's locale |
|
||||
| `/clan mod rename (clan) (tag)` | Renames a clan |
|
||||
|
||||
## Admin Commands
|
||||
|
||||
| Command | Description |
|
||||
| :--- | :--- |
|
||||
| `/clan reload` | Reloads the plugin and its configuration \(some features may need a server restart\) |
|
||||
| `/clan purge` | Purges a player's data |
|
||||
| `/clan resetkdr everyone` | Resets everyone's KDR |
|
||||
| `/clan resetkdr (player)` | Resets a player's KDR |
|
||||
| `/clan admin demote (player)` | Demotes a leader from any clan |
|
||||
| `/clan admin promote (player)` | Promotes a member from any clan |
|
||||
|
||||
|
||||
| Command | Description |
|
||||
| ---------------------------------------- | ---------------------------------------------------------------------------------- |
|
||||
| `/clan admin reload` | Reloads the plugin and its configuration (some features may need a server restart) |
|
||||
| `/clan admin purge` | Purges a player's data |
|
||||
| `/clan admin resetkdr everyone` | Resets everyone's KDR |
|
||||
| `/clan admin resetkdr (player)` | Resets a player's KDR |
|
||||
| `/clan admin demote (player)` | Demotes a leader from any clan |
|
||||
| `/clan admin promote (player)` | Promotes a member from any clan |
|
||||
| `/clan admin permanent (clan)` | Toggles permanent status of any clan |
|
||||
| `/clan admin bank give (clan) (amount)` | Gives an amount of money to a clan's bank |
|
||||
| `/clan admin bank take (clan) (amount)` | Takes an amount of money from a clan's bank |
|
||||
| `/clan admin bank set (clan) (amount)` | Sets an amount of money to a clan's bank |
|
||||
|
||||
@@ -0,0 +1,70 @@
|
||||
---
|
||||
description: '"This Is Where the Fun Begins"'
|
||||
---
|
||||
|
||||
# ⌛ Permanent clan
|
||||
|
||||
## What is it?
|
||||
|
||||
Usually, when you creating some clan, it requires having **at least 1 player** there. But sometimes, you need to have an empty clan, right? It is what permanent clans do.
|
||||
|
||||
## Where it can be useful?
|
||||
|
||||
There are plenty of variations on how to use this feature. For example:
|
||||
|
||||
* You want to sell a superior clan on your server and don't want to set a leader to that clan.
|
||||
* You want to move the latest player of a clan to another clan.
|
||||
* A clan for administrators: easy to join and leave.
|
||||
* Clans for RPG server.
|
||||
* etc.
|
||||
|
||||
### Particular examples
|
||||
|
||||
#### Using permanent clans with DeluxeMenus
|
||||
|
||||
You can join your players to clans using the menu:
|
||||
|
||||
|
||||
|
||||
YAML example:
|
||||
|
||||
```yaml
|
||||
items:
|
||||
'jedi_clan':
|
||||
material: diamond_block
|
||||
slot: 5
|
||||
display_name: "&7Join to &aJedi"
|
||||
left_click_commands:
|
||||
- '[console] clan mod place %player_name% jedi'
|
||||
- '[close]'
|
||||
```
|
||||
|
||||
#### Using permanent clans with Citizens
|
||||
|
||||
Alternatively, you may want to join your players by NPC:
|
||||
|
||||
|
||||
|
||||
To do it, you need to:
|
||||
|
||||
1. Create an NPC: `/npc create <name>`
|
||||
2. Set the command on player's clicking: `/npc command add clan -o mod place <p> jedi`
|
||||
|
||||
## How to use it?
|
||||
|
||||
You can use `/clan admin permanent [clan]` command to give permanent status to a clan.
|
||||
|
||||
.png>)
|
||||
|
||||
{% hint style="danger" %}
|
||||
**Warning**\
|
||||
****Permanent clans are not purged for inactivity and can't be disbanded by players. \
|
||||
Use `/clan mod disband` instead.
|
||||
{% endhint %}
|
||||
|
||||
{% hint style="info" %}
|
||||
**Note**\
|
||||
****This command work only **** if you're an administrator or \
|
||||
if you have `simpleclans.admin.permanent` permission node.
|
||||
{% endhint %}
|
||||
|
||||
@@ -1,139 +1,157 @@
|
||||
---
|
||||
description: null
|
||||
---
|
||||
# 🚦 Permissions
|
||||
|
||||
# Permissions
|
||||
## SuperPerms Nodes (Some auto added)
|
||||
|
||||
## SuperPerms Nodes \(Some auto added\)
|
||||
These super permission nodes are a quick way to setup SimpleClans, some are automatically given (See Auto Added). If you wish to setup individual permissions to groups you will need to deny these auto added super permission nodes and setup permissions one by one after.
|
||||
|
||||
These super permission nodes are a quick way to setup SimpleClans, some are automatically given \(See Auto Added\). If you wish to setup individual permissions to groups you will need to deny these auto added super permission nodes and setup permissions one by one after.
|
||||
|
||||
| Permission | Description |
|
||||
| :--- | :--- |
|
||||
| `simpleclans.anyone.*` \(Auto added\) | Permissions for anyone |
|
||||
| `simpleclans.member.*` \(Auto added\) | Permissions for those who can be clan members |
|
||||
| `simpleclans.leader.*` \(Auto added\) | Permissions for those who can be clan leaders |
|
||||
| `simpleclans.mod.*` \(Auto added to OPS\) | Permissions for moderators |
|
||||
| `simpleclans.admin.*` \(Auto added to OPS\) | Permissions for admins |
|
||||
| Permission | Description |
|
||||
| ----------------------------------------- | -------------------------------------------------- |
|
||||
| `simpleclans.anyone.*` (Auto added) | Permissions for anyone |
|
||||
| `simpleclans.member.*` (Auto added) | Permissions for those who can be clan members |
|
||||
| `simpleclans.member.land.*` (Auto added) | Permissions for allowing/blocking actions in lands |
|
||||
| `simpleclans.leader.*` (Auto added) | Permissions for those who can be clan leaders |
|
||||
| `simpleclans.mod.*` (Auto added to OPS) | Permissions for moderators |
|
||||
| `simpleclans.admin.*` (Auto added to OPS) | Permissions for admins |
|
||||
|
||||
## Individual Nodes
|
||||
|
||||
\(You don't need to add these as they are all included if you've already added the node groups \(above\). They are only included here as reference in case you want to toggle a couple of them off individually. Then you can just drop those in, set to false, along with the node groups.\)
|
||||
(You don't need to add these as they are all included if you've already added the node groups (above). They are only included here as reference in case you want to toggle a couple of them off individually. Then you can just drop those in, set to false, along with the node groups.)
|
||||
|
||||
### Anyone Nodes
|
||||
|
||||
| Permission | Description |
|
||||
| :--- | :--- |
|
||||
| `simpleclans.anyone.alliances` | Can view alliances by clan |
|
||||
| `simpleclans.anyone.leaderboard` | Can view the leaderboard |
|
||||
| `simpleclans.anyone.list` | Can list simpleclans |
|
||||
| `simpleclans.anyone.lookup` | Can lookup a player's info |
|
||||
| `simpleclans.anyone.profile` | Can view a clan's profile |
|
||||
| `simpleclans.anyone.rivalries` | Can view rivalries by clan |
|
||||
| `simpleclans.anyone.roster` | Can view a clan's member list |
|
||||
| Permission | Description |
|
||||
| ---------------------------------- | ------------------------------------ |
|
||||
| `simpleclans.anyone.alliances` | Can view alliances by clan |
|
||||
| `simpleclans.anyone.leaderboard` | Can view the leaderboard |
|
||||
| `simpleclans.anyone.list` | Can list simpleclans |
|
||||
| `simpleclans.anyone.lookup` | Can lookup a player's info |
|
||||
| `simpleclans.anyone.profile` | Can view a clan's profile |
|
||||
| `simpleclans.anyone.rivalries` | Can view rivalries by clan |
|
||||
| `simpleclans.anyone.roster` | Can view a clan's member list |
|
||||
| `simpleclans.anyone.invite-toggle` | Can toggle clan invites for yourself |
|
||||
|
||||
### Member Nodes
|
||||
|
||||
| Permission | Description |
|
||||
| :--- | :--- |
|
||||
| `simpleclans.member.abstain` | Can abstain |
|
||||
| `simpleclans.member.accept` | Can accept |
|
||||
| `simpleclans.member.ally` | Can use ally chat |
|
||||
| `simpleclans.member.chat` | Can use clan chat |
|
||||
| `simpleclans.member.bank` | Can use the clan bank |
|
||||
| `simpleclans.member.bb-add` | Can add to his clan's bulletin board |
|
||||
| `simpleclans.member.bb-toggle` | Can toggle the bulletin board on/off |
|
||||
| `simpleclans.member.bb` | Can view his clan's bulletin board |
|
||||
| `simpleclans.member.can-join` | Can join clans |
|
||||
| `simpleclans.member.coords` | Can view his clan's coords |
|
||||
| `simpleclans.member.deny` | Can deny |
|
||||
| `simpleclans.member.ff` | Can toggle his own friendly fire |
|
||||
| `simpleclans.member.home` | Can tp to home base |
|
||||
| `simpleclans.member.kills` | Can view his and other's kills |
|
||||
| `simpleclans.member.lookup` | Can view his own player info |
|
||||
| `simpleclans.member.profile` | Can view his own clan's profile |
|
||||
| `simpleclans.member.resign` | Can resign from his clan |
|
||||
| `simpleclans.member.roster` | Can view his own clan's member list |
|
||||
| `simpleclans.member.stats` | Can view his clan stats |
|
||||
| `simpleclans.member.vitals` | Can view his clan's vitals |
|
||||
| `simpleclans.member.toggle.bb` | Can toggle bb on/off |
|
||||
| `simpleclans.member.tag-toggle` | Can hide/show their clan tag |
|
||||
| `simpleclans.member.fee-check` | Allows the member to check how much is the fee and if it's enabled |
|
||||
| `simpleclans.member.bypass-fee` | Can bypass the member fee |
|
||||
| Permission | Description |
|
||||
| ----------------------------------------------- | ------------------------------------------------------------------ |
|
||||
| `simpleclans.member.abstain` | Can abstain |
|
||||
| `simpleclans.member.accept` | Can accept |
|
||||
| `simpleclans.member.ally` | Can use ally chat |
|
||||
| `simpleclans.member.chat` | Can use clan chat |
|
||||
| `simpleclans.member.bank` | Can use the clan bank |
|
||||
| `simpleclans.member.bb-add` | Can add to his clan's bulletin board |
|
||||
| `simpleclans.member.bb-toggle` | Can toggle the bulletin board on/off |
|
||||
| `simpleclans.member.bb` | Can view his clan's bulletin board |
|
||||
| `simpleclans.member.can-join` | Can join clans |
|
||||
| `simpleclans.member.coords` | Can view his clan's coords |
|
||||
| `simpleclans.member.deny` | Can deny |
|
||||
| `simpleclans.member.ff` | Can toggle his own friendly fire |
|
||||
| `simpleclans.member.home` | Can tp to home base |
|
||||
| `simpleclans.member.kills` | Can view his and other's kills |
|
||||
| `simpleclans.member.lookup` | Can view his own player info |
|
||||
| `simpleclans.member.profile` | Can view his own clan's profile |
|
||||
| `simpleclans.member.resign` | Can resign from his clan |
|
||||
| `simpleclans.member.roster` | Can view his own clan's member list |
|
||||
| `simpleclans.member.stats` | Can view his clan stats |
|
||||
| `simpleclans.member.vitals` | Can view his clan's vitals |
|
||||
| `simpleclans.member.toggle.bb` | Can toggle bb on/off |
|
||||
| `simpleclans.member.tag-toggle` | Can hide/show their clan tag |
|
||||
| `simpleclans.member.fee-check` | Allows the member to check how much is the fee and if it's enabled |
|
||||
| `simpleclans.member.bypass-fee` | Can bypass the member fee |
|
||||
| `simpleclans.member.land` | Can use land command |
|
||||
| `simpleclans.member.land.allow.container` | Can allow container action |
|
||||
| `simpleclans.member.land.allow.place` | Can allow place action |
|
||||
| `simpleclans.member.land.allow.damage` | Can allow damage action |
|
||||
| `simpleclans.member.land.allow.break` | Can allow break action |
|
||||
| `simpleclans.member.land.allow.interact` | Can allow interact action |
|
||||
| `simpleclans.member.land.allow.interact_entity` | Can allow interact\_entity action |
|
||||
| `simpleclans.member.land.block.container` | Can block container action |
|
||||
| `simpleclans.member.land.block.place` | Can block place action |
|
||||
| `simpleclans.member.land.block.damage` | Can block damage action |
|
||||
| `simpleclans.member.land.block.break` | Can block break action |
|
||||
| `simpleclans.member.land.block.interact` | Can block interact action |
|
||||
| `simpleclans.member.land.block.interact_entity` | Can block interact\_entity action |
|
||||
|
||||
### Leader Nodes
|
||||
|
||||
| Permission | Description |
|
||||
| :--- | :--- |
|
||||
| `simpleclans.leader.fee` | allows the user to toggle the fee and set its value |
|
||||
| `simpleclans.leader.ally` | Can ally his clan with other clans |
|
||||
| `simpleclans.leader.create` | Can create clans |
|
||||
| `simpleclans.leader.verify` | Can verify their clan |
|
||||
| `simpleclans.leader.demote` | Can demote clan leaders to normal players |
|
||||
| `simpleclans.leader.disband` | Can disband his own clan |
|
||||
| `simpleclans.leader.ff` | Can toggle his clan's friendly fire |
|
||||
| `simpleclans.leader.home-set` | Can set home base |
|
||||
| `simpleclans.leader.regroup.me` | Can teleport the entire clan to themself |
|
||||
| `simpleclans.leader.regroup.home` | Can teleport the entire clan to homebase |
|
||||
| `simpleclans.leader.invite` | Can invite players into his clan |
|
||||
| `simpleclans.leader.kick` | Can kick players form his clan |
|
||||
| `simpleclans.leader.modtag` | Can modify his clan's tag |
|
||||
| `simpleclans.leader.description` | Can modify their clan's description |
|
||||
| `simpleclans.leader.coloredtag` | Can use color codes in tags |
|
||||
| `simpleclans.leader.coloredrank` | Can use color codes in rank display names |
|
||||
| `simpleclans.leader.promotable` | Can be promoted to clan leader |
|
||||
| `simpleclans.leader.promote` | Can promote players to clan leaders |
|
||||
| `simpleclans.leader.rank.assign` | Can assign a rank to a user |
|
||||
| `simpleclans.leader.rank.unassign` | Can unassign a player from a rank |
|
||||
| `simpleclans.leader.rank.create` | Can create a new rank |
|
||||
| `simpleclans.leader.rank.delete` | Can delete a new rank |
|
||||
| `simpleclans.leader.rank.list` | Can list all the ranks |
|
||||
| `simpleclans.leader.rank.setdisplayname` | Can set the display name of the rank |
|
||||
| `simpleclans.leader.rank.permissions.add` | Can add permissions to a rank |
|
||||
| `simpleclans.leader.rank.permissions.available` | Can list all available permissions |
|
||||
| `simpleclans.leader.rank.permissions.list` | Can list the rank's permissions |
|
||||
| `simpleclans.leader.rank.permissions.remove` | Can remove permissions from a rank |
|
||||
| `simpleclans.leader.rival` | Can start a rivalry with another clan |
|
||||
| `simpleclans.leader.settrust` | Can set trust levels for members |
|
||||
| `simpleclans.leader.war` | Can start wars |
|
||||
| `simpleclans.leader.setbanner` | Can set his clan's banner |
|
||||
| `simpleclans.leader.withdraw-toggle:` | Can toggle clan bank withdraw |
|
||||
| `simpleclans.leader.deposit-toggle:` | Can toggle clan bank deposit |
|
||||
| `simpleclans.leader.bb-clear` | Clan clear their clan's bb |
|
||||
| Permission | Description |
|
||||
| ----------------------------------------------- | --------------------------------------------------- |
|
||||
| `simpleclans.leader.fee` | allows the user to toggle the fee and set its value |
|
||||
| `simpleclans.leader.ally` | Can ally his clan with other clans |
|
||||
| `simpleclans.leader.create` | Can create clans |
|
||||
| `simpleclans.leader.verify` | Can verify their clan |
|
||||
| `simpleclans.leader.demote` | Can demote clan leaders to normal players |
|
||||
| `simpleclans.leader.disband` | Can disband his own clan |
|
||||
| `simpleclans.leader.ff` | Can toggle his clan's friendly fire |
|
||||
| `simpleclans.leader.home-set` | Can set home base |
|
||||
| `simpleclans.leader.regroup.me` | Can teleport the entire clan to themself |
|
||||
| `simpleclans.leader.regroup.home` | Can teleport the entire clan to homebase |
|
||||
| `simpleclans.leader.invite` | Can invite players into his clan |
|
||||
| `simpleclans.leader.kick` | Can kick players form his clan |
|
||||
| `simpleclans.leader.modtag` | Can modify his clan's tag |
|
||||
| `simpleclans.leader.description` | Can modify their clan's description |
|
||||
| `simpleclans.leader.coloredtag` | Can use color codes in tags |
|
||||
| `simpleclans.leader.coloredrank` | Can use color codes in rank display names |
|
||||
| `simpleclans.leader.promotable` | Can be promoted to clan leader |
|
||||
| `simpleclans.leader.promote` | Can promote players to clan leaders |
|
||||
| `simpleclans.leader.rank.assign` | Can assign a rank to a user |
|
||||
| `simpleclans.leader.rank.unassign` | Can unassign a player from a rank |
|
||||
| `simpleclans.leader.rank.create` | Can create a new rank |
|
||||
| `simpleclans.leader.rank.delete` | Can delete a new rank |
|
||||
| `simpleclans.leader.rank.list` | Can list all the ranks |
|
||||
| `simpleclans.leader.rank.setdisplayname` | Can set the display name of the rank |
|
||||
| `simpleclans.leader.rank.permissions.add` | Can add permissions to a rank |
|
||||
| `simpleclans.leader.rank.permissions.available` | Can list all available permissions |
|
||||
| `simpleclans.leader.rank.permissions.list` | Can list the rank's permissions |
|
||||
| `simpleclans.leader.rank.permissions.remove` | Can remove permissions from a rank |
|
||||
| `simpleclans.leader.rival` | Can start a rivalry with another clan |
|
||||
| `simpleclans.leader.settrust` | Can set trust levels for members |
|
||||
| `simpleclans.leader.war` | Can start wars |
|
||||
| `simpleclans.leader.setbanner` | Can set his clan's banner |
|
||||
| `simpleclans.leader.withdraw-toggle:` | Can toggle clan bank withdraw |
|
||||
| `simpleclans.leader.deposit-toggle:` | Can toggle clan bank deposit |
|
||||
| `simpleclans.leader.discord.create` | Can create a discord channel |
|
||||
| `simpleclans.leader.bb-clear` | Clan clear their clan's bb |
|
||||
| `simpleclans.leader.rename` | Can rename his own clan |
|
||||
|
||||
### Mod Nodes
|
||||
|
||||
| Permission | Description |
|
||||
| :--- | :--- |
|
||||
| `simpleclans.mod.ban` | Can ban players from the entire plugin |
|
||||
| `simpleclans.mod.bypass` | Can bypass restrictions |
|
||||
| `simpleclans.mod.disband` | Can disband any clan |
|
||||
| `simpleclans.mod.globalff` | Can turn off global friendly fire protection |
|
||||
| `simpleclans.mod.home` | Can set other clan's home |
|
||||
| `simpleclans.mod.hometp` | Can teleport to all clans homes |
|
||||
| `simpleclans.mod.staffgui` | Can open the staff GUI |
|
||||
| `simpleclans.mod.place` | Can manually place players in clans |
|
||||
| `simpleclans.mod.keep-items` | Can keep items when teleporting home |
|
||||
| `simpleclans.mod.mostkilled` | Can view his and other's clans mostkilled |
|
||||
| `simpleclans.mod.nopvpinwar` | Can bypass PvP in wars |
|
||||
| `simpleclans.mod.unban` | Can unban players from the entire plugin |
|
||||
| `simpleclans.mod.verify` | Can verify clans |
|
||||
| Permission | Description |
|
||||
| ---------------------------- | -------------------------------------------- |
|
||||
| `simpleclans.mod.ban` | Can ban players from the entire plugin |
|
||||
| `simpleclans.mod.bypass` | Can bypass restrictions |
|
||||
| `simpleclans.mod.disband` | Can disband any clan |
|
||||
| `simpleclans.mod.globalff` | Can turn off global friendly fire protection |
|
||||
| `simpleclans.mod.home` | Can set other clan's home |
|
||||
| `simpleclans.mod.hometp` | Can teleport to all clans homes |
|
||||
| `simpleclans.mod.staffgui` | Can open the staff GUI |
|
||||
| `simpleclans.mod.place` | Can manually place players in clans |
|
||||
| `simpleclans.mod.keep-items` | Can keep items when teleporting home |
|
||||
| `simpleclans.mod.mostkilled` | Can view his and other's clans mostkilled |
|
||||
| `simpleclans.mod.nopvpinwar` | Can bypass PvP in wars |
|
||||
| `simpleclans.mod.unban` | Can unban players from the entire plugin |
|
||||
| `simpleclans.mod.verify` | Can verify clans |
|
||||
| `simpleclans.mod.rename` | Can rename any clan |
|
||||
|
||||
### Admin Nodes
|
||||
|
||||
| Permission | Description |
|
||||
| :--- | :--- |
|
||||
| `simpleclans.admin.resetkdr` | Can reset a player's or everyone's KDR |
|
||||
| `simpleclans.admin.purge` | Can purge a player |
|
||||
| `simpleclans.admin.demote` | Can demote a player back to member |
|
||||
| `simpleclans.admin.promote` | Can promote players to clan leaders |
|
||||
| `simpleclans.admin.all-seeing-eye` | Can see all clan chats |
|
||||
| `simpleclans.admin.reload` | Can reload configuration |
|
||||
| Permission | Description |
|
||||
| ---------------------------------- | -------------------------------------- |
|
||||
| `simpleclans.admin.resetkdr` | Can reset a player's or everyone's KDR |
|
||||
| `simpleclans.admin.purge` | Can purge a player |
|
||||
| `simpleclans.admin.demote` | Can demote a player back to member |
|
||||
| `simpleclans.admin.promote` | Can promote players to clan leaders |
|
||||
| `simpleclans.admin.all-seeing-eye` | Can see all clan chats |
|
||||
| `simpleclans.admin.reload` | Can reload configuration |
|
||||
| `simpleclans.admin.permanent` | Can toggle clan permanent status |
|
||||
| `simpleclans.admin.bank.status` | Can check the balance of a clan |
|
||||
| `simpleclans.admin.bank.take` | Can take money from a clan |
|
||||
| `simpleclans.admin.bank.give` | Can give money to a clan |
|
||||
| `simpleclans.admin.bank.set` | Can set the balance of a clan |
|
||||
|
||||
### Other Nodes
|
||||
|
||||
| Permission | Node |
|
||||
| :--- | :--- |
|
||||
| `simpleclans.other.kdr-exempt` | The player's KDR is not affected on killing/dying \(check Known Issues\) |
|
||||
| `simpleclans.vip.resetkdr` | Can reset their KDR |
|
||||
|
||||
| Permission | Node |
|
||||
| ------------------------------ | ---------------------------------------------------------------------- |
|
||||
| `simpleclans.other.kdr-exempt` | The player's KDR is not affected on killing/dying (check Known Issues) |
|
||||
| `simpleclans.vip.resetkdr` | Can reset their KDR |
|
||||
@@ -1,84 +1,79 @@
|
||||
---
|
||||
description: null
|
||||
---
|
||||
|
||||
# Ranks with Permissions
|
||||
# 🏅 Ranks with Permissions
|
||||
|
||||
## How does it work?
|
||||
|
||||
Leaders have the ability to create ranks and give them permissions to perform several actions inside the clan. Unlike `/clan trust`, ranks with permissions allows leaders to have a finer control of who can do what. Ex.: A rank can handle invites \(`invite` permission\), another takes care of moderation \(`kick` permission\), etc
|
||||
Leaders have the ability to create ranks and give them permissions to perform several actions inside the clan. Unlike `/clan trust`, ranks with permissions allows leaders to have a finer control of who can do what. Ex.: A rank can handle invites (`invite` permission), another takes care of moderation (`kick` permission), etc
|
||||
|
||||
## Suggested ranks
|
||||
|
||||
| Ranks | Description | Permission |
|
||||
| :--- | :--- | :---: |
|
||||
| **Coleader** | Helps take care of the clan | `all` |
|
||||
| **Treasurer** | Manages the clan's bank account | `bank.balance`, `bank.deposit`, `bank.withdraw` |
|
||||
| Ranks | Description | Permission |
|
||||
| -------------- | --------------------------------------------- | :-----------------------------------------------------------------------------------------: |
|
||||
| **Coleader** | Helps take care of the clan | `all` |
|
||||
| **Treasurer** | Manages the clan's bank account | `bank.balance`, `bank.deposit`, `bank.withdraw` |
|
||||
| **Ambassador** | Manages the clan's relations with other clans | `ally.chat`, `ally.add`, `ally.remove`, `rival.add`, `rival.remove`, `war.end`, `war.start` |
|
||||
| **Recruit** | A member in trial | `stats`, `kills`, `mostkilled`, `rank.list` |
|
||||
| **Recruit** | A member in trial | `stats`, `kills`, `mostkilled`, `rank.list` |
|
||||
|
||||
## Ranks Commands
|
||||
|
||||
| Command | Description |
|
||||
| :--- | :--- |
|
||||
| `/clan rank create` | Creates a rank with this name |
|
||||
| `/clan rank setdisplayname [rank] [displayname]` | Sets the display name of the rank \(it can be more than one word and colored\) |
|
||||
| `/clan rank assign (player) (rank)` | Assigns a user to a rank |
|
||||
| `/clan rank unassign (player)` | Unassigns a user from a rank |
|
||||
| `/clan rank delete (rank)` | Deletes a rank |
|
||||
| `/clan rank list` | Lists the clan's ranks |
|
||||
| `/clan rank permissions` | Lists the available permissions for ranks |
|
||||
| `/clan rank permissions (rank)` | Lists the rank's permissions |
|
||||
| `/clan rank permissions add (rank) (permission)` | Adds a permission to the rank |
|
||||
| `/clan rank permissions remove (rank) (permission)` | Removes a permission from the rank |
|
||||
| Command | Description |
|
||||
| --------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `/clan rank create` | Creates a rank with this name |
|
||||
| `/clan rank setdisplayname [rank] [displayname]` | Sets the display name of the rank (it can be more than one word and colored) |
|
||||
| `/clan rank assign (player) (rank)` | Assigns a user to a rank |
|
||||
| `/clan rank unassign (player)` | Unassigns a user from a rank |
|
||||
| `/clan rank delete (rank)` | Deletes a rank |
|
||||
| `/clan rank list` | Lists the clan's ranks |
|
||||
| `/clan rank permissions` | Lists the available permissions for ranks |
|
||||
| `/clan rank permissions (rank)` | Lists the rank's permissions |
|
||||
| `/clan rank permissions add (rank) (permission)` | Adds a permission to the rank |
|
||||
| `/clan rank permissions remove (rank) (permission)` | Removes a permission from the rank |
|
||||
|
||||
## Available permissions for ranks
|
||||
|
||||
A player can view those permissions in-game using `/clan rank permissions`
|
||||
|
||||
| Rank Permission | Description |
|
||||
| :--- | :--- |
|
||||
| `ally.add` | can add an ally |
|
||||
| `ally.remove` | can remove an ally |
|
||||
| `ally.chat` | can use ally chat |
|
||||
| `bank.balance` | can view the bank balance |
|
||||
| `bank.deposit` | can deposit money |
|
||||
| `bank.withdraw` | can withdraw money |
|
||||
| `bb.add` | can add a message to bb |
|
||||
| `bb.clear` | can clear the bb |
|
||||
| `coords` | can view the clan's coords |
|
||||
| `fee.enable` | can enable the member fee |
|
||||
| `fee.set` | can change the fee value |
|
||||
| `home.regroup` | can regroup the clan |
|
||||
| `home.set` | can set the clan home |
|
||||
| `home.tp` | can tp to the clan home |
|
||||
| `invite` | can invite someone to the clan |
|
||||
| `kick` | can kick someone from the clan |
|
||||
| `modtag` | can modify the clan tag |
|
||||
| `rank.displayname` | can modify a rank's display name |
|
||||
| `rank.list` | can list the ranks |
|
||||
| `rival.add` | can add a rival |
|
||||
| `rival.remove` | can remove a rival |
|
||||
| `war.end` | can end a war |
|
||||
| `war.start` | can start a war |
|
||||
| `vitals` | can view the clan's vitals |
|
||||
| `stats` | can view the clan's stats |
|
||||
| `kills` | can view his or other's kills |
|
||||
| `mostkilled` | can view the mostkilled |
|
||||
| `description` | can change the clan's description |
|
||||
| Rank Permission | Description |
|
||||
| ------------------ | --------------------------------- |
|
||||
| `ally.add` | can add an ally |
|
||||
| `ally.remove` | can remove an ally |
|
||||
| `ally.chat` | can use ally chat |
|
||||
| `bank.balance` | can view the bank balance |
|
||||
| `bank.deposit` | can deposit money |
|
||||
| `bank.withdraw` | can withdraw money |
|
||||
| `bb.add` | can add a message to bb |
|
||||
| `bb.clear` | can clear the bb |
|
||||
| `coords` | can view the clan's coords |
|
||||
| `fee.enable` | can enable the member fee |
|
||||
| `fee.set` | can change the fee value |
|
||||
| `home.regroup` | can regroup the clan |
|
||||
| `home.set` | can set the clan home |
|
||||
| `home.tp` | can tp to the clan home |
|
||||
| `invite` | can invite someone to the clan |
|
||||
| `kick` | can kick someone from the clan |
|
||||
| `modtag` | can modify the clan tag |
|
||||
| `rank.displayname` | can modify a rank's display name |
|
||||
| `rank.list` | can list the ranks |
|
||||
| `rival.add` | can add a rival |
|
||||
| `rival.remove` | can remove a rival |
|
||||
| `war.end` | can end a war |
|
||||
| `war.start` | can start a war |
|
||||
| `vitals` | can view the clan's vitals |
|
||||
| `stats` | can view the clan's stats |
|
||||
| `kills` | can view his or other's kills |
|
||||
| `mostkilled` | can view the mostkilled |
|
||||
| `description` | can change the clan's description |
|
||||
|
||||
## Permissions to use the rank commands
|
||||
|
||||
| Permission | Description |
|
||||
| :--- | :--- |
|
||||
| `simpleclans.leader.rank.assign` | Can assign a rank to a user |
|
||||
| `simpleclans.leader.rank.unassign` | Can unassign a player from a rank |
|
||||
| `simpleclans.leader.rank.create` | Can create a new rank |
|
||||
| `simpleclans.leader.rank.delete` | Can delete a new rank |
|
||||
| `simpleclans.leader.rank.list` | Can list all the ranks |
|
||||
| `simpleclans.leader.rank.setdisplayname` | Can set the display name of the rank |
|
||||
| `simpleclans.leader.rank.permissions.add` | Can add permissions to a rank |
|
||||
| `simpleclans.leader.rank.permissions.available` | Can list all available permissions |
|
||||
| `simpleclans.leader.rank.permissions.list` | Can list the rank's permissions |
|
||||
| `simpleclans.leader.rank.permissions.remove` | Can remove permissions from a rank |
|
||||
|
||||
| Permission | Description |
|
||||
| ----------------------------------------------- | ------------------------------------ |
|
||||
| `simpleclans.leader.rank.assign` | Can assign a rank to a user |
|
||||
| `simpleclans.leader.rank.unassign` | Can unassign a player from a rank |
|
||||
| `simpleclans.leader.rank.create` | Can create a new rank |
|
||||
| `simpleclans.leader.rank.delete` | Can delete a new rank |
|
||||
| `simpleclans.leader.rank.list` | Can list all the ranks |
|
||||
| `simpleclans.leader.rank.setdisplayname` | Can set the display name of the rank |
|
||||
| `simpleclans.leader.rank.permissions.add` | Can add permissions to a rank |
|
||||
| `simpleclans.leader.rank.permissions.available` | Can list all available permissions |
|
||||
| `simpleclans.leader.rank.permissions.list` | Can list the rank's permissions |
|
||||
| `simpleclans.leader.rank.permissions.remove` | Can remove permissions from a rank |
|
||||
@@ -0,0 +1,22 @@
|
||||
# 👍 Verified Clan
|
||||
|
||||
## What is it?
|
||||
|
||||
<mark style="color:red;">Verified clan</mark> is a clan, which provides more features for its members. 
|
||||
|
||||
In most cases, when someone creates a clan, it's enough to have only _basic_ options, like: inviting, resigning, member kicking and so on - this type of clans called <mark style="color:red;">unverified</mark>.  
|
||||
|
||||
## Where I can found out all features?
|
||||
|
||||
You can see which commands will be added with verified status on the [commands](commands.md) page.
|
||||
|
||||
## Disabling unverified clans
|
||||
|
||||
At some day you may realize that you want to have only verified clans.\
|
||||
Well, you're lucky one – SimpleClans can do it.\
|
||||
Simply set `false` to relevant option in configuration:
|
||||
|
||||
```yaml
|
||||
settings:
|
||||
new-clan-verification-required: false
|
||||
```
|
||||
@@ -1,38 +1,57 @@
|
||||
---
|
||||
description: null
|
||||
---
|
||||
# 👇 Clan Below Player's Name
|
||||
|
||||
# Clan Below Player's Name
|
||||
|
||||
## Plugins needed
|
||||
## Plugins required
|
||||
|
||||
* [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/)
|
||||
* [TAB](https://www.spigotmc.org/resources/tab-1-5-x-1-15-x-free-version.57806/) \(you can use a different tablist plugin, as long as it supports PlaceholderAPI\)
|
||||
* [TAB](https://github.com/NEZNAMY/TAB/releases) (you can use a different tablist plugin, as long as it supports PlaceholderAPI)
|
||||
|
||||
## Step by step
|
||||
|
||||
1. Open TAB's config and edit the Groups section adding `%simpleclans_clan_color_tag%` to `belowname`:
|
||||
1\. Open TAB's `config.yml`, enable **unlimited-nametag-mode**:
|
||||
|
||||
{% code title="Example:" %}
|
||||
{% code title="/plugins/TAB/config.yml" %}
|
||||
```yaml
|
||||
_OTHER_:
|
||||
tabprefix: "%vault-prefix% "
|
||||
tagprefix: "%vault-prefix% "
|
||||
tabsuffix: "%afk%"
|
||||
tagsuffix: "%afk%"
|
||||
customtabname: "%essentialsnick%"
|
||||
customtagname: "%essentialsnick%"
|
||||
belowname: "&l&b[ %simpleclans_clan_color_tag% &l&b]"
|
||||
scoreboard-teams:
|
||||
unlimited-nametag-mode:
|
||||
enabled: true
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
2. Find the option `belowname` or `classic-vanilla-belowname` and disable it.
|
||||
2\. Now let's edit `groups.yml` file. Add `belowname` option if missing.
|
||||
|
||||
3. Find the option `unlimited-nametag-prefix-suffix-mode` and enable it.
|
||||
{% code title="/plugins/TAB/groups.yml" %}
|
||||
```yaml
|
||||
_DEFAULT_:
|
||||
belowname: "%simpleclans_tag_label%"
|
||||
# if you want a clan tag above your name:
|
||||
# abovename: "%simpleclans_tag_label%"
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
4. Restart \(or reload\) and enjoy!
|
||||
3 (_Optional_). Change the view of clan tags in SimpleClans's `config.yml`:
|
||||
|
||||
{% code title="/plugins/SimpleClans/config.yml" %}
|
||||
```yaml
|
||||
tag:
|
||||
default-color: '8'
|
||||
max-length: 5
|
||||
bracket:
|
||||
color: '8'
|
||||
leader-color: '4'
|
||||
left: '' # It can be '[' or any other character
|
||||
right: '' # It can be ']' or any other character
|
||||
min-length: 2
|
||||
separator:
|
||||
color: '8'
|
||||
leader-color: '4'
|
||||
char: ' .' # You can remove a dot after clan tags
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
You can check more info about this section in [configuration](https://wiki.roinujnosde.me/simpleclans/how-to-setup/configuration#tags) tab.
|
||||
|
||||
4\. Restart your server or reload TAB – `/tab reload`. Enjoy! :)
|
||||
|
||||
## Screenshot
|
||||
|
||||
|
||||
|
||||
@@ -1,34 +1,23 @@
|
||||
---
|
||||
description: null
|
||||
---
|
||||
# 👆 Clan on Tablist
|
||||
|
||||
# Clan on Tablist
|
||||
|
||||
## Plugins needed
|
||||
## Plugins required
|
||||
|
||||
* [PlaceholderAPI](https://www.spigotmc.org/resources/placeholderapi.6245/)
|
||||
* [PlayerListPlus](https://www.spigotmc.org/resources/%E2%99%9B-playerlistplus-%E2%99%9B-1-8-1-14-3-tablist-editor.55878/) \(you can use a different tablist plugin, as long as it supports PlaceholderAPI\)
|
||||
* [TAB](https://github.com/NEZNAMY/TAB/releases) (you can use a different tablist plugin, as long as it supports PlaceholderAPI)
|
||||
|
||||
## Step by step
|
||||
|
||||
1. Open PlayerListPlus config and edit the formats adding `%simpleclans_clan_color_tag%`:
|
||||
1\. Open Tab's `groups.yml` file and add `%simpleclans_clan_color_tag%` to `tabprefix`:
|
||||
|
||||
{% code title="Example:" %}
|
||||
{% code title="/plugins/TAB/groups.yml" %}
|
||||
```yaml
|
||||
slot-items:
|
||||
# This slot items will shows all players
|
||||
PLAYERS:
|
||||
format: "%simpleclans_clan_color_tag%&c.$displayname"
|
||||
type: PLAYER_LIST
|
||||
hidevanished: true
|
||||
ping: true
|
||||
skin: true
|
||||
_DEFAULT_:
|
||||
tabprefix: "%simpleclans_clan_color_tag%%vault-prefix% "
|
||||
```
|
||||
{% endcode %}
|
||||
|
||||
2. Restart \(or reload\) and enjoy!
|
||||
2\. Restart (or reload `/tab reload`) your server and enjoy!
|
||||
|
||||
## Screenshot
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,8 +1,4 @@
|
||||
---
|
||||
description: null
|
||||
---
|
||||
|
||||
# Clan Upkeep
|
||||
# 💲 Clan Upkeep
|
||||
|
||||
## How does it work?
|
||||
|
||||
@@ -10,7 +6,7 @@ If enabled, clans will have to pay an amount everyday to keep their clans. The v
|
||||
|
||||
Ex. fee based on the clan size:
|
||||
|
||||
```text
|
||||
```
|
||||
upkeep base = 20.0
|
||||
clan size = 10
|
||||
final upkeep = 200.0
|
||||
@@ -21,7 +17,7 @@ final upkeep = 200.0
|
||||
* `upkeep` - The base upkeep.
|
||||
* `upkeep-enabled` - Enable or disable the feature.
|
||||
* `multiply-upkeep-by-clan-size` - This works as explained above
|
||||
* `charge-upkeep-only-if-member-fee-enabled` - Enable upkeep if [member fee](https://github.com/RoinujNosde/SimpleClans/wiki/Member-Fee) is enabled.
|
||||
* `charge-upkeep-only-if-member-fee-enabled` - Enable upkeep if member fee is enabled.
|
||||
|
||||
#### Exemple
|
||||
|
||||
@@ -32,4 +28,3 @@ economy:
|
||||
multiply-upkeep-by-clan-size: false
|
||||
charge-upkeep-only-if-member-fee-enabled: true
|
||||
```
|
||||
|
||||
+255
-210
@@ -1,48 +1,46 @@
|
||||
---
|
||||
description: null
|
||||
---
|
||||
# 📘 Configuration
|
||||
|
||||
# Configuration
|
||||
|
||||
[The main configuration file for SimpleClans can be found here.](https://github.com/RoinujNosde/SimpleClans/blob/master/src/main/resources/config.yml)
|
||||
The main configuration file for SimpleClans can be found [here.](https://github.com/RoinujNosde/SimpleClans/blob/master/src/main/resources/config.yml)
|
||||
|
||||
## General Settings
|
||||
|
||||
* `enable-gui` - Enables the GUI.
|
||||
* `disable-messages` - This will disable broadcasts from the plugin such as "Clan created", "Clan disbanded", etc.
|
||||
* `tameable-mobs-sharing` -
|
||||
* `teleport-blocks` -
|
||||
* `teleport-home-on-spawn` - Players will be teleported to their clan's home when they respawn.
|
||||
* `drop-items-on-clan-home` -
|
||||
* `keep-items-on-clan-home` -
|
||||
* `item-list` -
|
||||
* `show-debug-info` -
|
||||
* `mchat-integration` -
|
||||
* `enable-auto-groups` -
|
||||
* `chat-compatibility-mode` -
|
||||
* `rival-limit-percent` -
|
||||
* `use-colorcode-from-prefix-for-name` -
|
||||
* `display-chat-tags` -
|
||||
* `unrivable-clans` -
|
||||
* `show-unverified-on-list` -
|
||||
* `blacklisted-worlds` -
|
||||
* `banned-players` -
|
||||
* `disallowed-tags` -
|
||||
* `language` -
|
||||
* `language-per-player` -
|
||||
* `disallowed-tag-colors` -
|
||||
* `server-name` -
|
||||
* `new-clan-verification-required` -
|
||||
* `allow-regroup-command` -
|
||||
* `allow-reset-kdr` -
|
||||
* `rejoin-cooldown` -
|
||||
* `rejoin-cooldown-enabled` -
|
||||
* `min-to-verify` - The clan must have this amount of members to get verified \(moderators can bypass this\)
|
||||
* `ranking-type` - Valid options: ORDINAL and DENSE
|
||||
* `DENSE`: if players have the same KDR, they will have the same rank position. Ex.: 12234
|
||||
* `ORDINAL`: Every player will have a different rank position. Ex.: 12345
|
||||
| Option | Description | Default |
|
||||
| --------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
|
||||
| `enable-gui` | Enables the GUI | `true` |
|
||||
| `disable-messages` | Disables broadcasts from plugin ("Clan Created", "Clan Disbanded", etc.) | `false` |
|
||||
| `tameable-mobs-sharing` | If true, tameable mobs will be shared with your clan members. It also disables any clan damage to them | `false` |
|
||||
| `teleport-blocks` | Fancy teleporting (placed glass block below) | `false` |
|
||||
| `teleport-home-on-spawn` | Players will be teleported to their clan's home when they respawn | `false` |
|
||||
| `drop-items-on-clan-home` | Drops defined items on teleporting to clan home | `false` |
|
||||
| `keep-items-on-clan-home` | Keeps defined items on teleporting to clan home | `false` |
|
||||
| `item-list` | List of defined items (used with `keep-item-on-clan-home` and `drop-items-on-clan-home`) | `[]` |
|
||||
| `show-debug-info` | Shows debug info on console | `false` |
|
||||
| `enable-auto-groups` | <p>Manages group of a clan player by auto.<br>(For example, a leader would be added to <code>sc_leader</code> group, trusted player to <code>sc_trusted</code>, etc.)</p> | `false` |
|
||||
| `chat-compatibility-mode` | <p>Changes method of initiate tags.<br>If you have a problem with tags, try to disable it.</p> | `true` |
|
||||
| `rival-limit-percent` | <p>The percent of possible rivals per clan</p><p>Formula: <code>(rivalsOfClan - 1) * rivalLimitPercent / 100</code></p> | <p><code>50</code><br></p> |
|
||||
| `use-colorcode-from-prefix-for-name` | Uses the last color code in the end of prefix | `true` |
|
||||
| `accept-other-alphabets-letters-on-tag` | Accepts other alphabets letters in clan tag validation. | `true` |
|
||||
| `display-chat-tags` | Shows clan tags in chat | `true` |
|
||||
| `unrivable-clans` | The list of clans, which can't be rivaled | See Example below |
|
||||
| `show-unverified-on-list` | <p>Shows or not unverified clans on <code>/clan list</code></p><p>(Doesn't affect on GUI)</p> | `false` |
|
||||
| `blacklisted-worlds` | Disables SimpleClans at defined worlds | <p><code>[]</code><br></p> |
|
||||
| `banned-players` | List of banned players from using plugin | `[]` |
|
||||
| `disallowed-tags` | List of tags, which wouldn't be used on clan creation | See Example below |
|
||||
| `language` | Default language | `en` |
|
||||
| `user-language-selector` | Allows players to change their language | `true` |
|
||||
| `disallowed-tag-colors` | The list of tag colors, which wouldn't be used on clan creation | See Example below |
|
||||
| `server-name` | The name of your server | `&4SimpleClans` |
|
||||
| `new-clan-verification-required` | Should new clans requires being verified? | `true` |
|
||||
| `allow-regroup-command` | Allows players to use regroup command | `true` |
|
||||
| `allow-reset-kdr` | Allows players to reset their KDR | `true` |
|
||||
| `rejoin-cooldown` | The time in minutes, when player will can join after resigning to the same clan | `60` |
|
||||
| `rejoin-cooldown-enabled` | Should rejoin cooldown be enabled? | `false` |
|
||||
| `ranking-type` | <p><code>DENSE</code>: if players have the same KDR, they will have the same rank position. Ex.: 12234</p><p><code>ORDINAL</code>: Every player will have a different rank position. Ex.: 12345</p> | <p><code>DENSE</code><br></p> |
|
||||
| `username-regex` | <p>Tells SimpleClans what usernames on your server is permitted. <br><br>Used, for example, to invite members. Supports Bedrock players by default.</p> | `'(.\|*){0,1}[a-zA-Z0-9_$]{1,16}'` |
|
||||
| `tag-regex` | Rules for clan tag validation. Disables `accept-other-alphabets-letters-on-tag` if set. | `''` |
|
||||
| `date-time-pattern` | Changes how dates should look. You can check the format [here](https://docs.oracle.com/javase/8/docs/api/java/text/SimpleDateFormat.html). | `"HH:mm - dd/MM/yyyy"` |
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
settings:
|
||||
@@ -60,6 +58,7 @@ settings:
|
||||
chat-compatibility-mode: true
|
||||
rival-limit-percent: 50
|
||||
use-colorcode-from-prefix-for-name: true
|
||||
accept-other-alphabets-letters-on-tag: true
|
||||
display-chat-tags: true
|
||||
unrivable-clans:
|
||||
- admin
|
||||
@@ -81,26 +80,81 @@ settings:
|
||||
allow-reset-kdr: false
|
||||
rejoin-cooldown: 60
|
||||
rejoin-cooldown-enabled: false
|
||||
min-to-verify: 1
|
||||
ranking-type: DENSE
|
||||
username-regex: '(\.|\*){0,1}[a-zA-Z0-9_$]{1,16}'
|
||||
tag-regex: ''
|
||||
date-time-pattern: 'HH:mm - dd/MM/yyyy'
|
||||
```
|
||||
|
||||
## Tags Format
|
||||
## War and protection
|
||||
|
||||
#### Example
|
||||
| Option | Description | Default |
|
||||
| ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
|
||||
| `war-enabled` | Enables the war feature on the server | `false` |
|
||||
| `land-sharing` | Enables the [land sharing](../integration/land-claiming.md) feature on the server | `true` |
|
||||
| `protection-providers` | The list of land claim providers | See Example below |
|
||||
| `listeners.priority` | <p>It's <strong>not recommended</strong> to change it.</p><p>Used to set the priority of the overridden events</p> | `HIGHEST` |
|
||||
| `listeners.ignored-list.place` | <p>The list of items that will be ignored by SimpleClans.<br></p><p><strong>For example</strong>, WorldGuard blocked player' head in the region. If player' head is not on the list, SimpleClans will make WG allow the placement</p> | See Example below |
|
||||
| `set-base-only-in-land` | Allows a clan player to set the clan base only on claimed land | `false` |
|
||||
| `war-normal-expiration-time` | <p>The time of war expiration independently<br>(in minutes)</p> | `0` |
|
||||
| `war-disconnect-expiration-time` | The time of war expiration if all members from **one** clan disconnects (in minutes) | `0` |
|
||||
| `edit-all-lands` | Allows a clan player to change the action of all the lands instead of the one on which it stands | `false` |
|
||||
| `war-actions` | The list of permitted actions regarding clan lands during the war | See Example below |
|
||||
| `war-start.request-enabled` | If true, a war will require the approval from the clan leaders | `true` |
|
||||
| `war-start.members-online-max-difference` | <p>If the difference between the online members of two clans is greater than the one set, the war will not start</p><p><br><strong>Example 1:</strong><br>Config value: <em>5</em></p><p>Clan #1 has 10 members online</p><p>Clan #2 has 5 members online</p><p>Max difference between clans = 10 - 5 = 5<br>The war <em>will</em> start.<br><strong>Example 2:</strong><br>Config value: 5</p><p>Clan #1 has 11 members online</p><p>Clan #2 has 5 members online</p><p>Max difference between clans = 11 - 5 = 6</p><p>The war <em>will not</em> start.</p> | `5` |
|
||||
| `land-creation.only-leaders` | Allows only clan leaders to create lands (not compatible with WorldGuard) | `false` |
|
||||
| `land-creation.only-one-per-clan` | Allows to have only one land per clan (not compatible with WorldGuard) | `false` |
|
||||
|
||||
* `default-color` -
|
||||
* `max-length` -
|
||||
* `bracket` -
|
||||
* `color` -
|
||||
* `leader-color` -
|
||||
* `left` -
|
||||
* `right` -
|
||||
* `min-length` -
|
||||
* `separator` -
|
||||
* `color` -
|
||||
* `leader-color` -
|
||||
* `char` -
|
||||
```yaml
|
||||
war-and-protection:
|
||||
war-enabled: false
|
||||
land-sharing: true
|
||||
protection-providers:
|
||||
- WorldGuardProvider
|
||||
- WorldGuard6Provider
|
||||
- PlotSquared5Provider
|
||||
- PlotSquared3Provider
|
||||
- GriefPreventionProvider
|
||||
listeners:
|
||||
priority: HIGHEST
|
||||
ignored-list:
|
||||
PLACE:
|
||||
- PLAYER_HEAD
|
||||
set-base-only-in-land: false
|
||||
war-normal-expiration-time: 0
|
||||
war-disconnect-expiration-time: 0
|
||||
edit-all-lands: false
|
||||
war-actions:
|
||||
CONTAINER: true
|
||||
INTERACT: true
|
||||
BREAK: true
|
||||
PLACE: true
|
||||
DAMAGE: true
|
||||
INTERACT_ENTITY: true
|
||||
war-start:
|
||||
request-enabled: true
|
||||
members-online-max-difference: 5
|
||||
land-creation:
|
||||
only-leaders: false
|
||||
only-one-per-clan: false
|
||||
```
|
||||
|
||||
## Tags
|
||||
|
||||
* `default-color` - color used when the clan leader didn't set any colors
|
||||
* `max-length` - maximum length for tags
|
||||
* `bracket` - brackets are the characters around the tag, ex.: `[ ]`
|
||||
* `color` - the bracket color
|
||||
* `leader-color` - this color is used when the player is a leader
|
||||
* `left` - the left character
|
||||
* `right` - the right character
|
||||
* `min-length` - minimum length for tags
|
||||
* `separator` - the separator is a character that separates the tag and the player name
|
||||
* `color` - the separator color
|
||||
* `leader-color` - this color is used when the player is a leader
|
||||
* `char` - the separator character
|
||||
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
tag:
|
||||
@@ -120,16 +174,9 @@ tag:
|
||||
|
||||
## General Commands
|
||||
|
||||
* `more` -
|
||||
* `ally` -
|
||||
* `clan` -
|
||||
* `accept` -
|
||||
* `deny` -
|
||||
* `global` -
|
||||
* `clan_chat` -
|
||||
* `force-priority` -
|
||||
In this section you can edit the base commands of the plugin. Enable `force-priority` if other plugins are interfering with the commands.
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
commands:
|
||||
@@ -145,12 +192,12 @@ commands:
|
||||
|
||||
## KDR Grinding Prevention
|
||||
|
||||
* `enable-max-kills` -
|
||||
* `max-kills-per-victim` -
|
||||
* `enable-kill-delay` -
|
||||
* `delay-between-kills` -
|
||||
* `enable-max-kills` - by enabling this, you can set a limit on kills per victim.
|
||||
* `max-kills-per-victim` - this is the limit of kills per victim. If it's set to 10, for example, killing the same player for the 11th time won't affect the KDR
|
||||
* `enable-kill-delay` - enables a delay between kills
|
||||
* `delay-between-kills` - this is the delay in minutes between kills
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
kdr-grinding-prevention:
|
||||
@@ -160,61 +207,37 @@ kdr-grinding-prevention:
|
||||
delay-between-kills: 5
|
||||
```
|
||||
|
||||
## List Commands
|
||||
|
||||
* `size` -
|
||||
* `kdr` -
|
||||
* `name` -
|
||||
* `founded` -
|
||||
* `active` -
|
||||
* `asc` -
|
||||
* `desc` -
|
||||
* `default` -
|
||||
|
||||
#### Example
|
||||
|
||||
```yaml
|
||||
list:
|
||||
size: size
|
||||
kdr: kdr
|
||||
name: name
|
||||
founded: founded
|
||||
active: active
|
||||
asc: asc
|
||||
desc: desc
|
||||
default: kdr
|
||||
```
|
||||
|
||||
## Economy
|
||||
|
||||
* `creation-price` -
|
||||
* `purchase-clan-create` -
|
||||
* `verification-price` -
|
||||
* `purchase-clan-verify` -
|
||||
* `invite-price` -
|
||||
* `purchase-clan-invite` -
|
||||
* `home-teleport-price` -
|
||||
* `purchase-home-teleport` -
|
||||
* `home-teleport-set-price` -
|
||||
* `purchase-home-teleport-set` -
|
||||
* `home-regroup-price` -
|
||||
* `purchase-home-regroup` -
|
||||
* `unique-tax-on-regroup` -
|
||||
* `issuer-pays-regroup` -
|
||||
* `money-per-kill` -
|
||||
* `money-per-kill-kdr-multipier` -
|
||||
* `purchase-reset-kdr` -
|
||||
* `reset-kdr-price` -
|
||||
* `purchase-member-fee-set` -
|
||||
* `member-fee-set-price` -
|
||||
* `member-fee-enabled` -
|
||||
* `max-member-fee` -
|
||||
* `upkeep` -
|
||||
* `upkeep-enabled` -
|
||||
* `multiply-upkeep-by-clan-size` -
|
||||
* `charge-upkeep-only-if-member-fee-enabled` -
|
||||
* `creation-price` - the price to create a clan
|
||||
* `purchase-clan-create` - players must pay to create a clan
|
||||
* `verification-price` - the price to verify a clan
|
||||
* `purchase-clan-verify` - players must pay to verify their clans
|
||||
* `invite-price` - the price to invite a player to your clan 
|
||||
* `purchase-clan-invite` - players must pay to invite
|
||||
* `home-teleport-price` - the price to teleport to the clan's home
|
||||
* `purchase-home-teleport` - players must pay to teleport
|
||||
* `home-teleport-set-price` - the price to set the clan's home
|
||||
* `purchase-home-teleport-set` - players must pay to set the clan's home
|
||||
* `home-regroup-price` - the price for regrouping the clan members
|
||||
* `purchase-home-regroup` - players (or the clan) must pay to regroup
|
||||
* `unique-tax-on-regroup` - if false, the price is multiplied by the amount of online members of the clan
|
||||
* `issuer-pays-regroup` - if enabled, the player issuing the command pays for the regroup, otherwise the clan pays it
|
||||
* `money-per-kill` - enables a prize in money for the killer clan
|
||||
* `money-per-kill-kdr-multipier` - this is multiplied by the attacker's KDR, the result is the money prize for the clan
|
||||
* `purchase-reset-kdr` - If true, players will be able to reset their KDR
|
||||
* `reset-kdr-price` - the price to reset one's KDR
|
||||
* `purchase-member-fee-set` - players must pay to set the member fee
|
||||
* `member-fee-set-price` - the price to set the member fee
|
||||
* `member-fee-enabled` - if clans can charge a daily fee from their members
|
||||
* `max-member-fee` - the maximum amount clans can set for their member fee
|
||||
* `upkeep` - the daily price for maintaining a clan (if not paid, the clan is disbanded)
|
||||
* `upkeep-enabled` - if clans must pay the upkeep
|
||||
* `multiply-upkeep-by-clan-size` - if the upkeep price should be multiplied by the amount of members
|
||||
* `charge-upkeep-only-if-member-fee-enabled` - if the upkeep should be charged only for clans that choose to enable the member fee
|
||||
* `bank-log.enable` - If true, all economy actions will be recorded in .CSV file (SimpleClans/logs/bank/)
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
economy:
|
||||
@@ -248,39 +271,41 @@ economy:
|
||||
|
||||
## Kill Weights
|
||||
|
||||
* `rival` -
|
||||
* `civilian` -
|
||||
* `neutral` -
|
||||
* `deny-same-ip-kills` -
|
||||
Here you can set the weight of every kill type. The weight can be negative too. It's used to calculate the KDR like so: (Kill Count \* Kill Wight) / Death Count = KDR
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
kill-weights:
|
||||
rival: 2.0
|
||||
civilian: 0.0
|
||||
neutral: 1.0
|
||||
ally: -1.0
|
||||
deny-same-ip-kills: false
|
||||
```
|
||||
|
||||
## Clan Settings
|
||||
|
||||
* `homebase-teleport-wait-secs` -
|
||||
* `homebase-can-be-set-only-once` -
|
||||
* `min-size-to-set-rival` -
|
||||
* `max-length` -
|
||||
* `max-description-length` -
|
||||
* `min-description-length` -
|
||||
* `max-members` -
|
||||
* `confirmation-for-promote` -
|
||||
* `trust-members-by-default` -
|
||||
* `confirmation-for-demote` -
|
||||
* `percentage-online-to-demote` -
|
||||
* `ff-on-by-default` -
|
||||
* `min-length` -
|
||||
* `min-size-to-set-ally` -
|
||||
* `homebase-teleport-wait-secs` - the amount of seconds players must wait before teleporting to their clan' home
|
||||
* `homebase-can-be-set-only-once` - if the clan's home can be set only once
|
||||
* `min-size-to-set-rival` - the minimum amount of members a clan needs to add rivals
|
||||
* `max-length` - the max length of the clan's name
|
||||
* `max-description-length` - the maximum length of the clan's description
|
||||
* `min-description-length` - the minimum length of the clan's description
|
||||
* `max-members` - the maximum amount of members a clan can have
|
||||
* `unverified-max-members` – the limit of members in unverified clans
|
||||
* `confirmation-for-promote` - if other leaders must confirm the promotion of members
|
||||
* `trust-members-by-default` - if members are set as trusted by default
|
||||
* `confirmation-for-demote` - if other leaders (except the one being demoted, of course) must confirm the demotion
|
||||
* `percentage-online-to-demote` - the percentage of online leaders to demote
|
||||
* `ff-on-by-default` - if the clan's friendly-fire is enabled by default
|
||||
* `min-length` - the minimum length of the clan's name
|
||||
* `min-size-to-set-ally` - the minimum amount of members a clan needs to add allies
|
||||
* `min-to-verify` - The clan must have this amount of members to get verified (moderators can bypass this)
|
||||
* `starter-ranks` – The list of ranks created in the new clan
|
||||
* `default-rank` – The rank assigned to a new clan member
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
clan:
|
||||
@@ -291,6 +316,7 @@ clan:
|
||||
max-description-length: 120
|
||||
min-description-length: 10
|
||||
max-members: 25
|
||||
unverified-max-members: 10
|
||||
confirmation-for-promote: false
|
||||
trust-members-by-default: false
|
||||
confirmation-for-demote: false
|
||||
@@ -298,21 +324,29 @@ clan:
|
||||
ff-on-by-default: false
|
||||
min-length: 2
|
||||
min-size-to-set-ally: 3
|
||||
min-to-verify: 1
|
||||
starter-ranks:
|
||||
- recruit:
|
||||
display-name: "&7Recruit"
|
||||
permissions: [ stats, kills, mostkilled, rank.list ]
|
||||
- ambassador:
|
||||
display-name: "&bAmbassador"
|
||||
permissions: [ ally.chat, ally.add, ally.remove, rival.add, rival.remove, war.end, war.start ]
|
||||
- treasurer:
|
||||
display-name: "&6Treasurer"
|
||||
permissions: [ bank.balance, bank.deposit, bank.withdraw ]
|
||||
default-rank: "recruit"
|
||||
```
|
||||
|
||||
## Tasks
|
||||
|
||||
* `collect-upkeep` -
|
||||
* `hour` -
|
||||
* `minute` -
|
||||
* `collect-upkeep-warning` -
|
||||
* `hour` -
|
||||
* `minute` -
|
||||
* `collect-fee` -
|
||||
* `hour` -
|
||||
* `minute` -
|
||||
This section allows you to set the time of collection for the two types of fee. The fees are described on the economy section.
|
||||
|
||||
#### Example
|
||||
The collect-upkeep-warning is sent when the clan doesn't have enough money to pay for its upkeep.
|
||||
|
||||
The time is in the 24-hour clock.
|
||||
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
tasks:
|
||||
@@ -329,16 +363,16 @@ tasks:
|
||||
|
||||
## Page
|
||||
|
||||
* `untrusted-color` -
|
||||
* `clan-name-color` -
|
||||
* `subtitle-color` -
|
||||
* `headings-color` -
|
||||
* `trusted-color` -
|
||||
* `leader-color` -
|
||||
* `separator` -
|
||||
* `size` -
|
||||
* `untrusted-color` - 
|
||||
* `clan-name-color` - 
|
||||
* `subtitle-color` - 
|
||||
* `headings-color` - 
|
||||
* `trusted-color` - 
|
||||
* `leader-color` - 
|
||||
* `separator` - 
|
||||
* `size` - 
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
page:
|
||||
@@ -352,25 +386,31 @@ page:
|
||||
size: 100
|
||||
```
|
||||
|
||||
## Discord Chat
|
||||
|
||||
You can checkout the configuration [here](../integration/discordsrv-integration.md#configuration).
|
||||
|
||||
## Clan Chat
|
||||
|
||||
* `enable` -
|
||||
* `tag-based-clan-chat` -
|
||||
* `announcement-color` -
|
||||
* `format` -
|
||||
* `rank` -
|
||||
* `leader-color:` -
|
||||
* `trusted-color` -
|
||||
* `member-color` -
|
||||
* `enable` - enables the clan chat
|
||||
* `tag-based-clan-chat` - if true, the command to talk on the clan chat is the clan tag
|
||||
* `announcement-color` - color used for announcements
|
||||
* `format` - the chat format
|
||||
* `spy-format` - the spy chat format
|
||||
* `rank` - the member's rank format (used on the format)
|
||||
* `leader-color` - the color for leaders (%nick-color%)
|
||||
* `trusted-color` - the color for trusted players (%nick-color%)
|
||||
* `member-color` - the color for non-leaders and non-trusted players (%nick-color%)
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
clanchat:
|
||||
enable: true
|
||||
tag-based-clan-chat: false
|
||||
announcement-color: e
|
||||
format: "&b[%clan%&b] &4<%nick-color%%player%&4> %rank%: &b%message%"
|
||||
format: '&b[%clan%&b] &4<%nick-color%%player%&4> %rank%: &b%message%'
|
||||
spy-format: "&8[Spy] [&bC&8] <%clean-tag%&8> <%nick-color%*&8%player%>&8 %rank%&8: %message%"
|
||||
rank: "&f[%rank%&f]"
|
||||
leader-color: '4'
|
||||
trusted-color: 'f'
|
||||
@@ -379,11 +419,13 @@ clanchat:
|
||||
|
||||
## Request
|
||||
|
||||
* `message-color` -
|
||||
* `ask-frequency-secs` -
|
||||
* `max-asks-per-request` -
|
||||
Requests are messages sent to players to decide (accept or deny) on something (joining a clan, promoting someone, etc).
|
||||
|
||||
#### Example
|
||||
* `message-color` - the message color
|
||||
* `ask-frequency-secs` - the interval in seconds between each message
|
||||
* `max-asks-per-request` - maximum amount of messages before the request expires
|
||||
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
request:
|
||||
@@ -394,18 +436,16 @@ request:
|
||||
|
||||
## Bulletin Board
|
||||
|
||||
* `color` -
|
||||
* `accent-color` -
|
||||
* `show-on-login` -
|
||||
* `size` -
|
||||
* `login-size` -
|
||||
* `prefix` – A prefix of messages in bulletin board
|
||||
* `show-on-login` - if enabled, the BB is sent to clan members when they login 
|
||||
* `size` - the BB size (when using its command)
|
||||
* `login-size` - the BB size on login 
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
bb:
|
||||
color: e
|
||||
accent-color: '8'
|
||||
prefix: "&8* &e"
|
||||
show-on-login: true
|
||||
size: 6
|
||||
login-size: 6
|
||||
@@ -413,32 +453,39 @@ bb:
|
||||
|
||||
## Ally Chat
|
||||
|
||||
* `enable` -
|
||||
* `format` -
|
||||
* `rank` -
|
||||
* `leader-color` -
|
||||
* `trusted-color` -
|
||||
* `member-color` -
|
||||
The Ally Chat config works just like the [Clan Chat](configuration.md#clan-chat) one.
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
allychat:
|
||||
enable: true
|
||||
format: "&b[Ally Chat] &4<%clan%&4> <%nick-color%%player%&4> %rank%: &b%message%"
|
||||
spy-format: '&8[Spy] [&cA&8] <%clean-tag%&8> <%nick-color%*&8%player%>&8 %rank%&8: %message%'
|
||||
rank: "&f[%rank%&f]"
|
||||
leader-color: '4'
|
||||
trusted-color: 'f'
|
||||
member-color: '7'
|
||||
```
|
||||
|
||||
## Spy Chat
|
||||
|
||||
Just a few words how it works.\
|
||||
\
|
||||
Imagine, we are in different clans. \
|
||||
You're in `Fenix` and I'm in `Dragon`, but you're an OP \
|
||||
(or player with `simpleclans.admin.all-seeing-eye` permission). \
|
||||
\
|
||||
When **I** write a message in Dragon's clan chat: `/. Good morning, dragons!` \
|
||||
\
|
||||
**You** as an _admin_ (OP) will receive that message as well and it would be formatted by `spy-format`. \
|
||||
So, you will get something like: `[Spy] [C] RoinujNosde: Good morning, dragons!`
|
||||
|
||||
## Purge Data
|
||||
|
||||
* `inactive-player-data-days` -
|
||||
* `inactive-clan-days` -
|
||||
* `unverified-clan-days` -
|
||||
This feature allows you to purge data of inactive players or clans.
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
purge:
|
||||
@@ -447,16 +494,13 @@ purge:
|
||||
unverified-clan-days: 2
|
||||
```
|
||||
|
||||
## mySQL Settings
|
||||
## MySQL Settings
|
||||
|
||||
* `username` -
|
||||
* `host` -
|
||||
* `port` -
|
||||
* `enable` -
|
||||
* `password` -
|
||||
* `database` -
|
||||
The plugin supports SQLite and MySQL. By disabling MySQL, SQLite will be used automatically.
|
||||
|
||||
#### Example
|
||||
Set your credentials below to use MySQL on SimpleClans.
|
||||
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
mysql:
|
||||
@@ -470,9 +514,11 @@ mysql:
|
||||
|
||||
## Permissions
|
||||
|
||||
* `auto-group-groupname` -
|
||||
In this section, you can give clans specific permissions. In the example below, members of the clan "YourClanNameHere" will receive the permission "test.permission".
|
||||
|
||||
#### Example
|
||||
* `auto-group-groupname` - if enabled, members of clans will receive the permission "group.TAG" (tag, of course, gets replaced). **Be careful with this setting, if you are using LuckPerms, players could create a clan called "admin" and be automatically added to the corresponding group. If you are using it, disable the creation of such clans (mod, admin, etc).**
|
||||
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
permissions:
|
||||
@@ -483,12 +529,12 @@ permissions:
|
||||
|
||||
## Performance
|
||||
|
||||
* `save-periodically` - The plugin will save its data periodically as opposed to right away, **RECOMMENDED** to set it true.
|
||||
* `save-interval` - The interval **in minutes** in which changes are written to the database.
|
||||
* `use-threads` - The plugin will not use the main thread to connect with the database if this is true, **RECOMMENDED** to set it true.
|
||||
* `use-bungeecord` -
|
||||
* `save-periodically` - The plugin will save its data periodically as opposed to right away, **RECOMMENDED** to set it true. 
|
||||
* `save-interval` - The interval **in minutes** in which changes are written to the database. 
|
||||
* `use-threads` - The plugin will not use the main thread to connect with the database if this is true, **RECOMMENDED** to set it true. 
|
||||
* `use-bungeecord` - Enable it in both spigot plugins, also make sure you have one MySQL connection.
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
performance:
|
||||
@@ -502,9 +548,8 @@ performance:
|
||||
|
||||
* `safe-civilians` - Civilians are safe from PvP, even civilian vs civilian combat is disabled
|
||||
|
||||
#### Example
|
||||
### Example
|
||||
|
||||
```yaml
|
||||
safe-civilians: false
|
||||
```
|
||||
|
||||
@@ -1,12 +1,8 @@
|
||||
---
|
||||
description: null
|
||||
---
|
||||
|
||||
# Member Fee
|
||||
# 💰 Member Fee
|
||||
|
||||
## How does it work?
|
||||
|
||||
If enabled by the server and the clan, at `1am` a fee \(set by the leader\) is collected from the non-leaders. A member that doesn't have enough money to pay it will be automatically kicked from the clan. The collected fee is added to the clan bank.
|
||||
If enabled by the server and the clan, at `1am` a fee (set by the leader) is collected from the non-leaders. A member that doesn't have enough money to pay it will be automatically kicked from the clan. The collected fee is added to the clan bank.
|
||||
|
||||
## Configuration
|
||||
|
||||
@@ -27,16 +23,15 @@ economy:
|
||||
|
||||
## Permissions
|
||||
|
||||
| Permission | Description |
|
||||
| :--- | :--- |
|
||||
| `simpleclans.leader.fee` | Allows the user to toggle the fee and set its value |
|
||||
| Permission | Description |
|
||||
| ------------------------------ | ------------------------------------------------------------------ |
|
||||
| `simpleclans.leader.fee` | Allows the user to toggle the fee and set its value |
|
||||
| `simpleclans.member.fee-check` | allows the member to check how much is the fee and if it's enabled |
|
||||
|
||||
## Commands
|
||||
|
||||
| Permission | Description | Permission |
|
||||
| :--- | :--- | :--- |
|
||||
| `/clan toggle fee` | Enables/disables the fee | `simpleclans.leader.fee` |
|
||||
| `/clan fee set [amount]` | Sets the fee value | `simpleclans.leader.fee` |
|
||||
| `/clan fee check` | Checks the status of the fee | `simpleclans.member.fee-check` |
|
||||
|
||||
| Permission | Description | Permission |
|
||||
| ------------------------ | ---------------------------- | ------------------------------ |
|
||||
| `/clan toggle fee` | Enables/disables the fee | `simpleclans.leader.fee` |
|
||||
| `/clan fee set [amount]` | Sets the fee value | `simpleclans.leader.fee` |
|
||||
| `/clan fee check` | Checks the status of the fee | `simpleclans.member.fee-check` |
|
||||
@@ -1,15 +1,11 @@
|
||||
---
|
||||
description: null
|
||||
---
|
||||
|
||||
# Translation
|
||||
# 🍕 Translation
|
||||
|
||||
## Editing the plugin's messages
|
||||
|
||||
### Requirements:
|
||||
|
||||
* A ZIP explorer program \(such as [WinRAR](https://www.win-rar.com/download.html?&L=0) or [7-Zip](https://www.7-zip.org/download.html)\)
|
||||
* A Text editor like [NotePad++](https://notepad-plus-plus.org/downloads/), [Visual Studio Code](https://code.visualstudio.com/) or [Sublime Text](https://www.sublimetext.com/).
|
||||
* A ZIP explorer program (such as [WinRAR](https://www.win-rar.com/download.html?\&L=0) or [7-Zip](https://www.7-zip.org/download.html))
|
||||
* A Text editor like [Notepad++](https://notepad-plus-plus.org/downloads/), [Visual Studio Code](https://code.visualstudio.com/) or [Sublime Text](https://www.sublimetext.com/).
|
||||
|
||||
### Step by step
|
||||
|
||||
@@ -20,9 +16,15 @@ description: null
|
||||
4. Change `language` in config.yml to your language code;
|
||||
5. Reload the plugin using /clan reload.
|
||||
|
||||
### A little trick
|
||||
### Overriding specific messages
|
||||
|
||||
If you like the current translation, but want to change only a few lines: 1. Copy the file to the plugin's folder; 2. Delete all messages except the ones you would like to edit; 3. Edit them and save.
|
||||
If you like the current translation, but want to change only a few lines: 
|
||||
|
||||
1\. Copy the file to the plugin's folder; 
|
||||
|
||||
2\. Delete all messages except the ones you would like to edit; 
|
||||
|
||||
3\. Edit them and save.
|
||||
|
||||
> **Note**: Please note that your custom `messages.properties` does not automatically update when new messages are added.
|
||||
|
||||
@@ -31,4 +33,3 @@ If you like the current translation, but want to change only a few lines: 1. Cop
|
||||
SimpleClans has a project on [Crowdin](https://crowdin.com/project/simpleclans). There you can translate the messages and suggest corrections!
|
||||
|
||||
> **Note**: if you have an old `language.yml` file for SimpleClans that you translated to your language, [open an issue here](https://github.com/RoinujNosde/SimpleClans/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc), I will convert the file and add it to the plugin.
|
||||
|
||||
@@ -0,0 +1,138 @@
|
||||
---
|
||||
description: More space for communication
|
||||
---
|
||||
|
||||
# 👾 DiscordSRV
|
||||
|
||||
## Enabling
|
||||
|
||||
To enable this feature all what you need to do is enable it in `config.yml`and install [DiscordSRV](https://www.spigotmc.org/resources/discordsrv.18494/):
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="config.yml" %}
|
||||
```yaml
|
||||
discordchat:
|
||||
enable: true
|
||||
```
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
{% hint style="warning" %}
|
||||
**Notice**\
|
||||
****Please, make sure you have the latest version of DiscordSRV (>=1.23.0)
|
||||
{% endhint %}
|
||||
|
||||
## How does it work?
|
||||
|
||||
### Automatically
|
||||
|
||||
At the beginning of the launch of your server, SimpleClans will create categories for the number of your clans, inside the categories, there will be a separate text channel for each clan:
|
||||
|
||||
.png>)
|
||||
|
||||
{% hint style="warning" %}
|
||||
**Notice**\
|
||||
Take **attention** that you will have a different structure:\
|
||||
`clan1`, `clan2`, `clan3` and `clan4` will be placed in **one category**, until it's reached the limit, then creates a new category.
|
||||
{% endhint %}
|
||||
|
||||
**This will allow players to communicate in channels specially created for them.**
|
||||
|
||||
Discord channel will be created/deleted/modified when:
|
||||
|
||||
* Clan player creates/deletes a clan
|
||||
* Clan player is joining/resigning from his clan
|
||||
* Clan player got a promotion or a demotion
|
||||
* Player just linked to Discord
|
||||
|
||||
### Manually
|
||||
|
||||
Since SimpleClans 2.16.2, it's possible to disable auto clan creation and create the discord channel by command. 
|
||||
|
||||
To enable manually this way, you have to disable related config option:
|
||||
|
||||
```yaml
|
||||
discordchat:
|
||||
auto-creation: false
|
||||
```
|
||||
|
||||
Our congratulations! Now all leaders with a specified permission (`simpleclans.leader.discord.create`) can create their discord channel.
|
||||
|
||||
With that permission they are allowed to use a command to create their clan's discord channel:
|
||||
|
||||
```
|
||||
/clan discord create
|
||||
```
|
||||
|
||||
Furthermore, if you're using an economy plugin, you can specify a price for clan creation:
|
||||
|
||||
```yaml
|
||||
economy:
|
||||
purchase-discord-create: true
|
||||
discord-creation-price: 1000
|
||||
```
|
||||
|
||||
### General notes
|
||||
|
||||
{% hint style="info" %}
|
||||
**Note 1** \
|
||||
****Only linked players have an access to their clans in discord, but the messages from un-linked will sent too.
|
||||
{% endhint %}
|
||||
|
||||
{% hint style="info" %}
|
||||
**Note 2**\
|
||||
****If you're the server owner and you can't write a message to another chats, ask yourself: \
|
||||
_is SimpleClans allow to you to send the message to other clan chats?_ \
|
||||
You could use `/clan mod place <necessary clan>` to join and send the message to that chat.
|
||||
{% endhint %}
|
||||
|
||||
## Discord limits
|
||||
|
||||
> Only 50 channels at category as maximum
|
||||
|
||||
So when the category will be filled with 50 channels, SimpleClans will create a new category and place a new channel there.
|
||||
|
||||
> Maximum 500 channels at discord server
|
||||
|
||||
 That is why, if you have more than 500 clans, then SimpleClans won't catch all of them.\
|
||||
 You could use `discordchat.text.clans-limit` at configuration.
|
||||
|
||||
## Configuration
|
||||
|
||||
### DiscordChat section
|
||||
|
||||
| Config value | Description |
|
||||
| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
|
||||
| `discordchat.enable` | Enables the DiscordSRV integration |
|
||||
| `discordchat.discord-format` | The message format from minecraft to discord |
|
||||
| `discordchat.format` | The message format from discord to minecraft |
|
||||
| `discordchat.spy-format` | <p> The message format from discord to server admins <br>(<code>simpleclans.admin.all-seeing-eye</code>)</p> |
|
||||
| `discordchat.rank` | The rank format |
|
||||
| `discordchat.auto-creation` | Turns off automatic discord channels creation. Use `clan discord create` command for manually creation |
|
||||
| `discordchat.min-linked-players-to-create` | The count of minimum linked players to be able to create the discord channel |
|
||||
| `discordchat.text.category-format` | The name of category ("SC – TextChannel") |
|
||||
| `discordchat.text.category-ids` | The ids of SC categories. You may add your own category here if you want to |
|
||||
| `discordchat.text.whitelist` | This will allow only specified clans be created |
|
||||
| `discordchat.text.clans-limit` | Limit of discord channels. Maximum is 500. |
|
||||
|
||||
### Economy section
|
||||
|
||||
| Config value | Description |
|
||||
| --------------------------------- | -------------------------------------------------------- |
|
||||
| `economy.purchase-discord-create` | Allows leaders to purchase the discord channel creation. |
|
||||
| `economy.discord-creation-price` | How much channel purchasing will cost? |
|
||||
|
||||
## DiscordSRV configuration
|
||||
|
||||
 Some of DiscordSRV configurations won't work on SC channels.\
|
||||
 There is the small __ list:
|
||||
|
||||
* `DiscordChatChannelDiscordToMinecraft` – Do you really need to disable it in DiscordSRV's config, when you may disable it in SC config?<img src="https://github.githubassets.com/images/icons/emoji/unicode/1f914.png" alt="thinking" data-size="line">
|
||||
* `DiscordChatChannelRequireLinkedAccount` _–_ Our implementation requires only linked players.
|
||||
* `DiscordChatChannelBlockBots` – We're all robots, now you know the truth<img src="https://github.githubassets.com/images/icons/emoji/unicode/1f916.png" alt="robot" data-size="line">
|
||||
* `DiscordChatChannelBlockedIds` – Where is an option to block my IP?
|
||||
* `DiscordChatChannelBroadcastDiscordMessagesToConsole` – You have spy chat for admins for that.
|
||||
* `DiscordChatChannelTruncateLength` – Does anyone know what `truncate` is?
|
||||
* `DiscordChatChannelRolesAllowedToUseColorCodesInChat` – No.
|
||||
|
||||
 At least, `DiscordChatChannelEmojiBehavior` will work.<img src="https://github.githubassets.com/images/icons/emoji/unicode/1f603.png" alt="smiley" data-size="line">
|
||||
@@ -0,0 +1,78 @@
|
||||
---
|
||||
description: This page contains information about sharing your lands with clan members.
|
||||
---
|
||||
|
||||
# 🏝 Land Claiming
|
||||
|
||||
## Sharing lands
|
||||
|
||||
Currently, SimpleClans may work with GriefPrevention, WorldGuard (also plugins depending on it) and PlotSquared. It has default methods to allow and block different actions (break, place, interact, etc.).
|
||||
|
||||
Take a look at the [configuration](../how-to-setup/configuration.md).\
|
||||
Here is the full command list:
|
||||
|
||||
> Optional argument marked as \[argument]
|
||||
|
||||
| Command | Description |
|
||||
| --------------------------- | ----------------------------------------------------------------- |
|
||||
| `/clan land allow [action]` | Allows **the specified action** on this land to your clan members |
|
||||
| `/clan land block [action]` | Blocks **the specified action** on this land to your clan members |
|
||||
|
||||
Actions list:
|
||||
|
||||
| Action | Description |
|
||||
| ---------------- | ----------------------------------------------------------------------------- |
|
||||
| container | Used to allow/block opening chests, anvils, enchant tables, etc. on your land |
|
||||
| place\_block | Used to allow/block placing blocks on your land |
|
||||
| break | Used to allow/block breaking blocks on your land |
|
||||
| damage | Used to allow/block taking any of sort damage on your land |
|
||||
| interact | Used to allow/block doors, buttons, levers, etc. on your land |
|
||||
| interact\_entity | Used to allow/block interacting with entities on your land |
|
||||
| all | Used to allow/block all actions |
|
||||
|
||||
**Example:** `/clan land allow place_block` will allow placing blocks on your land for your clan members.
|
||||
|
||||
{% hint style="info" %}
|
||||
**Note**\
|
||||
The commands will affect the land you are currently standing on or all lands, if you are not in one _(when edit-all-lands is true)_.
|
||||
{% endhint %}
|
||||
|
||||
## Making your own provider
|
||||
|
||||
{% hint style="warning" %}
|
||||
**Warning**\
|
||||
Work in progress.
|
||||
{% endhint %}
|
||||
|
||||
## Another ways of sharing lands
|
||||
|
||||
### GriefPrevention
|
||||
|
||||
Configuration:
|
||||
|
||||
* `enable-auto-groups` - 
|
||||
* `auto-group-groupname`- 
|
||||
|
||||
```yaml
|
||||
settings:
|
||||
enable-auto-groups: false
|
||||
permissions:
|
||||
auto-group-groupname: true
|
||||
YourClanNameHere:
|
||||
- test.permission
|
||||
```
|
||||
|
||||
You can replace `<clantag>` with ANY clan tag (ally, rival, etc)
|
||||
|
||||
| Command | Description |
|
||||
| ---------------------------------- | ----------------------------------------------------------------------------------------------------------- |
|
||||
| `/trust group.<clantag>` | Gives the Clan members permission to edit in your claim |
|
||||
| `/accesstrust group.<clantag>` | Gives the Clan members permission to use your buttons, levers, and beds |
|
||||
| `/containertrust group.<clantag>` | Gives the Clan members permission to use your buttons, levers, beds, crafting gear, containers, and animals |
|
||||
| `/permissiontrust group.<clantag>` | Gives the Clan members permission to share their permission level with others |
|
||||
| `/untrust group.<clantag>` | Revokes any permissions granted to a Clan in your claim |
|
||||
|
||||
{% hint style="info" %}
|
||||
**Note**\
|
||||
After the permission is given, the player must reconnect.
|
||||
{% endhint %}
|
||||
@@ -0,0 +1,97 @@
|
||||
---
|
||||
description: More space for communication
|
||||
---
|
||||
|
||||
# DiscordSRV integration
|
||||
|
||||
## Enabling
|
||||
|
||||
To enable this feature, you need to have the latest [dev build](https://ci.codemc.io/job/RoinujNosde/job/SimpleClans/job/Dev/) of SimpleClans and enable it in `config.yml`:
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="config.yml" %}
|
||||
```yaml
|
||||
discordchat:
|
||||
enable: true
|
||||
```
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
{% hint style="warning" %}
|
||||
**Notice**
|
||||
Please, make sure you have the latest version of DiscordSRV \(1.23.0\)
|
||||
{% endhint %}
|
||||
|
||||
## How does it work?
|
||||
|
||||
At the beginning of the launch of your server, SimpleClans will create categories for the number of your clans, inside the categories, there will be a separate text channel for each clan:
|
||||
|
||||
|
||||
|
||||
{% hint style="warning" %}
|
||||
**Notice**
|
||||
Take **attention** that you will have a different structure:
|
||||
`clan1`, `clan2`, `clan3` and `clan4` will be placed in **one category**, until it's reached the limit, then creates a new category.
|
||||
{% endhint %}
|
||||
|
||||
**This will allow players to communicate in channels specially created for them.**
|
||||
|
||||
Discord channel will be created/deleted/modified when:
|
||||
|
||||
* Clan player creates/deletes a clan
|
||||
* Clan player is joining/resigning from his clan
|
||||
* Clan player got a promotion or a demotion
|
||||
* Player just linked to discord
|
||||
|
||||
{% hint style="info" %}
|
||||
**Note 1**
|
||||
Only linked players have an access to their clans in discord, but the messages from un-linked will sent too.
|
||||
{% endhint %}
|
||||
|
||||
{% hint style="info" %}
|
||||
**Note 2**
|
||||
If you're the server owner and you can't write a message to another chats, ask yourself:
|
||||
_is SimpleClans allow to you to send the message to other clan chats?_
|
||||
You could use `/clan mod place <necessary clan>` to join and send the message to that chat.
|
||||
{% endhint %}
|
||||
|
||||
## Speaking about Discord's limits...
|
||||
|
||||
> Only 50 channels at category as maximum
|
||||
|
||||
So when the category will be filled with 50 channels, SimpleClans will create a new category and place a new channel there.
|
||||
|
||||
> Maximum 500 channels at discord server
|
||||
|
||||
That is why, if you have more than 500 clans, then SimpleClans won't catch all of them.
|
||||
You could use `discordchat.text.clans-limit` at configuration.
|
||||
|
||||
## Configuration
|
||||
|
||||
| Config value | Description |
|
||||
| :--- | :--- |
|
||||
| `discordchat.enable` | Enables the DiscordSRV integration |
|
||||
| `discordchat.discord-format` | The message format from minecraft to discord |
|
||||
| `discordchat.format` | The message format from discord to minecraft |
|
||||
| `discordchat.spy-format` | The message format from discord to server admins \(`simpleclans.admin.all-seeing-eye`\) |
|
||||
| `discordchat.rank` | The rank format |
|
||||
| `discordchat.text.category-format` | The name of category \("SC – TextChannel"\) |
|
||||
| `discordchat.text.category-ids` | The ids of SC categories. You may add your own category here if you want to |
|
||||
| `discordchat.text.whitelist` | This will allow only specified clans be created |
|
||||
| `discordchat.text.clans-limit` | Limit of discord channels. Maximum is 500. |
|
||||
|
||||
## Options that will not work
|
||||
|
||||
Some of DiscordSRV configurations won't work on SC channels.
|
||||
There is the small __list:
|
||||
|
||||
* `DiscordChatChannelDiscordToMinecraft` – Do you really need to disable it in DiscordSRV's config, when you may disable it in SC config?
|
||||
* `DiscordChatChannelRequireLinkedAccount` _–_ Our implementation requires only linked players.
|
||||
* `DiscordChatChannelBlockBots` – We're all robots, now you know the truth
|
||||
* `DiscordChatChannelBlockedIds` – Where is an option to block my IP?
|
||||
* `DiscordChatChannelBroadcastDiscordMessagesToConsole` – You have spy chat for admins for that.
|
||||
* `DiscordChatChannelTruncateLength` – Does anyone know what `truncate` is?
|
||||
* `DiscordChatChannelRolesAllowedToUseColorCodesInChat` – No.
|
||||
|
||||
At least, `DiscordChatChannelEmojiBehavior` will work.
|
||||
|
||||
@@ -2,17 +2,17 @@
|
||||
description: List of the plugin's known issues and possible solutions.
|
||||
---
|
||||
|
||||
# Known issues
|
||||
# 🪓 Known issues
|
||||
|
||||
#### MySQL \#1366 - Incorrect string value
|
||||
#### MySQL #1366 - Incorrect string value
|
||||
|
||||
This error happens when you try to insert characters that MySQL's current encoding doesn't support.
|
||||
|
||||
**Solution:** change MySQL's encoding to `utf8mb4`.
|
||||
1. Open MySQL's `my.cnf`.
|
||||
2. Add these configurations, save and restart MySQL:
|
||||
**Solution:** change MySQL's encoding to `utf8mb4`.\
|
||||
1\. Open MySQL's `my.cnf`.\
|
||||
2\. Add these configurations, save and restart MySQL:
|
||||
|
||||
```text
|
||||
```
|
||||
[mysql]
|
||||
default-character-set=utf8mb4
|
||||
[mysqld]
|
||||
@@ -26,3 +26,20 @@ Players report that their KDR is not changing.
|
||||
|
||||
**Solution:** deny the permission `simpleclans.other.kdr-exempt`. In some permission plugins, just add a `-` before the node. Others accept the `false` value.
|
||||
|
||||
#### Geyser | Error while opening GUI
|
||||
|
||||
Since SimpleClans is using player heads in its GUI, you may face with a [Geyser limitation](https://wiki.geysermc.org/geyser/current-limitations/).
|
||||
|
||||
After you try to open the menu (`/clan`), you may get the error in the console. \
|
||||
In it you can find the mark of this error:
|
||||
|
||||
```
|
||||
Caused by: java.lang.IllegalArgumentException: Name and ID cannot both be blank
|
||||
```
|
||||
|
||||
**Solution**:\
|
||||
Disable this option in your geyser configuration file.
|
||||
|
||||
```yaml
|
||||
allow-custom-skulls: false
|
||||
```
|
||||
@@ -0,0 +1,79 @@
|
||||
---
|
||||
description: This page contains information about sharing your lands with clan members.
|
||||
---
|
||||
|
||||
# Land Claiming
|
||||
|
||||
## Sharing lands
|
||||
|
||||
Currently, SimpleClans may work with GriefPrevention, WorldGuard \(also plugins depending on it\) and PlotSquared. It has default methods to allow and block different actions \(break, place, interact, etc.\).
|
||||
|
||||
Take a look at the [configuration](https://simpleclans.gitbook.io/simpleclans/how-to-setup/configuration#war-and-protection).
|
||||
Here is the full command list:
|
||||
|
||||
> Optional argument marked as \[argument\]
|
||||
|
||||
| Command | Description |
|
||||
| :--- | :--- |
|
||||
| `/clan land allow [action]` | Allows **the specified action** on this land to your clan members |
|
||||
| `/clan land block [action]` | Blocks **the specified action** on this land to your clan members |
|
||||
|
||||
Actions list:
|
||||
|
||||
| Action | Description |
|
||||
| :--- | :--- |
|
||||
| container | Used to allow/block opening chests, anvils, enchant tables, etc. on your land |
|
||||
| place\_block | Used to allow/block placing blocks on your land |
|
||||
| break | Used to allow/block breaking blocks on your land |
|
||||
| damage | Used to allow/block taking any of sort damage on your land |
|
||||
| interact | Used to allow/block doors, buttons, levers, etc. on your land |
|
||||
| interact\_entity | Used to allow/block interacting with entities on your land |
|
||||
| all | Used to allow/block all actions |
|
||||
|
||||
**Example:** `/clan land allow place_block` will allow placing blocks on your land for your clan members.
|
||||
|
||||
{% hint style="info" %}
|
||||
**Note**
|
||||
The commands will affect the land you are currently standing on or all lands, if you are not in one _\(when edit-all-lands is true\)_.
|
||||
{% endhint %}
|
||||
|
||||
## Making your own provider
|
||||
|
||||
{% hint style="warning" %}
|
||||
**Warning**
|
||||
Work in progress.
|
||||
{% endhint %}
|
||||
|
||||
## Another ways of sharing lands
|
||||
|
||||
### GriefPrevention
|
||||
|
||||
Configuration:
|
||||
|
||||
* `enable-auto-groups` -
|
||||
* `auto-group-groupname`-
|
||||
|
||||
```yaml
|
||||
settings:
|
||||
enable-auto-groups: false
|
||||
permissions:
|
||||
auto-group-groupname: true
|
||||
YourClanNameHere:
|
||||
- test.permission
|
||||
```
|
||||
|
||||
You can replace `<clantag>` with ANY clan tag \(ally, rival, etc\)
|
||||
|
||||
| Command | Description |
|
||||
| :--- | :--- |
|
||||
| `/trust group.<clantag>` | Gives the Clan members permission to edit in your claim |
|
||||
| `/accesstrust group.<clantag>` | Gives the Clan members permission to use your buttons, levers, and beds |
|
||||
| `/containertrust group.<clantag>` | Gives the Clan members permission to use your buttons, levers, beds, crafting gear, containers, and animals |
|
||||
| `/permissiontrust group.<clantag>` | Gives the Clan members permission to share their permission level with others |
|
||||
| `/untrust group.<clantag>` | Revokes any permissions granted to a Clan in your claim |
|
||||
|
||||
{% hint style="info" %}
|
||||
**Note**
|
||||
After the permission is given, the player must reconnect.
|
||||
{% endhint %}
|
||||
|
||||
@@ -1,38 +0,0 @@
|
||||
---
|
||||
description: null
|
||||
---
|
||||
|
||||
# Land Claims Plugins
|
||||
|
||||
## Configuration
|
||||
|
||||
* `enable-auto-groups` -
|
||||
* `auto-group-groupname`-
|
||||
|
||||
### Exemple
|
||||
|
||||
```yaml
|
||||
settings:
|
||||
enable-auto-groups: false
|
||||
permissions:
|
||||
auto-group-groupname: true
|
||||
YourClanNameHere:
|
||||
- test.permission
|
||||
```
|
||||
|
||||
## GriefPrevention
|
||||
|
||||
You can replace `<clantag>` with ANY clan tag \(ally, rival, etc\)
|
||||
|
||||
| Command | Description |
|
||||
| :--- | :--- |
|
||||
| `/Trust group.<clantag>` | Gives the Clan members permission to edit in your claim |
|
||||
| `/AccessTrust group.<clantag>` | Gives the Clan members permission to use your buttons, levers, and beds |
|
||||
| `/ContainerTrust group.<clantag>` | Gives the Clan members permission to use your buttons, levers, beds, crafting gear, containers, and animals |
|
||||
| `/PermissionTrust group.<clantag>` | Gives the Clan members permission to share their permission level with others |
|
||||
| `/UnTrust group.<clantag>` | Revokes any permissions granted to a Clan in your claim |
|
||||
|
||||
## Note
|
||||
|
||||
After the permission is given, the player must reconnect.
|
||||
|
||||
@@ -1,92 +1,44 @@
|
||||
---
|
||||
description: null
|
||||
---
|
||||
|
||||
# PlaceholderAPI Support
|
||||
# 🪜 Placeholders
|
||||
|
||||
## Available placeholders
|
||||
|
||||
| Placeholder | Result | Description | |
|
||||
| :--- | :--- | :--- | :--- |
|
||||
| %simpleclans\_neutral\_kills% | INTEGER | | |
|
||||
| %simpleclans\_rival\_kills% | INTEGER | | |
|
||||
| %simpleclans\_civilian\_kills% | INTEGER | | |
|
||||
| %simpleclans\_total\_kills% | INTEGER | | |
|
||||
| %simpleclans\_weighted\_kills% | INTEGER | | |
|
||||
| %simpleclans\_deaths% | INTEGER | | |
|
||||
| %simpleclans\_kdr% | FLOAT | | |
|
||||
| %simpleclans\_in\_clan% | BOOLEAN \(YES/NO\) | | |
|
||||
| %simpleclans\_is\_leader% | BOOLEAN \(YES/NO\) | | |
|
||||
| %simpleclans\_is\_trusted% | BOOLEAN \(YES/NO\) | | |
|
||||
| %simpleclans\_is\_member% | BOOLEAN \(YES/NO\) | | |
|
||||
| %simpleclans\_is\_bb\_enabled% | BOOLEAN \(YES/NO\) | | |
|
||||
| %simpleclans\_is\_usechatshortcut% | BOOLEAN \(YES/NO\) | | |
|
||||
| %simpleclans\_is\_allychat% | BOOLEAN \(YES/NO\) | | |
|
||||
| %simpleclans\_is\_clanchat% | BOOLEAN \(YES/NO\) | | |
|
||||
| %simpleclans\_is\_globalchat% | BOOLEAN \(YES/NO\) | | |
|
||||
| %simpleclans\_is\_cape\_enabled% | BOOLEAN \(YES/NO\) | | |
|
||||
| %simpleclans\_is\_tag\_enabled% | BOOLEAN \(YES/NO\) | | |
|
||||
| %simpleclans\_is\_friendlyfire\_on% | BOOLEAN \(YES/NO\) | | |
|
||||
| %simpleclans\_is\_muted% | BOOLEAN \(YES/NO\) | | |
|
||||
| %simpleclans\_is\_mutedally% | BOOLEAN \(YES/NO\) | | |
|
||||
| %simpleclans\_join\_date% | DATE | Month, Day, Year, Hour | |
|
||||
| %simpleclans\_inactive\_days% | INTEGER | | |
|
||||
| %simpleclans\_lastseen% | INTEGER | | |
|
||||
| %simpleclans\_lastseendays% | INTEGER | | |
|
||||
| %simpleclans\_tag% | STRING | lowerscored Clan tag without color | |
|
||||
| %simpleclans\_tag\_label% | STRING | Clan tag with correct mayus, color and at the end &c | |
|
||||
| %simpleclans\_rank% | STRING | | |
|
||||
| %simpleclans\_rank\_displayname% | STRING | | |
|
||||
| %simpleclans\_clanchat\_player\_color% | | | |
|
||||
| %simpleclans\_allychat\_player\_color% | | | |
|
||||
| %simpleclans\_clan\_total\_neutral% | INTEGER | | |
|
||||
| %simpleclans\_clan\_total\_civilian% | INTEGER | | |
|
||||
| %simpleclans\_clan\_total\_rival% | INTEGER | | |
|
||||
| %simpleclans\_clan\_total\_kills% | INTEGER | | |
|
||||
| %simpleclans\_clan\_total\_deaths% | INTEGER | | |
|
||||
| %simpleclans\_clan\_total\_kdr% | FLOAT | | |
|
||||
| %simpleclans\_clan\_average\_wk% | INTEGER | | |
|
||||
| %simpleclans\_clan\_leader\_size% | INTEGER | | |
|
||||
| %simpleclans\_clan\_balance% | INTEGER | | |
|
||||
| %simpleclans\_clan\_allow\_withdraw% | BOOLEAN \(YES/NO\) | | |
|
||||
| %simpleclans\_clan\_allow\_deposit% | BOOLEAN \(YES/NO\) | | |
|
||||
| %simpleclans\_clan\_size% | INTEGER | | |
|
||||
| %simpleclans\_clan\_name% | STRING | | |
|
||||
| %simpleclans\_clan\_color\_tag% | | | |
|
||||
| %simpleclans\_clan\_tag% | | | |
|
||||
| %simpleclans\_clan\_founded% | | | |
|
||||
| %simpleclans\_clan\_friendly\_fire% | | | |
|
||||
| %simpleclans\_clan\_is\_unrivable% | | | |
|
||||
| %simpleclans\_clan\_is\_anyonline% | | | |
|
||||
| %simpleclans\_clan\_is\_verified% | | | |
|
||||
| %simpleclans\_clan\_capeurl% | | | |
|
||||
| %simpleclans\_clan\_inactivedays% | | | |
|
||||
| %simpleclans\_clan\_onlinemembers\_count% | | | |
|
||||
| %simpleclans\_clan\_allies\_count% | | | |
|
||||
| %simpleclans\_clan\_rivals\_count% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_total\_neutral% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_total\_civilian% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_total\_rival% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_total\_kills% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_total\_deaths% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_total\_kdr% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_average\_wk% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_leader\_size% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_balance% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_allow\_withdraw% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_allow\_deposit% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_size% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_name% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_color\_tag% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_tag% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_founded% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_friendly\_fire% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_is\_unrivable% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_is\_anyonline% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_is\_verified% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_capeurl% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_inactivedays% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_onlinemembers\_count% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_allies\_count% | | | |
|
||||
| %simpleclanstopclans\_\#\_clan\_rivals\_count% | | | |
|
||||
<table><thead><tr><th>Placeholder</th><th width="389.3333333333333">Description</th></tr></thead><tbody><tr><td>%simpleclans_name%</td><td>Displays the clan members name, returns name.</td></tr><tr><td>%simpleclans_clean_name%</td><td>Displays the clan members name in all Lowercase, returns name.</td></tr><tr><td>%simpleclans_is_muted%</td><td>Has the clan member muted the clan chat? Related to <code>/. mute</code>. Returns <code>yes</code> or <code>no</code>.</td></tr><tr><td>%simpleclans_is_mutedally%</td><td>Has the clan member muted ally chat?<br>Related to <code>/ally mute</code>. Returns <code>yes</code> or <code>no</code>.</td></tr><tr><td>%simpleclans_in_clan%</td><td>Is the player in a clan?<br>Returns <code>yes</code> or <code>no</code>.</td></tr><tr><td>%simpleclans_join_date%</td><td><p>Displays the date the clan member joined the clan.</p><p>Returns <code>Month</code>, <code>Day</code>, <code>Year</code>, <code>Hour</code>.</p></td></tr><tr><td>%simpleclans_lastseen%</td><td>Displays when a clan member was last logged into server<br>Returns <code>Month</code>, <code>Day</code>, <code>Year</code>, <code>Hour</code>, or if active returns <code>Online</code>.</td></tr><tr><td>%simpleclans_lastseendays%</td><td>Displays when a clan member was last logged into server, returns number or Today if active the same day.</td></tr><tr><td>%simpleclans_inactive_days%</td><td>Displays how many days a clan member has not been active, returns number</td></tr><tr><td>%simpleclans_is_member%</td><td>Is the clan member a standard member of the clan?<br>Returns <code>yes</code> or <code>no</code>.</td></tr><tr><td>%simpleclans_is_trusted%</td><td>Is this clan member a trusted member of the clan? <br>Returns <code>yes</code> or <code>no</code>.</td></tr><tr><td>%simpleclans_is_leader%</td><td><p>Is the clan member the leader of the clan?</p><p>Returns <code>yes</code> or <code>no</code>.</p></td></tr><tr><td>%simpleclans_is_invite_enabled%</td><td>Is the clan member can be invited to other clans? <br>Returns <code>yes</code> or <code>no</code>.</td></tr><tr><td>%simpleclans_rank%</td><td>Displays the clan members current Rank, returns name of the rank.</td></tr><tr><td>%simpleclans_has_rank%</td><td>Does the clan member have any rank? <br>Returns: <code>yes</code> or <code>no</code>.</td></tr><tr><td>%simpleclans_rank_displayname%</td><td>Displays the clan members current Rank displayname, related to /clan rank setdisplayname, returns custom display name of the rank</td></tr><tr><td>%simpleclans_neutral_kills%</td><td>Total kills of players in clans that are not a ally or rival clan, returns number.</td></tr><tr><td>%simpleclans_rival_kills%</td><td>Total kills of players that are in a Rival clan, returns number.</td></tr><tr><td>%simpleclans_civilian_kills%</td><td>Total kills of players that are not in a clan, returns number.</td></tr><tr><td>%simpleclans_ally_kills%</td><td>Total kills of players that are in a allied clan, returns number.</td></tr><tr><td>%simpleclans_total_kills%</td><td>Total kills in all, civilians, rivals, allies and neutrals, returns number.</td></tr><tr><td>%simpleclans_weighted_kills%</td><td>Displays the clan members weighted kill points, this is based off set points for each type of kill, see Config for settings, returns number.</td></tr><tr><td>%simpleclans_deaths%</td><td>Total times the clan member has died, returns number.</td></tr><tr><td>%simpleclans_kdr%</td><td>Kill Death Ratio, the balance between clan members Kills and Deaths, returns number.</td></tr><tr><td>%simpleclans_is_bb_enabled%</td><td><p>Bulletin board toggle.</p><p>Related to <code>/clan toggle</code> command.</p><p>Returns <code>yes</code> or <code>no</code>.</p></td></tr><tr><td>%simpleclans_is_tag_enabled%</td><td><p>Clan tag toggle.</p><p>Related to <code>/clan toggle</code> command.</p><p>Returns `yes` or <code>no</code>.</p></td></tr><tr><td>%simpleclans_is_friendlyfire_on%</td><td><p>Has the clan member got Friendly Fire Enabled. Related to <code>/clan ff</code>.</p><p>Returns <code>yes</code> or <code>no</code>.</p></td></tr><tr><td>%simpleclans_tag%</td><td>Returns the clans Tag in lowercase and unformatted.</td></tr><tr><td>%simpleclans_tag_label%</td><td>Returns the clan Tag with correct mayus, color and at the end &c relates to /clan modtag</td></tr><tr><td>%simpleclans_clanchat_player_color%</td><td><p>Gives other plugins <strong>Clan</strong> chat colors as set in config.</p><p>Returns &c format<br>Link: <a data-mention href="../how-to-setup/configuration.md#clan-chat">#clan-chat</a></p></td></tr><tr><td>%simpleclans_allychat_player_color%</td><td><p>Gives other plugins <strong>Ally</strong> chat colors as set in config.</p><p>Returns &c format<br>Link: <a data-mention href="../how-to-setup/configuration.md#ally-chat">#ally-chat</a></p></td></tr><tr><td>%simpleclans_clan_total_neutral%</td><td>Total kills of players in clans that are not a ally or rival clan, by all clan members, returnLine truncated
|
||||
|
||||
#### Top Clans Placeholders
|
||||
|
||||
The top clans is a group of placeholders that helps you create leaderboards.\
|
||||
You can put `_topclans_#_` in any existing clan placeholder to get the value for the clan in a specific rank position.\
|
||||
Ex.:\
|
||||
`%simpleclans_topclans_1_clan_name%` - this will return the name of the Clan in the first position.
|
||||
|
||||
#### Top Players Placeholders
|
||||
|
||||
This one is another group of placeholders to create leaderboards. As the name suggests, it's about players and not clans, but they work similarly.\
|
||||
Adding `_topplayers_#_` to existing player placeholders will get the value for the Player in the specified rank.\
|
||||
Ex.:\
|
||||
`%simpleclans_topplayers_2_tag_label%` - this will return the tag label for the Player in the second position.
|
||||
|
||||
#### Relational placeholders
|
||||
|
||||
Relational placeholders return values based on the relation between 2 players. One example is the tab, there is the player viewing it and the players listed there\
|
||||
Currently the only relational placeholder available on SimpleClans is: `%rel_simpleclans_color%`\
|
||||
This returns a color based on rivalries/alliances.\
|
||||
Allies: aqua\
|
||||
Rivals: red\
|
||||
Same clan: green
|
||||
|
||||
The colors above can be changed in PlaceholderAPI's config.
|
||||
|
||||
**Example**
|
||||
|
||||
`belowname-objective:`
|
||||
|
||||
`enabled: true`
|
||||
|
||||
`clan: "%rel_simpleclans_color%%simpleclans_tag%"`
|
||||
|
||||
This will add the clans tag below the players name, to members of your clan the tag will show green, to members of allied clans the tag will show aqua, to members of rivalled clans tag will show red, same for when your clan members see allies and rivals.
|
||||
|
||||
#### HolographicDisplays
|
||||
|
||||
If you intend to use these placeholders with HolographicDisplays, remember to [download ](https://www.spigotmc.org/resources/18461/)the extension.
|
||||
+120
-38
@@ -1,61 +1,143 @@
|
||||
---
|
||||
description: null
|
||||
description: >-
|
||||
This page will help you understand how to install and use the SimpleClans API
|
||||
in your plugins.
|
||||
---
|
||||
|
||||
# SimpleClans API Example
|
||||
# ♟️ API Examples
|
||||
|
||||
## Step 1. Add the SimpleClans API to your plugin
|
||||
|
||||
There are two ways to do this: via Maven or locally. \
|
||||
We strongly **recommend** doing this via Maven.
|
||||
|
||||
### Maven
|
||||
|
||||
Add the following lines to `pom.xml`:
|
||||
|
||||
```markup
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>roinujnosde-repo</id>
|
||||
<url>https://repo.roinujnosde.me/releases/</url>
|
||||
</repository>
|
||||
</repositories>
|
||||
```
|
||||
|
||||
```markup
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>net.sacredlabyrinth.phaed.simpleclans</groupId>
|
||||
<artifactId>SimpleClans</artifactId>
|
||||
<version>2.19.2</version>
|
||||
<!-- You can find out the latest available version in the note below -->
|
||||
<scope>provided</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
```
|
||||
|
||||
{% hint style="info" %}
|
||||
**Note**\
|
||||
The latest version can be found here: [link](https://github.com/RoinujNosde/SimpleClans/releases)
|
||||
{% endhint %}
|
||||
|
||||
### Locally
|
||||
|
||||
In this example, we will use the IntelliJ IDEA, but the following actions also work in other IDEs.
|
||||
|
||||
1. Open the structure of your project (`F4`)
|
||||
2. Select Libraries, click on the cross, select "New Project Library -> Java" in the window that appears and add SimpleClans.
|
||||
|
||||
 (1).png>)
|
||||
|
||||
Return to the project structure, then go to Project Settings - > Modules, set the compilation mode to "Provided".
|
||||
|
||||
 (1).png>)
|
||||
|
||||
* [x] Congratulations, you have added the SimpleClans API to your project. 😃
|
||||
|
||||
## Step 2. Use the SimpleClans API
|
||||
|
||||
#### What do you need to know?
|
||||
|
||||
* [**ClanPlayer**](https://ci.roinujnosde.me/job/SimpleClans/Javadoc/net/sacredlabyrinth/phaed/simpleclans/ClanPlayer.html) is a class that represents a player object. This class contains information about the player, his clan, etc.
|
||||
* [**Clan**](https://ci.roinujnosde.me/job/SimpleClans/Javadoc/net/sacredlabyrinth/phaed/simpleclans/Clan.html) is a class that presents a clan object. It has methods for getting clan players, clan tag, allies, leaders, etc.
|
||||
* [**ClanManager**](https://ci.roinujnosde.me/job/SimpleClans/Javadoc/net/sacredlabyrinth/phaed/simpleclans/managers/ClanManager.html) is a class that allows you to retrieve **Clan** and **ClanPlayer**.
|
||||
|
||||
#### Example of using SimpleClans API
|
||||
|
||||
You can hook into SimpleClans plugin like so:
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="MyPlugin.class" %}
|
||||
```java
|
||||
private SimpleClans sc;
|
||||
|
||||
public void onEnable()
|
||||
{
|
||||
Plugin plug = getServer().getPluginManager().getPlugin("SimpleClans");
|
||||
|
||||
if (plug != null)
|
||||
{
|
||||
sc = ((SimpleClans) plug);
|
||||
public class MyPlugin extends JavaPlugin {
|
||||
private static MyPlugin instance;
|
||||
private SimpleClans sc;
|
||||
|
||||
@Override
|
||||
public void onEnable() {
|
||||
instance = this;
|
||||
|
||||
Plugin plug = getServer().getPluginManager().getPlugin("SimpleClans");
|
||||
if (plug != null) {
|
||||
sc = (SimpleClans) plug;
|
||||
}
|
||||
}
|
||||
|
||||
public SimpleClans getSCPlugin() {
|
||||
return sc;
|
||||
}
|
||||
|
||||
public static getInstance() {
|
||||
return instance;
|
||||
}
|
||||
}
|
||||
```
|
||||
{% endtab %}
|
||||
|
||||
{% tab title="Example.class" %}
|
||||
```java
|
||||
public void doClanStuff(Player player)
|
||||
{
|
||||
// get a player's clan
|
||||
public class Example {
|
||||
|
||||
if (sc != null)
|
||||
{
|
||||
ClanPlayer cp = sc.getClanManager().getClanPlayer(player.getUniqueId());
|
||||
|
||||
if (cp != null)
|
||||
{
|
||||
public void doClanStuff(Player player) {
|
||||
UUID playerUuid = player.getUniqueId();
|
||||
|
||||
// Get a ClanManager object
|
||||
ClanManager cm = MyPlugin.getInstance().getSCPlugin().getClanManager();
|
||||
|
||||
// Get a ClanPlayer object
|
||||
ClanPlayer cp = cm.getClanPlayer(playerUuid);
|
||||
|
||||
if (cp != null) {
|
||||
Clan clan = cp.getClan();
|
||||
} else {
|
||||
// Player is not in a clan
|
||||
}
|
||||
else
|
||||
{
|
||||
// player is not in a clan
|
||||
}
|
||||
}
|
||||
|
||||
// get a clan from a clan tag
|
||||
|
||||
if (sc != null)
|
||||
{
|
||||
Clan clan = sc.getClanManager().getClan("staff");
|
||||
|
||||
if (clan != null)
|
||||
{
|
||||
// clan exists
|
||||
|
||||
// Get a clan from a clan tag
|
||||
Clan clan = cm.getClan("staff");
|
||||
|
||||
if (clan != null) {
|
||||
// Clan exists
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
Every player has a **ClanPlayer** object which holds all his information, including his clan, and can be used to perform various operations on the player.
|
||||
If you don't want to specify a check for the presence of SimpleClans, you can always specify a dependency in `plugin.yml`:
|
||||
|
||||
The **Clan** object holds all the information for a clan and can be used to perform various operations on the clan.
|
||||
{% tabs %}
|
||||
{% tab title="plugin.yml" %}
|
||||
```yaml
|
||||
depend:
|
||||
- SimpleClans
|
||||
```
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
The **ClanManager** holds all the **Clans** and **ClanPlayers** and contains methods that allow you to retrieve them.
|
||||
## Step 3. Continue your learning
|
||||
|
||||
Don't stop in your beginnings, feel free to learn our API: [javadocs](https://ci.roinujnosde.me/job/SimpleClans/Javadoc/).
|
||||
@@ -0,0 +1,33 @@
|
||||
---
|
||||
description: >-
|
||||
Economics on your server is probably one of the most important things to do.
|
||||
To understand how much money your clans operate, you can rely on this
|
||||
function.
|
||||
---
|
||||
|
||||
# 💸 Logging server economy
|
||||
|
||||
## Configuration
|
||||
|
||||
By default, this feature is enabled, so you may want to turn it off. You can do it here:
|
||||
|
||||
{% tabs %}
|
||||
{% tab title="config.yml" %}
|
||||
```yaml
|
||||
economy:
|
||||
bank-log:
|
||||
enable: true
|
||||
```
|
||||
{% endtab %}
|
||||
{% endtabs %}
|
||||
|
||||
## Feature description
|
||||
|
||||
This feature will create a one per day CSV file in `/SimpleClans/logs/bank/`.\
|
||||
|
||||
|
||||
.png>)
|
||||
|
||||
## For developers
|
||||
|
||||
If you want to add another format of logging, you can see how it's [implemented](https://github.com/RoinujNosde/SimpleClans/tree/master/src/main/java/net/sacredlabyrinth/phaed/simpleclans/loggers).
|
||||
@@ -0,0 +1,2 @@
|
||||
# Untitled
|
||||
|
||||
Reference in new issue
Block a user