k1lly0u
Universal clans with alliance support

Supported Games

Clans plugin for all Oxide supported games.

Better Chat is required to display clan tags in chat! (clan tags will be unavailable until Better Chat has been updated to support it)

Note: If you are using Rust I recommend using RustIO:Clans as it has features that can not be achieved in a universal plugin such as clan tags directly in players names, Rust:IO friends functionality, and Rust:IO FriendlyFire

Chat Commands

  • /c <message> - Send a message to all clan members
  • /a <message> - Send a message to all clan members and allied clans
  • /clanhelp - Displays help
  • /clanhelp member - Displays commands for clan members
  • /clanhelp moderator - Displays commands for clan moderators
  • /clanhelp owner - Displays commands for clan owners

Clan Member Commands

  • /clan create <tag> - Create a new clan
  • /clan join <tag> - Join a clan if you have a invite
  • /clan leave- Leave you current clan
  • Clan Moderator Commands
  • /clan invite <partialname> - Invite a player to join your clan
  • /clan invite cancel <partialname/ID> - Cancel a pending invite
  • /clan kick <partialname/ID> - Kick a player from your clan
  • Clan Owner Commands
  • /clan promote <partialname/ID> - Promote a clan member to clan moderator
  • /clan demote <partialname/ID> - Demote a clan moderator to clan member
  • /clan disband - Disband your clan
  • /clan ally request <tag> - Request an alliance with another clan
  • /clan ally accept <tag> - Accept an alliance invite
  • /clan ally decline <tag> - Decline a alliance request
  • /clan ally cancel <tag> - End a clan alliance

Configuration

{
  "Limitations": {
    "Maximum clan alliance count": 2,
    "Maximum clan member count": 8,
    "Maximum clan moderator count": 2
  },
  "Message colors": {
    "Clan and Alliance chat color": "#3999D5",
    "Clan tag color": "#783CD7",
    "Highlight color": "#D85540",
    "Message color": "#D8D8D8"
  },
  "Settings": {
    "Data save timer (seconds)": 600,
    "Maximum clan tag characters": 6,
    "Minimum clan tag characters": 2,
    "Show clan member connection message": true,
    "Show clan member disconnection message": true
  }
}

For Developers

API

string GetClanOf(string playerID | ulong playerID | IPlayer ) // Returns a string clan tag of the specified player. Returns null if the player or clan is not found

bool IsClanMember(string playerId, string otherId) // Check if 2 players are clan mates

bool IsMemberOrAlly(string playerId, string otherId) // Check if 2 players are clan mates or clan allies

bool IsAllyPlayer(string playerId, string otherId) // Check if 2 players are in allied clans

JArray GetAllClans() // Returns a array of all clan tags

JObject GetClan(string tag) // Returns a JObject containing all of the specified clans information

//Available properties:
// "tag" - (string) clan tag
// "owner" - (string) clan owner id
// "moderators" - (JArray) moderator user id's
// "members" - (JArray) member user id's
// "invited" - (JArray) invited player user id's
// "allies" - (JArray) ally clan tags
// "invitedallies" - (JArray) invited ally clan tags

Hooks

These hooks are for the purpose of updating information within external plugins. They have no return behaviour.

OnClanCreate(string tag) // Is called when a clan is created
OnClanUpdate(string tag) // Is called when a clan is updated (player join/leave, invite cancelled, new alliance, cancelled alliance, accepted alliance, etc)
OnClanDestroy(string tag) // Is called when a clan is disbanded
OnClanChat(IPlayer player, string message) // Called when a player uses clan chat

MIT License


Copyright (c) 2019 k1lly0u


Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:


The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.


THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.