Skip to content

SeesAll/ClanRenameLogs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 

Repository files navigation

Clan Rename Logs

Clan Rename Logs is a Rust plugin designed for servers running Clans Reborn. https://chaoscode.io/resources/clans-reborn.14/

It allows authorized staff to rename clans directly from in-game chat while automatically logging the action for accountability and auditing purposes.


🔧 What This Plugin Does

  • Allows staff to rename clans using a single in-game command
  • Verifies the rename using Clans Reborn API
  • Logs every successful rename to a data file
  • Optionally sends a Discord webhook embed
  • Automatically clears logs on map wipe (configurable)
  • Fully permission-based (not tied to Rust auth levels)

📦 Requirements

  • Rust Dedicated Server
  • uMod / Oxide
  • Clans Reborn plugin (Required)

This plugin depends on Clans Reborn and will not function without it.


🛠 Installation

  1. Upload ClanRenameLogs.cs to:

    oxide/plugins/
    
  2. Reload the plugin:

    oxide.reload ClanRenameLogs
    
  3. Grant permission:

    oxide.grant group admin clanrenamelogs.use
    oxide.grant group moderator clanrenamelogs.use
    

💬 Commands

Chat Command

/renameclan OLD_TAG NEW_TAG Reason for rename

Example:

/renameclan BAD GOOD Offensive name cleaned up

This will:

  • Rename the clan via Clans Reborn
  • Verify the rename was successful
  • Log the action
  • Send a Discord notification (if enabled)

🔐 Permissions


Permission Description


clanrenamelogs.use Allows player to rename clans and log the action


This plugin does NOT require users to be in users.cfg.
Access is controlled entirely via Oxide permissions.


📁 Data File

Logs are stored in:

oxide/data/ClanRenameLogs.json

Example entry:

{
  "TimeUtc": "2026-02-19T22:15:30Z",
  "ExecutorName": "AdminName",
  "ExecutorId": "7656119XXXXXXXXXXX",
  "OldTag": "BAD",
  "NewTag": "GOOD",
  "Reason": "Offensive name cleaned up"
}

⚙ Configuration

Config file location:

oxide/config/ClanRenameLogs.json

Default configuration:

{
  "WipeLogsOnServerWipe": true,
  "Discord": {
    "Enabled": false,
    "WebhookUrl": "",
    "Username": "ClanRenameLogs",
    "AvatarUrl": "",
    "MentionHere": false,
    "MentionRoleId": ""
  }
}

Configuration Options

WipeLogsOnServerWipe (bool)

  • If true, logs are cleared automatically when a new save (wipe) is detected.
  • If false, logs persist across wipes.

Discord Settings

Setting Description


Enabled Enables Discord webhook notifications WebhookUrl Discord webhook URL Username Display name of webhook sender AvatarUrl Custom avatar for webhook MentionHere If true, adds @here mention MentionRoleId Role ID to mention instead of @here


📢 Discord Embed Example

When enabled, each rename sends an embed containing:

  • Old tag → New tag
  • Executor name + SteamID
  • Reason
  • Timestamp (UTC)

🔄 How Verification Works

The plugin:

  1. Confirms the old clan exists

  2. Executes:

    clans rename OLD NEW
    
  3. Verifies:

    • Old tag no longer exists
    • New tag now exists

If verification fails, the rename is not logged.


🧠 Performance & Design

  • No reflection
  • No heavy hooks
  • Lightweight API calls only when command is used
  • No constant polling
  • Per-wipe optional log reset
  • Fully uMod compliant

🧾 Version

Current Version: 1.0.1


📜 License

Attach your preferred open-source license when creating the GitHub repository (MIT recommended).

About

Rust plugin that allows authorized staff to rename clans via Clans Reborn with automatic logging and optional Discord notifications.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages