diff --git a/.gitignore b/.gitignore
index bc254ac..e5f2d91 100644
--- a/.gitignore
+++ b/.gitignore
@@ -49,6 +49,7 @@ build/
# Ignore node_modules
node_modules/
+package-lock.json
# Ignore Next.js build output
.next/
diff --git a/README.md b/README.md
index e60cd06..50f8622 100644
--- a/README.md
+++ b/README.md
@@ -9,14 +9,20 @@
╚══════╝ ╚═╝ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═╝
```
-**A feature-rich Discord bot paired with a sleek Next.js dashboard**
-
-[](https://python.org)
-[](https://nextjs.org)
-[](https://fastapi.tiangolo.com)
-[](https://discordpy.readthedocs.io)
-[](LICENSE)
-[](https://discord.gg/codexdev)
+A feature-rich Discord bot paired with a sleek Next.js dashboard
+ 
+
+ 
+ 
+ 
+ 
+
+
+ 
+ 
+ 
+ 
+
@@ -28,18 +34,21 @@ ZyroX is a fully-featured Discord bot with a modern web dashboard for managing e
```
ZyroX-CV2-With-Dashboard/
-├── 🤖 bot/ Python Discord bot + FastAPI backend
-│ ├── api/ Dashboard REST API (FastAPI)
-│ ├── cogs/ All bot features (commands, events, antinuke, automod…)
-│ ├── utils/ Shared utilities (emoji, tools, sync…)
-│ ├── assets/ Fonts, backgrounds, GIFs
-│ └── CodeX.py Entry point
+├── 🤖 bot/ Python Discord bot + FastAPI backend
+│ ├── api/ Dashboard REST API (FastAPI)
+│ ├── cogs/ All bot features (commands, events, antinuke, automod…)
+│ ├── core/ Bot client, context, cog base
+│ ├── utils/ Shared utilities (emoji, tools, sync, ngrok tunnel…)
+│ ├── games/ Standalone game modules
+│ ├── assets/ Fonts, backgrounds, GIFs
+│ └── CodeX.py Entry point
│
-└── 🌐 dashboard/ Next.js frontend
- ├── app/ App Router pages
- ├── components/ Reusable UI components
- ├── hooks/ Custom React hooks
- └── lib/ API helpers & utilities
+└── 🌐 dashboard/ Next.js frontend
+ ├── app/ App Router pages & API routes
+ ├── components/ Reusable UI components
+ ├── hooks/ Custom React hooks
+ ├── lib/ API helpers & utilities
+ └── types/ TypeScript type definitions
```
---
@@ -51,11 +60,11 @@ ZyroX-CV2-With-Dashboard/
**🛡️ Security**
-- Antinuke (ban, kick, channel/role flood, webhook abuse…)
-- Automod (spam, caps, links, invites, mass mentions, emoji spam)
+- Antinuke — ban, kick, channel & role flood, webhook abuse, bot adds, prune
+- Automod — spam, caps, links, invites, mass mentions, emoji spam
- Anti-member update protection
- Whitelist / unwhitelist system
-- Emergency mode
+- Emergency lockdown mode
|
@@ -73,9 +82,9 @@ ZyroX-CV2-With-Dashboard/
|
**⚙️ Management**
-- Moderation (ban, kick, mute, warn, lock…)
-- Logging system
-- Reaction roles, vanity roles
+- Moderation — ban, kick, mute, warn, lock, jail, and more
+- Full logging system
+- Reaction roles, vanity roles, invite tracker
- Tickets, giveaways, verification
- Join-to-create voice channels
@@ -85,9 +94,10 @@ ZyroX-CV2-With-Dashboard/
**🌐 Dashboard**
- Discord OAuth2 login
- Per-server settings management
-- Bot stats & live data
+- Live bot stats & metrics
- Fully branded & customisable
-- Deployed to Vercel in minutes
+- HTTPS via ngrok static domain
+- Deploys to Vercel in minutes
|
@@ -95,21 +105,22 @@ ZyroX-CV2-With-Dashboard/
**🎉 Engagement**
-- Leveling system with XP
+- Leveling & XP system with leaderboard
- Birthday tracker
-- Counting games, blackjack, slots
-- AFK system, autorole, autoresponder
-- Sticky messages, booster perks
+- 12+ mini-games (chess, battleship, wordle, 2048…)
+- AFK system, autorole, autoresponder, sticky messages
+- Counting, blackjack, slots, booster perks
|
**🔧 Developer**
-- Application emoji auto-sync
+- Application emoji auto-sync on startup
- Jishaku eval support
- Slash + prefix commands
-- FastAPI backend with API key auth
-- Hot-patchable emoji.py on startup
+- FastAPI backend with API key auth + rate limiting
+- ngrok HTTPS tunnel (pyngrok — works on Pterodactyl)
+- CodeX Devs watermark on every source file
|
@@ -117,26 +128,25 @@ ZyroX-CV2-With-Dashboard/
---
-## ✦ Quick Start
+## ✦ Prerequisites
-### Prerequisites
-
-| Requirement | Version |
+| Requirement | Version / Notes |
|---|---|
| Python | 3.10 or higher |
| Node.js | 18 or higher |
-| A Lavalink node | v4 |
+| Lavalink node | v4 |
| Discord bot token | — |
-| Discord OAuth app | (for dashboard) |
+| Discord OAuth app | for dashboard login |
+| ngrok account (free) | for HTTPS tunnel |
---
## ✦ Bot Setup
-**1 — Clone and enter the bot folder**
+**1 — Clone the repo**
```bash
-git clone https://github.com/your-org/ZyroX-CV2-With-Dashboard
+git clone https://github.com/RayExo/ZyroX-CV2-With-Dashboard
cd ZyroX-CV2-With-Dashboard/bot
```
@@ -156,34 +166,34 @@ pip install -r requirements.txt
**3 — Configure the environment**
-```bash
-cp .env.example .env
-```
-
-Then edit `.env`:
+Copy `.env.example` to `.env` and fill in the values:
```env
-# ── Core ──────────────────────────────────────
-TOKEN = your_discord_bot_token
-brand_name = 'ZyroX'
+# ── Core ──────────────────────────────────────────────────────────
+TOKEN = your_discord_bot_token
+brand_name = 'ZyroX'
-# ── Lavalink ──────────────────────────────────
-LAVALINK_HOST = "lava-v4.ajieblogs.eu.org"
-LAVALINK_PASSWORD = "your_password"
-LAVALINK_SECURE = "true" # true = https (no port needed)
-LAVALINK_PORT = "" # only needed when LAVALINK_SECURE=false
+# ── Lavalink ──────────────────────────────────────────────────────
+LAVALINK_HOST = "lava-v4.ajieblogs.eu.org"
+LAVALINK_PASSWORD = "your_password"
+LAVALINK_SECURE = "true" # true = HTTPS (no port needed)
+LAVALINK_PORT = "" # only needed when LAVALINK_SECURE=false
-# ── Emoji Sync ────────────────────────────────
-EMOJI_SYNC = "true" # auto-uploads & patches emoji.py on startup
- # restarts the bot automatically after patching
+# ── Emoji Sync ────────────────────────────────────────────────────
+EMOJI_SYNC = "true" # auto-uploads & patches emoji.py on startup
-# ── API / Dashboard Backend ───────────────────
-API_ENABLED = "true" # false = skip starting the FastAPI server
-API_PORT = "8000"
-DASHBOARD_API_KEY = "change_this_to_a_strong_secret"
+# ── API / Dashboard Backend ───────────────────────────────────────
+API_ENABLED = "true"
+API_PORT = "8000"
+DASHBOARD_API_KEY = "change_this_to_a_strong_secret"
-# ── Webhooks ──────────────────────────────────
-WEBHOOK_URL = "https://discord.com/api/webhooks/..."
+# ── HTTPS Tunnel (ngrok) ──────────────────────────────────────────
+TUNNEL_ENABLED = "true"
+NGROK_AUTHTOKEN = "your_ngrok_authtoken"
+NGROK_DOMAIN = "xxxx-xxxx-xxxx.ngrok-free.app"
+
+# ── Webhooks ──────────────────────────────────────────────────────
+WEBHOOK_URL = "https://discord.com/api/webhooks/..."
```
**4 — Run the bot**
@@ -205,25 +215,21 @@ npm install
**2 — Configure the environment**
-```bash
-cp .env.example .env.local
-```
-
-Edit `dashboard/.env.local`:
+Copy `.env.example` to `.env.local` and fill in the values:
```env
-NEXT_PUBLIC_API_URL = http://localhost:8000/api/v1
-NEXT_PUBLIC_DASHBOARD_API_KEY = your_shared_api_key # must match bot's DASHBOARD_API_KEY
+NEXT_PUBLIC_API_URL = https://xxxx.ngrok-free.app/api/v1
+NEXT_PUBLIC_DASHBOARD_API_KEY = your_shared_api_key
-NEXTAUTH_URL = http://localhost:3000
-NEXTAUTH_SECRET = a_long_random_string
+NEXTAUTH_URL = http://localhost:3000
+NEXTAUTH_SECRET = a_long_random_string
-DISCORD_CLIENT_ID = your_discord_oauth_client_id
-DISCORD_CLIENT_SECRET = your_discord_oauth_client_secret
+DISCORD_CLIENT_ID = your_discord_oauth_client_id
+DISCORD_CLIENT_SECRET = your_discord_oauth_client_secret
-NEXT_PUBLIC_ADMIN_IDS = your_discord_user_id
-NEXT_PUBLIC_BRAND_NAME = "ZyroX"
-NEXT_PUBLIC_BRAND_NAME_WORD = "ZX"
+NEXT_PUBLIC_ADMIN_IDS = your_discord_user_id
+NEXT_PUBLIC_BRAND_NAME = "ZyroX"
+NEXT_PUBLIC_BRAND_NAME_WORD = "ZX"
```
**3 — Run locally**
@@ -252,12 +258,15 @@ Open [http://localhost:3000](http://localhost:3000)
| `API_PORT` | `8000` | Port the backend listens on |
| `DASHBOARD_API_KEY` | — | Shared secret between bot API and dashboard |
| `WEBHOOK_URL` | — | Discord webhook for command logs |
+| `TUNNEL_ENABLED` | `true` | Expose the API over HTTPS via ngrok |
+| `NGROK_AUTHTOKEN` | — | ngrok auth token |
+| `NGROK_DOMAIN` | — | Reserved static domain (e.g. `xxxx.ngrok-free.app`) |
### Dashboard — `dashboard/.env.local`
| Variable | Description |
|---|---|
-| `NEXT_PUBLIC_API_URL` | Full URL to the bot's FastAPI backend |
+| `NEXT_PUBLIC_API_URL` | Full URL to the bot's FastAPI backend (use ngrok URL in production) |
| `NEXT_PUBLIC_DASHBOARD_API_KEY` | Must match `DASHBOARD_API_KEY` in the bot |
| `NEXTAUTH_URL` | Your dashboard's public URL |
| `NEXTAUTH_SECRET` | Random secret for NextAuth session signing |
@@ -269,94 +278,80 @@ Open [http://localhost:3000](http://localhost:3000)
---
+## ✦ HTTPS Tunnel (ngrok)
+
+The bot uses **pyngrok** to expose the API over HTTPS — no system installs needed, works on Pterodactyl and any Python host.
+
+With a free ngrok static domain the URL never changes between restarts.
+
+**One-time setup:**
+
+```bash
+# 1. Sign up free at https://ngrok.com
+# 2. Get your authtoken: https://dashboard.ngrok.com/get-started/your-authtoken
+# 3. Reserve a static domain: https://dashboard.ngrok.com/domains
+```
+
+Add to `bot/.env`:
+```env
+TUNNEL_ENABLED = "true"
+NGROK_AUTHTOKEN = "your_token"
+NGROK_DOMAIN = "xxxx.ngrok-free.app"
+```
+
+On every startup the console prints:
+```
+◈ Tunnel: API is live at https://xxxx.ngrok-free.app
+ ↳ set NEXT_PUBLIC_API_URL=https://xxxx.ngrok-free.app/api/v1
+```
+
+---
+
## ✦ Deployment
### 🤖 Bot — any Python host
-1. Upload the entire `bot/` folder to your host (Render, Railway, Fly.io, VPS…)
+1. Upload the entire `bot/` folder to your host (Pterodactyl, Render, Railway, Fly.io, VPS…)
2. Set the start command to `python CodeX.py`
-3. Add all environment variables from `.env.example`
-4. Make sure port `API_PORT` (`8000` by default) is publicly reachable if you're using the dashboard
+3. Add all environment variables
+4. pyngrok downloads the ngrok binary automatically on first run — no extra steps
-> Recommended free/cheap hosts: [NexioHost](https://nexiohost.in) · Render · Railway
+> Recommended free/cheap hosts: Render · Railway · Fly.io · VPS
+>
+> ⭐ **[NexioHost](https://nexiohost.in)** — Premium bot hosting, built for Discord bots. Fast, reliable, and affordable.
-### 🌐 Dashboard — Vercel (recommended)
+### 🌐 Dashboard — Vercel
-> **That's literally it — upload the folder, add the variables, done.**
-
-**Step 1 — Upload to Vercel**
-
-Go to [vercel.com](https://vercel.com) → **Add New Project** → drag and drop the `dashboard/` folder
-*(or connect your GitHub repo and set the root directory to `dashboard/`)*
-
-Vercel auto-detects Next.js — no build settings to touch.
-
----
-
-**Step 2 — Add environment variables**
-
-In your Vercel project → **Settings → Environment Variables**, add these:
-
-| Variable | Value |
-|---|---|
-| `NEXT_PUBLIC_API_URL` | Your bot API URL, e.g. `https://your-bot.render.com/api/v1` |
-| `NEXT_PUBLIC_DASHBOARD_API_KEY` | Same value as `DASHBOARD_API_KEY` in the bot `.env` |
-| `NEXTAUTH_URL` | Your Vercel domain, e.g. `https://your-app.vercel.app` |
-| `NEXTAUTH_SECRET` | Any long random string — [generate one here](https://generate-secret.vercel.app/32) |
-| `DISCORD_CLIENT_ID` | From [Discord Developer Portal](https://discord.com/developers/applications) |
-| `DISCORD_CLIENT_SECRET` | From Discord Developer Portal |
-| `NEXT_PUBLIC_ADMIN_IDS` | Your Discord user ID |
-| `NEXT_PUBLIC_BRAND_NAME` | `ZyroX` *(or your custom name)* |
-| `NEXT_PUBLIC_BRAND_NAME_WORD` | `ZX` *(short version)* |
-
----
-
-**Step 3 — Add the redirect URI in Discord**
-
-Go to your app in the [Discord Developer Portal](https://discord.com/developers/applications)
-→ **OAuth2 → Redirects** → add:
-
-```
-https://your-app.vercel.app/api/auth/callback/discord
-```
-
----
-
-**Step 4 — Deploy**
-
-Hit **Deploy**. Vercel builds and publishes automatically. Your dashboard is live. ✓
+1. Go to [vercel.com](https://vercel.com) → **Add New Project** → connect your GitHub repo
+2. Set root directory to `dashboard/`
+3. Add all environment variables under **Settings → Environment Variables**
+4. Add the OAuth redirect URI in Discord Developer Portal:
+ ```
+ https://your-app.vercel.app/api/auth/callback/discord
+ ```
+5. Hit **Deploy** — done ✓
---
## ✦ Emoji Sync
-ZyroX includes an automatic emoji sync system that runs on every startup (when `EMOJI_SYNC=true`):
+Runs automatically on startup when `EMOJI_SYNC=true`:
```
-★ Starting Application Emoji Sync — 140 unique emojis found in emoji.py
-◈ Found 140 templates | Application hosts 98 emojis
+★ Starting Application Emoji Sync — 144 unique emojis found in emoji.py
+◈ Found 144 templates | Application hosts 202 emojis
↑ Uploading: ztick (not in application emojis)
✔ Uploaded: ztick [saved as ID: 1234567890]
✔ emoji.py patched in-place to reflect current API state.
★ Restarting bot to load updated emoji IDs...
```
-- **New emoji** → downloaded from CDN, uploaded to your application, ID written to `emoji.py`
-- **Stale ID** → `emoji.py` is patched automatically
-- **No changes** → sync completes instantly, no restart
-- **After any patch** → bot restarts itself so the fresh IDs are live immediately
-
-Set `EMOJI_SYNC=false` to disable entirely.
-
----
-
-## ✦ Security Notes
-
-- Never commit `.env` files or real tokens to a public repo — `.gitignore` already covers them
-- Use a strong, unique `NEXTAUTH_SECRET` and `DASHBOARD_API_KEY`
-- Rotate any secret that gets accidentally exposed
-- Keep Discord OAuth credentials in environment variables only
-- The bot API should always be behind an API key when publicly hosted
+| Event | Action |
+|---|---|
+| New emoji found | Uploaded to application, ID written to `emoji.py` |
+| Stale ID detected | `emoji.py` patched automatically |
+| No changes | Sync completes instantly, no restart |
+| After any patch | Bot restarts itself so fresh IDs are live |
---
@@ -364,52 +359,39 @@ Set `EMOJI_SYNC=false` to disable entirely.
| Problem | Fix |
|---|---|
-| Bot fails to start | Check `TOKEN` is set correctly and the bot has the right gateway intents |
-| Music not working | Verify `LAVALINK_HOST`, `LAVALINK_SECURE`, and `LAVALINK_PORT` are correct |
-| Dashboard shows auth error | Check Discord OAuth client ID/secret and redirect URI in Developer Portal |
-| Dashboard can't load data | Confirm `API_ENABLED=true`, the bot is running, and `NEXT_PUBLIC_API_URL` is correct |
+| Bot fails to start | Check `TOKEN` is set and bot has correct gateway intents |
+| Music not working | Verify `LAVALINK_HOST`, `LAVALINK_SECURE`, and `LAVALINK_PORT` |
+| Dashboard auth error | Check Discord OAuth client ID/secret and redirect URI |
+| Dashboard can't load data | Confirm `API_ENABLED=true`, bot is running, `NEXT_PUBLIC_API_URL` is correct |
| Emojis showing as plain text | Run with `EMOJI_SYNC=true` once to upload and patch IDs |
-| Port conflict on API | Change `API_PORT` in `.env` and update `NEXT_PUBLIC_API_URL` in the dashboard |
+| CORS errors from dashboard | Make sure your Vercel URL is in the CORS origins list or add it via `CORS_ORIGINS` env var |
+| Tunnel not starting | Check `NGROK_AUTHTOKEN` is valid — get it from [dashboard.ngrok.com](https://dashboard.ngrok.com) |
+| Tunnel URL changes on restart | Set `NGROK_DOMAIN` to your reserved static domain |
---
-## ✦ Credits & Links
+## ✦ Security
+
+- Never commit `.env` files — `.gitignore` already covers them
+- Use a strong, unique `NEXTAUTH_SECRET` and `DASHBOARD_API_KEY`
+- Rotate any secret that gets accidentally exposed
+- The bot API is always behind an API key — never expose it without one
+
+---
-Developed with ❤️ by **CodeX Devs**
+## ✦ CodeX Devs
-[](https://discord.gg/codexdev)
-[](https://nexiohost.in)
-
-
-
----
-
-## ✦ License
-
-```
-MIT License — Copyright (c) 2026 CodeX Devs
-
-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.
-```
-
-
-
----
-
-*ZyroX — Built for protection. Designed for style.*
+*Built for protection. Designed for style.*
+
+
+
+
+
+
+
+
+© 2026 CodeX Devs — MIT License
ZyroX Bot — Python Discord Bot + FastAPI Backend
+
+
+
+
+
+
+
+
+
+
+
+
@@ -23,68 +29,131 @@
## ✦ Overview
-This folder contains the ZyroX Discord bot built on `discord.py v2` with a `FastAPI` backend that powers the web dashboard. It handles all server moderation, music, leveling, and utility features.
+This folder contains the ZyroX Discord bot built on `discord.py v2` alongside a `FastAPI` backend that powers the web dashboard. It handles all server moderation, music, leveling, mini-games, and utility features — all from a single `python CodeX.py` command.
```
bot/
-├── api/ FastAPI backend (routes, schemas, db manager)
+├── api/ FastAPI backend (routes, schemas, db manager)
+│ └── routes/ /bot /guilds /admin
├── cogs/
-│ ├── antinuke/ Antinuke protection events
-│ ├── automod/ Automod enforcement events
-│ ├── commands/ All slash & prefix commands
-│ └── events/ General Discord event listeners
-├── utils/ Shared utilities (emoji, tools, sync)
-├── assets/ Fonts, backgrounds, GIFs
-└── CodeX.py Entry point
+│ ├── antinuke/ Antinuke protection event listeners
+│ ├── automod/ Automod enforcement event listeners
+│ ├── commands/ All slash & prefix command modules
+│ ├── events/ General Discord event listeners
+│ ├── moderation/ Moderation action modules
+│ └── zyrox/ Core ZyroX feature cogs
+├── core/ Bot client, context, cog base classes
+├── games/ Standalone game logic + button views
+├── utils/ Emoji, tools, sync, ngrok tunnel
+├── assets/ Fonts, backgrounds, GIFs
+└── CodeX.py Entry point
```
---
## ✦ Features
+
+
+|
+
**🛡️ Antinuke**
-- Protection against mass ban, kick, channel/role flood, webhook abuse, bot adds, prune, and more
+- Mass ban, kick, channel & role flood detection
+- Webhook abuse, bot add, prune protection
+- Anti-member update
- Whitelist / unwhitelist system
- Emergency lockdown mode
+ |
+
+
**🤖 Automod**
-- Anti-spam, anti-caps, anti-links, anti-invites
-- Mass mention and emoji spam protection
+- Anti-spam, anti-caps, anti-links
+- Anti-invites, mass mention, emoji spam
- Fully configurable per server
+- Works alongside Discord's native automod
+
+ |
+
+
+|
**🎵 Music**
- Lavalink v4 powered playback
- YouTube, SoundCloud, JioSaavn support
-- Queue, loop, shuffle, autoplay, seek controls
+- Queue, loop, shuffle, autoplay
+- Seek, rewind, forward controls
-**⚙️ Moderation & Management**
-- Ban, kick, mute, warn, lock, and more
-- Logging, reaction roles, vanity roles
-- Tickets, giveaways, verification, join-to-create VC
+ |
+
+
+**⚙️ Moderation**
+- Ban, kick, mute, warn, lock, jail
+- Snipe, message management
+- Full logging system
+- Reaction roles, vanity roles, invite tracker
+
+ |
+
+
+|
**🎉 Engagement**
-- Leveling & XP system
-- Birthday tracker, AFK, autorole
-- Counting, blackjack, slots, autoresponder, sticky messages
+- Leveling & XP with leaderboard
+- Birthday tracker
+- Counting, AFK, autorole, autoresponder
+- Sticky messages, booster perks, giveaways
+
+ |
+
+
+**🎮 Games**
+- Chess, Battleship, Connect Four
+- Wordle, Typeracer, 2048, Memory
+- Reaction test, RPS, Tic-tac-toe
+- Country guess, Number slider, Lights out
+
+ |
+
+
+|
+
+**🌐 API Backend**
+- FastAPI with API key auth
+- SlowAPI rate limiting
+- Structured JSON request logging
+- CORS configured for your dashboard domain
+- `CORS_ORIGINS` env var for extra domains
+
+ |
+
**🔧 Developer**
- Jishaku eval support
- Application emoji auto-sync
- Slash + prefix commands
-- FastAPI backend with API key auth
+- ngrok HTTPS tunnel (pyngrok — no system install)
+- CodeX Devs watermark on every source file
+
+ |
+
+
+
+---
+
+## ✦ Prerequisites
+
+| Requirement | Notes |
+|---|---|
+| Python 3.10+ | — |
+| Lavalink v4 node | for music features |
+| Discord bot token | from Developer Portal |
+| ngrok free account | for HTTPS tunnel |
---
## ✦ Setup
-### Prerequisites
-
-| Requirement | Version |
-|---|---|
-| Python | 3.10 or higher |
-| A Lavalink node | v4 |
-| Discord bot token | — |
-
### 1 — Install dependencies
```bash
@@ -101,33 +170,35 @@ pip install -r requirements.txt
### 2 — Configure environment
-```bash
-cp .env.example .env
-```
-
-Edit `.env`:
+Create a `.env` file in this folder:
```env
-# ── Core ──────────────────────────────────────
-TOKEN = your_discord_bot_token
-brand_name = 'ZyroX'
+# ── Core ──────────────────────────────────────────────────────────
+TOKEN = your_discord_bot_token
+brand_name = 'ZyroX'
-# ── Lavalink ──────────────────────────────────
-LAVALINK_HOST = "lava-v4.ajieblogs.eu.org"
-LAVALINK_PASSWORD = "your_password"
-LAVALINK_SECURE = "true" # true = HTTPS (no port needed)
-LAVALINK_PORT = "" # only needed when LAVALINK_SECURE=false
+# ── Lavalink ──────────────────────────────────────────────────────
+LAVALINK_HOST = "lava-v4.ajieblogs.eu.org"
+LAVALINK_PASSWORD = "your_password"
+LAVALINK_SECURE = "true" # true = HTTPS (no port needed)
+LAVALINK_PORT = "" # only needed when LAVALINK_SECURE=false
-# ── Emoji Sync ────────────────────────────────
-EMOJI_SYNC = "true" # auto-uploads & patches emoji.py on startup
+# ── Emoji Sync ────────────────────────────────────────────────────
+EMOJI_SYNC = "true"
-# ── API / Dashboard Backend ───────────────────
-API_ENABLED = "true" # false = skip starting the FastAPI server
-API_PORT = "8000"
-DASHBOARD_API_KEY = "change_this_to_a_strong_secret"
+# ── API / Dashboard Backend ───────────────────────────────────────
+API_ENABLED = "true"
+API_PORT = "8000"
+DASHBOARD_API_KEY = "change_this_to_a_strong_secret"
+CORS_ORIGINS = "" # extra allowed origins, comma-separated
-# ── Webhooks ──────────────────────────────────
-WEBHOOK_URL = "https://discord.com/api/webhooks/..."
+# ── HTTPS Tunnel (ngrok) ──────────────────────────────────────────
+TUNNEL_ENABLED = "true"
+NGROK_AUTHTOKEN = "your_ngrok_authtoken"
+NGROK_DOMAIN = "xxxx-xxxx-xxxx.ngrok-free.app"
+
+# ── Webhooks ──────────────────────────────────────────────────────
+WEBHOOK_URL = "https://discord.com/api/webhooks/..."
```
### 3 — Run
@@ -146,48 +217,66 @@ python CodeX.py
| `LAVALINK_HOST` | — | Lavalink server hostname (no protocol) |
| `LAVALINK_PASSWORD` | — | Lavalink password |
| `LAVALINK_SECURE` | `true` | `true` = HTTPS, `false` = HTTP |
-| `LAVALINK_PORT` | _(empty)_ | Port — only needed when `LAVALINK_SECURE=false` |
-| `EMOJI_SYNC` | `true` | Run application emoji sync on startup |
+| `LAVALINK_PORT` | _(empty)_ | Port — only when `LAVALINK_SECURE=false` |
+| `EMOJI_SYNC` | `true` | Auto-sync application emojis on startup |
| `API_ENABLED` | `true` | Start the FastAPI dashboard backend |
| `API_PORT` | `8000` | Port the backend listens on |
| `DASHBOARD_API_KEY` | — | Shared secret between bot API and dashboard |
+| `CORS_ORIGINS` | _(empty)_ | Extra CORS-allowed origins, comma-separated |
| `WEBHOOK_URL` | — | Discord webhook for command logs |
+| `TUNNEL_ENABLED` | `true` | Expose API over HTTPS via ngrok |
+| `NGROK_AUTHTOKEN` | — | ngrok auth token |
+| `NGROK_DOMAIN` | — | Reserved static domain (e.g. `xxxx.ngrok-free.app`) |
+
+---
+
+## ✦ HTTPS Tunnel (ngrok)
+
+Uses **pyngrok** — downloads the ngrok binary automatically on first run. No system installs, works on Pterodactyl and any Python host.
+
+### One-time setup
+
+1. Sign up free at [ngrok.com](https://ngrok.com)
+2. Copy your authtoken from [dashboard.ngrok.com/get-started/your-authtoken](https://dashboard.ngrok.com/get-started/your-authtoken)
+3. Reserve a free static domain at [dashboard.ngrok.com/domains](https://dashboard.ngrok.com/domains) — looks like `xxxx.ngrok-free.app`
+4. Add `NGROK_AUTHTOKEN` and `NGROK_DOMAIN` to `.env`
+
+On every startup the console prints:
+```
+◈ Tunnel: API is live at https://xxxx.ngrok-free.app
+ ↳ set NEXT_PUBLIC_API_URL=https://xxxx.ngrok-free.app/api/v1
+```
+
+Set `TUNNEL_ENABLED=false` to disable.
---
## ✦ Emoji Sync
-When `EMOJI_SYNC=true`, the bot automatically syncs application emojis on every startup:
+When `EMOJI_SYNC=true`, the bot syncs application emojis on every startup:
-```
-★ Starting Application Emoji Sync — 140 unique emojis found in emoji.py
-◈ Found 140 templates | Application hosts 98 emojis
-↑ Uploading: ztick (not in application emojis)
-✔ Uploaded: ztick [saved as ID: 1234567890]
-✔ emoji.py patched in-place to reflect current API state.
-★ Restarting bot to load updated emoji IDs...
-```
-
-- New emojis → uploaded to your application, ID written to `emoji.py`
-- Stale IDs → `emoji.py` is patched automatically
-- No changes → sync completes instantly, no restart
-- After any patch → bot restarts itself so fresh IDs are live immediately
-
-Set `EMOJI_SYNC=false` to disable entirely.
+| Event | Action |
+|---|---|
+| New emoji found | Uploaded to application, ID written to `emoji.py` |
+| Stale ID detected | `emoji.py` patched automatically |
+| No changes | Sync completes instantly, no restart |
+| After any patch | Bot restarts so fresh IDs are live |
---
## ✦ Deployment
-Upload the entire `bot/` folder to your host (Render, Railway, Fly.io, VPS) and set the start command to:
+Upload the entire `bot/` folder to your host and set the start command to:
```bash
python CodeX.py
```
-Add all environment variables from `.env.example`. Make sure port `API_PORT` (`8000` by default) is publicly reachable if you're using the dashboard.
+pyngrok downloads the ngrok binary on first run — no extra steps needed on any host.
-> Recommended free/cheap hosts: [NexioHost](https://nexiohost.in) · Render · Railway
+> Recommended free hosts: Render · Railway · Fly.io · Pterodactyl
+>
+> ⭐ **[NexioHost](https://nexiohost.in)** — Premium bot hosting, built for Discord bots. Fast, reliable, and affordable.
---
@@ -195,21 +284,29 @@ Add all environment variables from `.env.example`. Make sure port `API_PORT` (`8
| Problem | Fix |
|---|---|
-| Bot fails to start | Check `TOKEN` is set correctly and the bot has the right gateway intents |
-| Music not working | Verify `LAVALINK_HOST`, `LAVALINK_SECURE`, and `LAVALINK_PORT` are correct |
-| Dashboard can't load data | Confirm `API_ENABLED=true`, bot is running, and `NEXT_PUBLIC_API_URL` in the dashboard is correct |
-| Emojis showing as plain text | Run with `EMOJI_SYNC=true` once to upload and patch IDs |
-| Port conflict on API | Change `API_PORT` in `.env` and update `NEXT_PUBLIC_API_URL` in the dashboard |
+| Bot fails to start | Check `TOKEN` and gateway intents in Developer Portal |
+| Music not working | Verify `LAVALINK_HOST`, `LAVALINK_SECURE`, `LAVALINK_PORT` |
+| Dashboard can't reach API | Check `API_ENABLED=true` and `NEXT_PUBLIC_API_URL` in dashboard |
+| CORS errors | Add your Vercel URL to `CORS_ORIGINS` in `.env` |
+| Emojis showing as plain text | Run once with `EMOJI_SYNC=true` to upload and patch IDs |
+| Tunnel not starting | Check `NGROK_AUTHTOKEN` is valid |
+| Tunnel URL changes each restart | Set `NGROK_DOMAIN` to your reserved static domain |
---
-Developed with ❤️ by **CodeX Devs**
+## ✦ CodeX Devs
-[](https://discord.gg/codexdev)
-[](https://nexiohost.in)
+*Built for protection. Designed for style.*
-*ZyroX — Built for protection. Designed for style.*
+
+
+
+
+
+
+
+© 2026 CodeX Devs — MIT License
ZyroX Dashboard — Next.js Web Interface
+
+
+
+ 
+ 
+
+
+
+
+
+
+
@@ -23,45 +29,59 @@
## ✦ Overview
-This folder contains the ZyroX web dashboard built with `Next.js 14` (App Router), `TypeScript`, and `Tailwind CSS`. It connects to the bot's FastAPI backend to let server admins manage all bot settings through a modern UI.
+This folder contains the ZyroX web dashboard built with `Next.js 14` (App Router), `TypeScript`, and `Tailwind CSS`. It connects to the bot's FastAPI backend via HTTPS (ngrok tunnel) and lets server admins manage all bot settings through a sleek, branded UI.
```
dashboard/
-├── app/ App Router pages & API routes
-│ ├── api/ Next.js API routes (auth callbacks, etc.)
-│ ├── dashboard/ Per-server settings pages
-│ ├── docs/ Documentation page
-│ ├── privacy/ Privacy policy page
-│ └── terms/ Terms of service page
+├── app/ App Router pages & API routes
+│ ├── api/auth/ NextAuth OAuth callback
+│ ├── dashboard/ Main dashboard area
+│ │ ├── admin/ Admin-only panel
+│ │ ├── guilds/ Server selection
+│ │ └── guild/[guildId]/ Per-server settings pages
+│ │ ├── antinuke/
+│ │ ├── automod/
+│ │ ├── leveling/
+│ │ ├── logging/
+│ │ ├── tickets/
+│ │ ├── welcome/
+│ │ └── …more
+│ ├── docs/ Documentation page
+│ ├── privacy/ Privacy policy
+│ └── terms/ Terms of service
├── components/
-│ ├── dashboard/ Dashboard-specific UI components
-│ └── ui/ Reusable base components
-├── hooks/ Custom React hooks
-├── lib/ API helpers, auth config, utilities
-└── types/ TypeScript type definitions
+│ ├── dashboard/ Feature-specific form components
+│ └── ui/ Base UI components (button, card, input…)
+├── hooks/ Custom React hooks
+├── lib/ API client, auth config, utilities
+└── types/ TypeScript type definitions
```
---
## ✦ Features
-- **Discord OAuth2 login** — secure sign-in with your Discord account
-- **Per-server management** — configure antinuke, automod, leveling, and more per guild
-- **Live bot stats** — view real-time data from the bot
-- **Fully branded** — customisable name, logo, and colours via environment variables
+- **Discord OAuth2 login** — secure sign-in, session managed by NextAuth
+- **Per-server management** — antinuke, automod, leveling, logging, tickets, welcome, and more
+- **Live bot stats** — real-time metrics pulled from the FastAPI backend
+- **Admin panel** — owner-only configuration and announcements
+- **Fully branded** — name, logo, and colours via environment variables
+- **HTTPS ready** — works with the bot's ngrok static domain out of the box
- **Vercel-ready** — deploys in minutes with zero config changes
---
-## ✦ Setup
+## ✦ Prerequisites
-### Prerequisites
-
-| Requirement | Version |
+| Requirement | Notes |
|---|---|
-| Node.js | 18 or higher |
-| ZyroX bot running | with `API_ENABLED=true` |
-| Discord OAuth app | — |
+| Node.js 18+ | — |
+| ZyroX bot running | with `API_ENABLED=true` and `TUNNEL_ENABLED=true` |
+| Discord OAuth app | from [Discord Developer Portal](https://discord.com/developers/applications) |
+
+---
+
+## ✦ Setup
### 1 — Install dependencies
@@ -71,25 +91,26 @@ npm install
### 2 — Configure environment
-```bash
-cp .env.example .env.local
-```
-
-Edit `.env.local`:
+Create a `.env.local` file in this folder:
```env
-NEXT_PUBLIC_API_URL = http://localhost:8000/api/v1
+# ── Bot API ───────────────────────────────────────────────────────
+# Use the ngrok static domain from the bot's tunnel
+NEXT_PUBLIC_API_URL = https://xxxx-xxxx-xxxx.ngrok-free.app/api/v1
NEXT_PUBLIC_DASHBOARD_API_KEY = your_shared_api_key # must match bot's DASHBOARD_API_KEY
-NEXTAUTH_URL = http://localhost:3000
-NEXTAUTH_SECRET = a_long_random_string
+# ── NextAuth ──────────────────────────────────────────────────────
+NEXTAUTH_URL = http://localhost:3000
+NEXTAUTH_SECRET = a_long_random_string # generate: openssl rand -base64 32
-DISCORD_CLIENT_ID = your_discord_oauth_client_id
-DISCORD_CLIENT_SECRET = your_discord_oauth_client_secret
+# ── Discord OAuth ─────────────────────────────────────────────────
+DISCORD_CLIENT_ID = your_discord_oauth_client_id
+DISCORD_CLIENT_SECRET = your_discord_oauth_client_secret
-NEXT_PUBLIC_ADMIN_IDS = your_discord_user_id
-NEXT_PUBLIC_BRAND_NAME = "ZyroX"
-NEXT_PUBLIC_BRAND_NAME_WORD = "ZX"
+# ── Branding ──────────────────────────────────────────────────────
+NEXT_PUBLIC_ADMIN_IDS = your_discord_user_id
+NEXT_PUBLIC_BRAND_NAME = "ZyroX"
+NEXT_PUBLIC_BRAND_NAME_WORD = "ZX"
```
### 3 — Run locally
@@ -106,45 +127,42 @@ Open [http://localhost:3000](http://localhost:3000)
| Variable | Description |
|---|---|
-| `NEXT_PUBLIC_API_URL` | Full URL to the bot's FastAPI backend |
-| `NEXT_PUBLIC_DASHBOARD_API_KEY` | Must match `DASHBOARD_API_KEY` in the bot `.env` |
-| `NEXTAUTH_URL` | Your dashboard's public URL |
+| `NEXT_PUBLIC_API_URL` | Full URL to the bot's FastAPI backend — use the ngrok static domain |
+| `NEXT_PUBLIC_DASHBOARD_API_KEY` | Must exactly match `DASHBOARD_API_KEY` in the bot `.env` |
+| `NEXTAUTH_URL` | Your dashboard's public URL (Vercel domain in production) |
| `NEXTAUTH_SECRET` | Random secret for NextAuth session signing |
| `DISCORD_CLIENT_ID` | Discord OAuth2 client ID |
| `DISCORD_CLIENT_SECRET` | Discord OAuth2 client secret |
-| `NEXT_PUBLIC_ADMIN_IDS` | Comma-separated Discord user IDs with admin access |
+| `NEXT_PUBLIC_ADMIN_IDS` | Comma-separated Discord user IDs with admin panel access |
| `NEXT_PUBLIC_BRAND_NAME` | Bot name shown in the dashboard UI |
-| `NEXT_PUBLIC_BRAND_NAME_WORD` | Short abbreviation shown in the dashboard |
+| `NEXT_PUBLIC_BRAND_NAME_WORD` | Short abbreviation shown in the dashboard (e.g. `ZX`) |
---
## ✦ Deployment (Vercel)
-Vercel is the recommended host — the project is pre-configured for it.
+Vercel is the recommended host — the project is pre-configured for zero-config deployment.
-**Step 1 — Upload to Vercel**
+**Step 1 — Connect your repo**
-Go to [vercel.com](https://vercel.com) → **Add New Project** → connect your GitHub repo and set the root directory to `dashboard/`.
+Go to [vercel.com](https://vercel.com) → **Add New Project** → connect your GitHub repo → set root directory to `dashboard/`
Vercel auto-detects Next.js — no build settings needed.
**Step 2 — Add environment variables**
-In your Vercel project → **Settings → Environment Variables**, add all keys from `.env.example`.
+In **Settings → Environment Variables**, add all keys from the table above.
-| Variable | Example Value |
+| Variable | Production Value |
|---|---|
-| `NEXT_PUBLIC_API_URL` | `https://your-bot.render.com/api/v1` |
-| `NEXT_PUBLIC_DASHBOARD_API_KEY` | same value as bot's `DASHBOARD_API_KEY` |
+| `NEXT_PUBLIC_API_URL` | `https://xxxx.ngrok-free.app/api/v1` |
| `NEXTAUTH_URL` | `https://your-app.vercel.app` |
-| `NEXTAUTH_SECRET` | [generate one here](https://generate-secret.vercel.app/32) |
+| `NEXTAUTH_SECRET` | [generate one](https://generate-secret.vercel.app/32) |
| `DISCORD_CLIENT_ID` | from [Discord Developer Portal](https://discord.com/developers/applications) |
-| `DISCORD_CLIENT_SECRET` | from Discord Developer Portal |
-| `NEXT_PUBLIC_ADMIN_IDS` | your Discord user ID |
-**Step 3 — Add redirect URI in Discord**
+**Step 3 — Add the redirect URI in Discord**
-Go to your app in the [Discord Developer Portal](https://discord.com/developers/applications) → **OAuth2 → Redirects** → add:
+In your Discord app → **OAuth2 → Redirects** → add:
```
https://your-app.vercel.app/api/auth/callback/discord
@@ -156,24 +174,49 @@ Hit **Deploy**. Vercel builds and publishes automatically. ✓
---
+## ✦ Connecting to the Bot API
+
+The dashboard talks to the bot's FastAPI backend. The URL comes from `NEXT_PUBLIC_API_URL`.
+
+- **Local dev** — set to `http://localhost:8000/api/v1` (bot running locally)
+- **Production** — set to the bot's ngrok static domain: `https://xxxx.ngrok-free.app/api/v1`
+
+The bot prints the current tunnel URL every time it starts:
+```
+◈ Tunnel: API is live at https://xxxx.ngrok-free.app
+ ↳ set NEXT_PUBLIC_API_URL=https://xxxx.ngrok-free.app/api/v1
+```
+
+If you set `NGROK_DOMAIN` in the bot's `.env`, this URL will never change between restarts.
+
+---
+
## ✦ Troubleshooting
| Problem | Fix |
|---|---|
| Auth error on login | Check Discord OAuth client ID/secret and redirect URI in Developer Portal |
-| Dashboard can't load data | Confirm the bot is running with `API_ENABLED=true` and `NEXT_PUBLIC_API_URL` is correct |
+| Dashboard can't load data | Confirm bot is running with `API_ENABLED=true` and `NEXT_PUBLIC_API_URL` is correct |
+| CORS error in browser | Make sure your Vercel URL is allowed — add it to `CORS_ORIGINS` in the bot's `.env` |
| `NEXTAUTH_SECRET` error | Make sure `NEXTAUTH_SECRET` is set and non-empty |
-| API key mismatch | `NEXT_PUBLIC_DASHBOARD_API_KEY` must exactly match `DASHBOARD_API_KEY` in the bot |
+| API key rejected (401) | `NEXT_PUBLIC_DASHBOARD_API_KEY` must exactly match `DASHBOARD_API_KEY` in the bot |
+| ngrok warning page appears | The bot's FastAPI middleware already injects the skip-warning header automatically |
---
-Developed with ❤️ by **CodeX Devs**
+## ✦ CodeX Devs
-[](https://discord.gg/codexdev)
-[](https://nexiohost.in)
+*Built for protection. Designed for style.*
-*ZyroX — Built for protection. Designed for style.*
+
+
+
+
+
+
+
+© 2026 CodeX Devs — MIT License