trueog/Unions-OG
2
0 Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

GITBOOK-98: adds rename command perms and more

Browse Source
This commit is contained in:
Minat0_ authored and gitbook-bot committed 2024-04-26 09:04:44 +00:00
1 parent 274d27265f
commit 7781156d57
4 files changed
+60 -96
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

wiki/commands-and-permissions/commands.md
+1
View File
@@ -122,6 +122,7 @@ You can find land commands [here](../integration/land-claiming.md).
| `/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
wiki/commands-and-permissions/permissions.md
+2 -4
View File
@@ -1,7 +1,3 @@
---
description: null
---
# 🚦 Permissions
## SuperPerms Nodes (Some auto added)
@@ -116,6 +112,7 @@ These super permission nodes are a quick way to setup SimpleClans, some are auto
| `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
@@ -134,6 +131,7 @@ These super permission nodes are a quick way to setup SimpleClans, some are auto
| `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
wiki/how-to-setup/configuration.md
+56 -35
View File
@@ -4,37 +4,41 @@ The main configuration file for SimpleClans can be found [here.](https://github.
## General Settings
| 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` |
| `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> |
| 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
@@ -54,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
@@ -76,6 +81,9 @@ settings:
rejoin-cooldown: 60
rejoin-cooldown-enabled: false
ranking-type: DENSE
username-regex: '(\.|\*){0,1}[a-zA-Z0-9_$]{1,16}'
tag-regex: ''
date-time-pattern: 'HH:mm - dd/MM/yyyy'
```
## War and protection
@@ -285,6 +293,7 @@ kill-weights:
* `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
@@ -293,6 +302,8 @@ kill-weights:
* `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
@@ -305,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
@@ -313,6 +325,17 @@ clan:
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
@@ -413,8 +436,7 @@ request:
## Bulletin Board
* `color` - the color
* `accent-color` - the accent color&#x20;
* `prefix` – A prefix of messages in bulletin board
* `show-on-login` - if enabled, the BB is sent to clan members when they login&#x20;
* `size` - the BB size (when using its command)
* `login-size` - the BB size on login&#x20;
@@ -423,8 +445,7 @@ request:
```yaml
bb:
color: e
accent-color: '8'
prefix: "&8* &e"
show-on-login: true
size: 6
login-size: 6
wiki/other/placeholderapi-support.md
+1 -57
View File
@@ -2,63 +2,7 @@
## Available placeholders
| Placeholder | Description |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| %simpleclans\_name% | Displays the clan members name, returns name. |
| %simpleclans\_clean\_name% | Displays the clan members name in all Lowercase, returns name. |
| %simpleclans\_is\_muted% | Has the clan member Muted the clan chat ? relates to /. mute, returns yes/no. |
| %simpleclans\_is\_mutedally% | Has the clan member Muted ally chat ? relates to /ally mute, returns yes/no. |
| %simpleclans\_in\_clan% | Is the player in a clan ? returns yes/no. |
| %simpleclans\_join\_date% | Displays the date the clan member joined the clan, returns Month, Day, Year, Hour. |
| %simpleclans\_lastseen% | Displays when a clan member was last logged into server, returns Month, Day, Year, Hour, or if active returns Online. |
| %simpleclans\_lastseendays% | Displays when a clan member was last logged into server, returns number or Today if active the same day. |
| %simpleclans\_inactive\_days% | Displays how many days a clan member has not been active, returns number |
| %simpleclans\_is\_member% | Is the clan member a standard member of the clan ? returns yes/no. |
| %simpleclans\_is\_trusted% | Is the clan member a trusted member of the clan ? returns yes/no. |
| %simpleclans\_is\_leader% | <p>Is the clan member the leader of the clan ?</p><p>returns yes/no.</p> |
| %simpleclans\_rank% | Displays the clan members current Rank, returns name of the rank. |
| %simpleclans\_rank\_displayname% | Displays the clan members current Rank displayname, related to /clan rank setdisplayname, returns custom display name of the rank |
| %simpleclans\_neutral\_kills% | Total kills of players in clans that are not a ally or rival clan, returns number. |
| %simpleclans\_rival\_kills% | Total kills of players that are in a Rival clan, returns number. |
| %simpleclans\_civilian\_kills% | Total kills of players that are not in a clan, returns number. |
| %simpleclans\_ally\_kills% | Total kills of players that are in a allied clan, returns number. |
| %simpleclans\_total\_kills% | Total kills in all, civilians, rivals, allies and neutrals, returns number. |
| %simpleclans\_weighted\_kills%[#kill-weights](../how-to-setup/configuration.md#kill-weights "mention") | Displays the clan members weighted kill points, this is based off set points for each type of kill, see Config for settings, returns number. |
| %simpleclans\_deaths% | Total times the clan member has died, returns number. |
| %simpleclans\_kdr% | Kill Death Ratio, the balance between clan members Kills and Deaths, returns number. |
| %simpleclans\_is\_bb\_enabled% | Bulletin board toggle, relates to /clan toggle returns yes/no |
| %simpleclans\_is\_tag\_enabled% | Clan tag toggle, relates to /clan toggle returns yes/no. |
| %simpleclans\_is\_friendlyfire\_on% | Has the clan member got Friendly Fire Enabled, relates to /clan ff, returns yes/no. |
| %simpleclans\_tag% | Returns the clans Tag in lowercase and unformatted. |
| %simpleclans\_tag\_label% | Returns the clan Tag with correct mayus, color and at the end \&c relates to /clan modtag |
| %simpleclans\_clanchat\_player\_color%chat[#clan-chat](../how-to-setup/configuration.md#clan-chat "mention") | Gives other plugins Clan chat colors as set in config, returns \&c format |
| %simpleclans\_allychat\_player\_color%[#ally-chat](../how-to-setup/configuration.md#ally-chat "mention") | Gives other plugins Ally chat colors as set in config, returns \&c format |
| %simpleclans\_clan\_total\_neutral% | Total kills of players in clans that are not a ally or rival clan, by all clan members, returns number. |
| %simpleclans\_clan\_total\_civilian% | Total kills of players that are not in a clan, by all clan members, returns number. |
| %simpleclans\_clan\_total\_rival% | Total kills of players that are in a Rival clan, by all clan members, returns number. |
| %simpleclans\_clan\_total\_ally% | Total kills of players that are in a Allied clan, by all clan members, returns number. |
| %simpleclans\_clan\_total\_kills% | Total kills in all, civilians, rivals, allies and neutrals, by all clan members, returns number. |
| %simpleclans\_clan\_total\_deaths% | Total times all clan members have died, combined, returns number. |
| %simpleclans\_clan\_total\_kdr% | Kill Death Ratio, the balance between clan members Kills and Deaths, combined, returns number. |
| %simpleclans\_clan\_average\_wk%[#kill-weights](../how-to-setup/configuration.md#kill-weights "mention") | Displays the clan members weighted kill points, this is based off set points for each type of kill, combined, see Config for settings, returns number. |
| %simpleclans\_clan\_leader\_size% | Displays how many leaders the clan has, returns number. |
| %simpleclans\_clan\_balance% | Displays the current balance of the clan using the economy system, returns number. |
| %simpleclans\_clan\_allow\_withdraw%[#available-permissions-for-ranks](../commands-and-permissions/ranks-with-permissions.md#available-permissions-for-ranks "mention") | Can clan members withdraw currency from the clan bank, related to ranks, returns yes/no. |
| %simpleclans\_clan\_allow\_deposit%[#available-permissions-for-ranks](../commands-and-permissions/ranks-with-permissions.md#available-permissions-for-ranks "mention") | Can clan members deposit currency from the clan bank, related to ranks, returns yes/no. |
| %simpleclans\_clan\_size% | Displays the amount of current clan members in the clan, returns number. |
| %simpleclans\_clan\_name% | Displays the clan name, returns name. |
| %simpleclans\_clan\_color\_tag% | Returns the clan Tag with correct mayus, color and at the end \&c relates to /clan modtag |
| %simpleclans\_clan\_tag% | Returns the clans Tag in lowercase and unformatted. |
| %simpleclans\_clan\_founded% | Displays the date the clan was created, returns Month, Day, Year, Hour. |
| %simpleclans\_clan\_friendly\_fire% | Has the clan member got Friendly Fire Enabled, relates to /clan globalff, returns yes/no. |
| %simpleclans\_clan\_is\_unrivable%[#general-settings](../how-to-setup/configuration.md#general-settings "mention") | Displays if the clan can be rivalled, related to unrivable-clans in config, returns yes/no. |
| %simpleclans\_clan\_is\_anyonline% | Displays if any members of the clan are online, returns yes/no. |
| %simpleclans\_clan\_is\_verified%[#what-is-it](../commands-and-permissions/verified-clan.md#what-is-it "mention") | Displays if the clan has Verified Status, returns yes/no. |
| %simpleclans\_clan\_inactivedays% | Displays how many days no clan members have been active, returns number. |
| %simpleclans\_clan\_onlinemembers\_count% | Displays how many clan members are currently online, returns number. |
| %simpleclans\_clan\_allies\_count% | Displays how many other clans the clan is allied with, returns number. |
| %simpleclans\_clan\_rivals\_count% | Displays how many other clans the clan is rivalled with, returns number. |
| %simpleclans\_clan\_is\_permanent%[#what-is-it](../commands-and-permissions/permanent-clan.md#what-is-it "mention") | Displays if the clan is permanent and protected from auto delete, returns yes/no. |
<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 &#x26;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 &#x26;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 &#x26;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