Clans REBORN 2.12.8

Optional Dependencies:

http://www.chaoscode.io/resources/entity-radar.26/
http://www.chaoscode.io/resources/clans-ui.41/

Feature overview:

• It provides native NTeleportation support for setting homes and teleport requests
• Players can be invited being alive (online, sleeping) and dead (not alive)
• Invited players being not in game get their clan invitation displayed 3 secs after login
• It supports an optional alliance function for clan interaction
• Clans have a clan internal friendly-fire protection
• Friendly fire protection can be optionally extended on allied clan members
• Clan/Ally chats will display the name of the speaker with their colored clan status
• Clan broadcasts show any action like invite or demote with the actors clan status color
• The clan overview shows now also Offline member names
• The clan TAG min- and max-length can now be defined by config
• Clan creation can check TAG’s against a blocked wordlist
• Clan tagging can be optionally disabled
• It can create/manage automatic Oxide clan groups including their members
• Old (not updated since x days ) clans can be automatically purged
• Authorized players can rename existing clans
• All authorized players of authLevel 1 and 2 can direct broadcast into a clan channel
• All default chat commands are changeable.
• All plugins colors can be formatted
• All texts are available by language-file
• The plugin has full support for the default saved Clans data format
• RustIO dependency was removed

Clans overview example:


Clans ally commands example:


Clans help view example:


INSTALL Notes:

• Delete your OLD /config/Clans.json in config folder (if exist)
• run server.save and make a copy of /data/rustio_clans.json (if exist)
• Install the plugin over the old (if exist)
• The clans data file is full compatible with public version of ClansIO (not the universal version)
• The clans-data will be saved into /config/Clans.json
  Once this was done once, you could delete the old clans(io)-file.

Default chatcommands (all adjustable by config):

• /a
  Writes into the ally chat
• /clan
• Shows the clan overview
  /clan help | /clanhelp > shows the help
  /clan ally | /clanally > shows the ally options (owner or council)
• /c
  Writes into the clan chat
• /cinfo
  Shows info about other clans
• /cff
  Toggles the players friendlyfire status

Config part to adjust these commands:

Code (Text):

  "Commands": {
    "chatCommandAllyChat": "a",
    "chatCommandClan": "clan",
    "chatCommandClanChat": "c",
    "chatCommandClanInfo": "cinfo",
    "chatCommandFF": "cff"
  },

Console commands (access depends on authLevel):
(all also working client-side)

• clans.list
  Lists all clans, their owners and their membercount
• clans.listex
  Lists all clans, their owners/members and their onlinestatus
• clans.show
  Lists the choosen clan and the members with status
  Provide the clan tag
• clans.msg
  Sends a clan message
  Provide the clan tag and then write any sentence
• clans.rename
  Rename a clan
  Provide the old and the new clan tag
• clans.delete
  Disband a clan
  Provide the clan tag
• clans.playerinvite
  Send a clan invitation to a player
  Provide clan tag and player name
• clans.playerkick
  Kick a player from a clan
  Provide clan tag and player name
• clans.cmds
  List all console commands (client and server)
• clans
  Console command overview (client only)

Some of their access depend on this config part:

Code (Text):

  "Permission": {
    "authLevelDelete": 2,
    "authLevelInvite": 1,
    "authLevelKick": 2,
    "authLevelRename": 1,
  },

Plugin function descriptions (player benefits):

All member actions work based on the servers covalence user data (oxide.users.data)

• It checks first against All Onlineplayers
• It checks on second search against All known players
• (based on oxide’s covalence player-database)
• For cases of multiple players with same names it can search for specific steam Id’s

Invited players being Offline get their clan invitation displayed 3 secs after login

• It can in conclusion invite, withdraw, promote, demote and kick All players, which ever logged into server
• All names will be called from oxide’s covalence player database (oxide.users.data)

Clans have an inbuilt FriendlyFire protection

• This is now real based on clan-memberships
• The ClanFF is enabled by default and can be disabled by config
• This can also be extended onto allied clans by global option

The clan command overview is now displayed on base on the players active membership and their role inside of their clan

1. No Clan
2. Clan member
3. Clan moderator
4. Clan owner
5. Server Management

Clan chats will display the name of the speaker with their access-level color

1. Member
2. Moderator
3. Council
4. Owner

Clan Broadcasts show any action like invite or demote with the actors access-level color

Plugin management benefits:

Clan creation can check TAG’s against a blocked wordlist

• This function is enabled by default
• The wordlist can be extended in the main config
• Clan renames by server/admin/mod do not check this filter
• Old Clans can be automatically purged

Automated clan disbanding (purging) is disabled by default
It can purge “not updated” clans older then x days
Every clan will have two times for this to make work

• Time clan was created
• Time clan was last updated
• As update actions it counts the following:

1. Login
2. Join
3. Promote
4. Demote
5. Leave
6. Kick

All available config options (with defaults):

BetterChat

• clanTagColorBetterChat: #aaff55
  The color how BetterChat displays clan tags
• clanTagSizeBetterChat: 15
  The size how BetterChat displays clan tags

Commands

• chatCommandAllyChat: a
  Ally broadcast command
• chatCommandClan: clan
• Clan commands
• chatCommandClanChat: c
  Clan broadcast command
• chatCommandClanInfo: cinfo
  Clan-info command
• chatCommandFF: cff
  Toggle player friendlyfire command

Formatting

• broadcastMessageColor: #e0e0e0
  Textcolor for broadcasts
• broadcastPrefix: (CLAN)
  Prefix for clan broadcasts
• broadcastPrefixAlly: (ALLY)
  Prefix for ally broadcasts
• broadcastPrefixColor: #a1ff46
  Broadcast prefix color
• broadcastPrefixFormat: <color={0}>{1}</color>
  Broadcast prefix format
• clanCouncilColor: #b573ff
  Color for councils
• clanMemberColor: #fcf5cb
  Color for members
• clanModeratorColor: #74c6ff
  Color for moderators
• clanOwnerColor: #a1ff46
  Color for owners
• clanServerColor: #ff3333
  Color for Server/Console
• colorClanFFOff: lime
  FF disabled color
• colorClanFFOn: red
  FF enabled color
• colorClanNamesOverview: #b2eece
  Color for clan names in overview
• colorCmdUsage: #ffd479
• Command example colors
• colorTextMsg: #e0e0e0
  Color text messages by plugin
• consoleName: ServerOwner
  Name for server/console messages
• pluginPrefix: CLANS
  Plugin prefix
• pluginPrefixColor: orange
  Plugin prefix color
• pluginPrefixFormat: <color={0}>{1}</color>:
  Plugin prefix format
• pluginPrefixREBORNColor: #ce422b
  Plugin prefix for name extension

Limits

• allowedSpecialChars: !²³
  Allowed extra chars for clan tags
• friendlyFireNotifyTimeout: 5
  Timeout for FF notifications
• inviteValidDays: 1
  Delete claninvites after x days
• limitAlliances: 2
  Ally limit per clan
• limitMembers: 8
  Member limit per clan
• limitModerators: 2
  Moderator limit per clan
• tagLengthMax: 6
  Maximum tag length
• tagLengthMin: 2
  Maximum tag length

NTeleportation

• setHomeMember: true
  Members can set homes on clan foundations
• setHomeModerator: true
  Moderators can set homes on clan foundations
• setHomeOwner: true
  Owners can set homes on clan foundations

Permission

• authLevelClanInfo: 0
  Accesslevel for claninfo
• authLevelDelete: 2
  Accesslevel for console clan disband
• authLevelInvite: 1
  Accesslevel for console clan invite
• authLevelKick: 2
  Accesslevel for console clan kick
• authLevelRename: 1
  Accesslevel for console clan rename
• permGroupPrefix: clan_
  Groupprefix for created oxide groups
• usePermGroups: false
• To use the oxide group creation feature

Purge

• listPurgedClans: false
  To display purged clans to console
• notUpdatedSinceDays: 14
  Inactivity time in days
• purgeOldClans: false
  Automatic removal on inactive clans

RustIO

• addClanMembersAsIOFriends: true
  To add clan members to each others IO-Friendlist
• enableRustIOSupport: false
  To enable RustIO-support

Settings

• enableAllyFFOPtion: true
  Extend friendlyfire protection to allied members
• enableClanAllies: false
  Enable ally functions
• enableClanTagging: true
• Enable clan tagging for displaynames
• enableFFOPtion: true
  Enable friendlyfire functions
• enableWordFilter: true
  Enable clan creation wordfilter
• forceAllyFFNoDeactivate: true
  Friendlyfire cannot be disabled for allied members

Default plugin config example:

Code (Text):

{
  "BetterChat": {
    "clanTagColorBetterChat": "#aaff55",
    "clanTagSizeBetterChat": 15
  },
  "Commands": {
    "chatCommandAllyChat": "a",
    "chatCommandClan": "clan",
    "chatCommandClanChat": "c",
    "chatCommandClanInfo": "cinfo",
    "chatCommandFF": "cff"
  },
  "Formatting": {
    "broadcastMessageColor": "#e0e0e0",
    "broadcastPrefix": "(CLAN)",
    "broadcastPrefixAlly": "(ALLY)",
    "broadcastPrefixColor": "#a1ff46",
    "broadcastPrefixFormat": "<color={0}>{1}</color> ",
    "clanCouncilColor": "#b573ff",
    "clanMemberColor": "#fcf5cb",
    "clanModeratorColor": "#74c6ff",
    "clanOwnerColor": "#a1ff46",
    "clanServerColor": "#ff3333",
    "colorClanFFOff": "lime",
    "colorClanFFOn": "red",
    "colorClanNamesOverview": "#b2eece",
    "colorCmdUsage": "#ffd479",
    "colorTextMsg": "#e0e0e0",
    "consoleLogColorAlly": "Green",
    "consoleLogColorClan": "Green",
    "consoleName": "ServerOwner",
    "pluginPrefix": "CLANS",
    "pluginPrefixColor": "orange",
    "pluginPrefixFormat": "<color={0}>{1}</color>: ",
    "pluginPrefixREBORNColor": "#ce422b"
  },
  "Limits": {
    "allowedSpecialChars": "!²³",
    "friendlyFireNotifyTimeout": 5,
    "inviteValidDays": 1,
    "limitAlliances": 2,
    "limitMembers": 8,
    "limitModerators": 2,
    "tagLengthMax": 6,
    "tagLengthMin": 2
  },
  "NTeleportation": {
    "setHomeMember": true,
    "setHomeModerator": true,
    "setHomeOwner": true
  },
  "Permission": {
    "authLevelClanInfo": 0,
    "authLevelDelete": 2,
    "authLevelInvite": 1,
    "authLevelKick": 2,
    "authLevelRename": 1,
    "permGroupPrefix": "clan_",
    "usePermGroups": false
  },
  "Purge": {
    "listPurgedClans": false,
    "notUpdatedSinceDays": 14,
    "purgeOldClans": false
  },
  "RustIO": {
    "addClanMembersAsIOFriends": true,
    "enableRustIOSupport": false
  },
  "Settings": {
    "enableAllyFFOPtion": true,
    "enableClanAllies": false,
    "enableClanTagging": true,
    "enableFFOPtion": true,
    "enableWordFilter": true,
    "forceAllyFFNoDeactivate": true
  },
  "WordFilter": {
    "Words": [
      "admin",
      "mod",
      "owner"
    ]
  }
}

...