About Clan Homes
Clan Homes allows your players to set one or more clan homes for their clan! This plugin was designed for configurability, with this permission and config system you and your players can control every aspect.
Note: this plugin requires a Clan plugin to function.
★ Optional Multi-Home System - Allow players to set a single clan home or multiple
★ Cooldown System - Fully configurable cooldowns based on permissions you create in the config
★ Teleport Configuration System - Configure what is and isn't allowed when teleporting to the clan home(s)
★ Easy Cancel System - Easily cancel your teleport home by typing /ch c or /tpc (works with NTeleportation)
★ Notify System - Notify your clan mates where the new clan base is (if enabled by clan leader)
★ and more! (Rest of features below)
Commands/clanhome <name of home> || Teleports to clan home. /clanhome <cancel/stop/c> || Cancels your clan home teleport. /clanhome <set/delete> <name of home> || Sets/deletes clan home. /clanhome options <owner/council/mod/all> || Changes who can set a clan home. /clanhome notify <on/off/grid> || Changes notification settings. /clanhome help || Shows this help message. <!-- Note: These commands below are for when "Only allow 1 clan home total for all people regardless of permissions." is enabled in config. --> /clanhome <set/delete> || Sets/deletes clan home. /clanhome || Teleports to clan home. <!-- | Command Explanation | --> /clanhome options <owner/council/mod/all> # owner: Only clan owner can set a clan home. # council: Council and higher can set a clan home. # mod: Moderators and higher can set a clan home. # all: Anyone within the clan can set a clan home. <!-- | Command Explanation | --> /clanhome notify <on/off/grid> # on: Notifies clan of clan home. # off: Notifies no one. # grid: Notifies clan of clan home with grid.
★ Custom Permission System - Allow your clan leaders to choose what roles in the clan can set the clan home(s)
★ Blacklist System - Prevent setting clan homes on a configurable list prefabs
★ Home Limit System - Limit the number clan homes, number of times a clan home can be teleported to, and or the number of home teleports each permission has
★ Clan Member Threshold - Prevent the ability to set clan home if the clan does not meet the configurable number of members required
Config{ "Steam ID for messages to be sent from (aka profile picture, 0 for default Rust Icon)": 76561199682073328, "Hex Color for Syntax/Warned By in Lang": "#ff3d3d", "Hex Color for commands in the Syntax in Lang": "orange", "Hex Color for the user's name when copying.": "#FFA500", "Only allow 1 clan home total for all people regardless of permissions.": true, "The name of the homes by default when using the single home system (only matters if you swap from single to multiple after homes have been created)": "default", "Clear the home and cooldown data on server wipe": true, "How many times a clan home can be teleported to by any clan member (will destroy home after the number of teleports you specify here)": -1, "How many clan members are required for a clan to set a clan home (-1 is no requirement)": -1, "Command Aliases for /clanhome.": [ "homeclan", "ch", "hc" ], "Default cooldown info for home teleports.": { "How long it takes before the player can teleport home again.": 180.0, "How long it takes to teleport to the home.": 25.0, "How many homes this permission can set.": 1, "How many times this permission can teleport to a clan home.": -1 }, "Cooldowns for each permission": { "clanhome.vip": { "How long it takes before the player can teleport home again.": 90.0, "How long it takes to teleport to the home.": 12.5, "How many homes this permission can set.": 2, "How many times this permission can teleport to a clan home.": -1 } }, "Blacklisted Home Save Entity Prefab Names": [ "assets/prefabs/building core/stairs.l/block.stair.lshape.prefab", "assets/prefabs/building core/stairs.spiral/block.stair.spiral.prefab", "assets/prefabs/building core/stairs.spiral.triangle/block.stair.spiral.triangle.prefab", "assets/prefabs/building core/stairs.u/block.stair.ushape.prefab", "assets/prefabs/building core/wall/wall.prefab", "assets/prefabs/building core/wall.doorway/wall.doorway.prefab", "assets/prefabs/building core/wall.frame/wall.frame.prefab", "assets/prefabs/building core/wall.half/wall.half.prefab", "assets/prefabs/building core/wall.low/wall.low.prefab", "assets/prefabs/building core/wall.window/wall.window.prefab", "assets/prefabs/building core/foundation.steps/foundation.steps.prefab" ], "Preferences for teleport options": { "Allow teleporting while building blocked.": false, "Allow teleporting into a building blocked clan home (this means if their home is building blocked they'd be able to tp to it).": false, "Allow teleporting while WITHIN a Safe Zone.": true, "Allow teleporting while OUTSIDE a Safe Zone.": true, "Allow crafting while teleporting to clan home.": true, "Allow teleporting while swimming.": true, "Allow teleporting while mounted.": false, "Allow teleporting while on Cargo.": false, "Allow teleporting while in a Hot Air Balloon (HAB).": false, "Allow teleporting while in the back of a scrap heli.": false, "Allow teleporting while taking damage.": true, "Allow teleporting while wounded/incapacitated.": false }, "Version": { "Major": 1, "Minor": 0, "Patch": 5 } }
Q: Does this work with X clan plugin?
A: Most likely yes. If your plugin is compatible with K1llY0u's clan plugin, it will be compatible with this plugin. If its not listed in the "Works With " section, feel free to ask in the Discussions section.
For support, please make a support ticket and include any pertinent info (like how to recreate/what you were doing at the time) and any errors that occur.
