rename the tool

Author: muzaffarmhd

README.md

@@ -1,25 +1,20 @@
-# Zuffer CLI
+# cordctl
 
 **A CLI utility to automate and simplify Discord server management tasks.**
 
 ---
 
-Zuffer is currently under active development. While many core features are functional, it's not yet complete. Expect rough edges, potential bugs, and changes as development progresses.
+cordctl is currently under active development. While many core features are functional, it's not yet complete. Expect rough edges, potential bugs, and changes as development progresses.
 
-**Upcoming Features:**
-*   More robust error handling and user feedback.
-*   Expansion of automated tests.
-
----
 
 ## Prerequisites
 
-Before installing Zuffer CLI, please ensure you have the following system dependencies:
+Before installing cordctl CLI, please ensure you have the following system dependencies:
 
 *   **Python:** Version 3.8 or higher.
 *   **pip:** Python package installer (usually comes with Python).
 *   **FFmpeg (for music features):**
-    *   Zuffer's music bot functionality requires FFmpeg to be installed and accessible in your system's PATH.
+    *   cordctl's music bot functionality requires FFmpeg to be installed and accessible in your system's PATH.
     *   **Linux (Debian/Ubuntu):** `sudo apt update && sudo apt install ffmpeg`
     *   **Linux (Fedora):** `sudo dnf install ffmpeg`
     *   **macOS (Homebrew):** `brew install ffmpeg`
@@ -49,29 +44,27 @@ Before installing Zuffer CLI, please ensure you have the following system depend
 
 ## About
 
-Zuffer helps Discord server administrators and moderators streamline common tasks through a command-line interface and interactive GUIs.
+cordctl helps Discord server administrators and moderators streamline common tasks through a command-line interface and interactive GUIs.
 
 ---
 
 ## Features
 
-*   **Secure Credential Management:** Stores Discord Bot Token and Client ID using your system's native keyring.
 *   **Bulk Channel Creation:**
     *   Create multiple public text or voice channels with sequential naming.
-    *   Create private channels automatically linked to new roles, with options to grant access to existing roles.
-*   **Interactive Embed Builder GUI:** Visually construct and send rich embed messages. Supports exporting/importing designs as JSON.
+    *   Create private channels with linked roles and configurable access permissions.
+*   **Embed Builder GUI:** construct embed messages with export/import functionality.
 *   **Customizable Welcomer Bot & GUI:**
-    *   Design unique welcome images with an intuitive GUI: custom dimensions, backgrounds (color/image), draggable avatar, and multiple draggable text elements with placeholders and font customization.
-    *   Run a bot to automatically send personalized welcome images.
-    *   Test setup by simulating a member join.
-    *   Save/load configurations as JSON.
+    *   Design welcome images through tkinter GUI with backgrounds, avatar and text elements.
+    *   Run bot for automatic personalized welcome images.
+    *   Test with join simulation.
+    *   Save/load JSON configurations.
 *   **Role Management Bot:**
-    *   Allows users to claim/unclaim roles via slash commands (`/claim`, `/unclaim`).
-    *   Option to enforce unique roles per user (one non-`@everyone` role at a time).
+    *   User-facing slash commands for role management (`/claim`, `/unclaim`).
+    *   Optional unique role assignment.
 *   **Basic Music Bot:**
-    *   Play `.mp3` files from a local directory on loop in a voice channel.
-*   **Guild Information:** List Discord guilds your bot is a member of.
-*   **Cached Data:** Caches guild information locally for faster operations.
+    *   Loop local MP3 files in voice channels.
+*   **Guild Information:** List Discord guilds your bot can access.
 
 ---
 
@@ -81,8 +74,8 @@ Zuffer helps Discord server administrators and moderators streamline common task
 
 2.  **Clone the repository:**
     ```bash
-    git clone https://github.com/muzaffarmhd/zuffer-cli.git
-    cd zuffer-cli
+    git clone https://github.com/muzaffarmhd/cordctl.git
+    cd cordctl
     ```
 
 3.  **Set up a Virtual Environment (Recommended):**
@@ -103,28 +96,28 @@ Zuffer helps Discord server administrators and moderators streamline common task
 ## Getting Started
 
 1.  **Login:**
-    Configure Zuffer with your Discord bot's credentials:
+    Configure cordctl with your Discord bot's credentials:
     ```bash
-    zuffer login
+    cordctl login
     ```
     You'll be prompted for your Bot Token and Client ID.
 
 2.  **Refresh Guild Cache:**
     After login, or if your bot's server membership changes, refresh the local guild cache:
     ```bash
-    zuffer refresh
+    cordctl refresh
     ```
 
 3.  **Explore Commands:**
     See all commands:
     ```bash
-    zuffer --help
+    cordctl --help
     ```
     Help for a specific command:
     ```bash
-    zuffer <command> --help
+    cordctl <command> --help
     # Example
-    zuffer welcome run --help
+    cordctl welcome run --help
     ```
 
 ---
@@ -133,51 +126,51 @@ Zuffer helps Discord server administrators and moderators streamline common task
 
 ### Core
 
-*   **`zuffer login`**
+*   **`cordctl login`**
     *   Description: Securely stores your Discord Bot Token and Client ID.
-*   **`zuffer reset`**
+*   **`cordctl reset`**
     *   Description: Removes stored Discord Bot Token and Client ID.
-*   **`zuffer refresh`**
+*   **`cordctl refresh`**
     *   Description: Updates the local cache of guilds your bot is in.
-*   **`zuffer list`**
-    *   Description: Lists guilds the authenticated bot is a member of. (Requires `zuffer refresh` first).
+*   **`cordctl list`**
+    *   Description: Lists guilds the authenticated bot is a member of. (Requires `cordctl refresh` first).
 
 ### Channel Management
 
-*   **`zuffer create-channels`**
+*   **`cordctl create-channels`**
     *   Description: Creates multiple public text or voice channels.
     *   Options: `-t, --type [voice|text]`, `--name TEXT`, `--start INTEGER`, `--end INTEGER`.
-    *   Usage: `zuffer create-channels -t voice --name game-room --start 1 --end 5`
+    *   Usage: `cordctl create-channels -t voice --name game-room --start 1 --end 5`
 
-*   **`zuffer create-private`**
+*   **`cordctl create-private`**
     *   Description: Creates private text/voice channels with corresponding roles.
     *   Options: `-t, --type [voice|text]`, `--name TEXT`, `--start INTEGER`, `--end INTEGER`, `--exclude TEXT` (comma-separated existing role names for access).
-    *   Usage: `zuffer create-private -t text --name project-zeta --start 1 --end 3 --exclude "Coordinator"`
+    *   Usage: `cordctl create-private -t text --name project-zeta --start 1 --end 3 --exclude "Coordinator"`
 
 ### Embed Messages
 
-*   **`zuffer embed`**
+*   **`cordctl embed`**
     *   Description: Opens a GUI to build and send a Discord embed message. Prompts for Channel ID.
     *   **GUI Features:** Content, title, URL, description, color, author, image, thumbnail, footer, fields, timestamp. Supports JSON export/import.
 
 ### Welcomer Bot
 
-*   **`zuffer welcome config`**
+*   **`cordctl welcome config`**
     *   Description: Opens a GUI to design the welcome image.
     *   **GUI Features:** Canvas preview, dimensions, background (color/image), avatar (visibility, size, position), multiple draggable text elements (content with `{username}`, font, size, color). Supports JSON save/load.
         *   **Custom Backgrounds:** Copied to `assets/` relative to the saved config JSON.
         *   **Custom Fonts:** Place `.ttf` files in `assets/fonts/` relative to the saved config JSON.
 
-*   **`zuffer welcome run`**
+*   **`cordctl welcome run`**
     *   Description: Runs the Welcomer Bot to greet new members.
     *   Options:
         *   `-c, --config FILEPATH`: (Required) Path to the welcome image configuration JSON.
         *   `--simulate-join / --no-simulate-join`: (Optional) Simulate a member join for testing.
-    *   Usage: `zuffer welcome run -c /path/to/config.json --simulate-join`
+    *   Usage: `cordctl welcome run -c /path/to/config.json --simulate-join`
 
 ### Role Management
 
-*   **`zuffer handle-roles`**
+*   **`cordctl handle-roles`**
     *   Description: Runs a bot that allows users to claim/unclaim roles using slash commands.
     *   Options:
         *   `--private`: If set, a user can only have one role (other than `@everyone`) managed by this system at a time.
@@ -187,7 +180,7 @@ Zuffer helps Discord server administrators and moderators streamline common task
 
 ### Music Bot
 
-*   **`zuffer play-music <playlist_directory>`**
+*   **`cordctl play-music <playlist_directory>`**
     *   Description: Runs a basic music bot that joins the voice channel of the user who types `!join` and plays `.mp3` files from the specified `<playlist_directory>` on loop.
     *   **Bot Commands (in Discord chat):**
         *   `!join`: Bot joins your current voice channel and starts playing music.

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=61.0.0"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "zuffer"
+name = "cordctl"
 version = "0.0.2"
 authors = [
   { name="Md Muzaffar", email="[email protected]" },
@@ -30,4 +30,4 @@ dependencies = [
 ]
 
 [project.scripts]
-zuffer = "zuffer.cli:main"
+cordctl = "cordctl.cli:main"

src/zuffer/__init__.py renamed to src/cordctl/__init__.py

@@ -5,10 +5,10 @@
 from .commands import welcome, list, play_music, handle_roles
 
 @click.group(invoke_without_command=True)
-@click.version_option(package_name="zuffer")
+@click.version_option(package_name="cordctl")
 @click.pass_context
 def main(ctx: click.Context):
-    """Zuffer CLI - Discord Server Management Tool"""
+    """cordctl CLI - Discord Server Management Tool"""
     if ctx.invoked_subcommand is None:
         click.echo(ctx.get_help())
         ctx.exit(0)

src/zuffer/cli.py renamed to src/cordctl/cli.py

@@ -6,7 +6,7 @@
 import json
 import datetime
 from ..core import auth, discord_api
-from zuffer.gui.embed_gui import EmbedBuilder
+from cordctl.gui.embed_gui import EmbedBuilder
 
 def build_embed_gui(callback):
     app = EmbedBuilder(callback)

src/zuffer/commands/__init__.py renamed to src/cordctl/commands/__init__.py

@@ -12,4 +12,4 @@ def list_command():
             for guild, id in guilds:
                 print(f"{guild}")
     else:
-        click.echo("Please run command:`zuffer refresh` to refresh the bot!")
+        click.echo("Please run command:`cordctl refresh` to refresh the bot!")

src/zuffer/commands/create_channels.py renamed to src/cordctl/commands/create_channels.py

@@ -26,7 +26,7 @@ def reset():
             click.echo("You are not logged in. Nothing to reset!")
             return
         if auth.delete():
-            click.echo("Token has been successfully reset. You can now use `zuffer login` again!")
+            click.echo("Token has been successfully reset. You can now use `cordctl login` again!")
         else:
             click.echo("An error occured!")
     else: