Skip to content

DreamrelaXV/VRBW-Utility

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VRBW Utility Bot

A professional Discord bot suite designed for comprehensive server management and staff operations for Veltrix Ranked Bedwars.

Overview

VRBW Utility Bot is a multi-guild management system built with Discord.js v14, featuring role-based access control, ticket management, staff operations, and punishment logging. The bot uses a JSON-based database system for lightweight, portable data storage.

Core Features

Staff Management

  • Onboarding & Offboarding: Streamlined staff member management with automatic role assignment
  • Promotions & Demotions: Professional rank changes with multi-guild announcements
  • Role Hierarchy: 12-tier permission system with configurable access levels
  • Audit Trail: Complete logging of all staff operations

Ticket System

  • Multi-Category Support: General, Scoring, Appeal, Store, Partnership, and ScreenSharing tickets
  • Role-Based Permissions: Configure which roles can access specific ticket categories
  • Automatic Transcripts: Cross-guild transcript logging with detailed metadata
  • User Statistics: Track ticket creation and management metrics
  • JSON Database: Persistent storage without external database dependencies

Punishment Logging

  • Comprehensive Documentation: Log bans, mutes, kicks, strikes, and custom actions
  • Evidence System: Attach proof and maintain accountability standards
  • Designated Channels: Guild-specific punishment log channels
  • Reference System: Track appeals and historical actions

ScreenSharer Management

  • Tiered Permissions: Trial and Full ScreenSharer role management
  • Guild-Specific: Restricted to designated server with role-based access
  • Action Tracking: Complete logging of role assignments and removals

Administrative Tools

  • Hot Reload: Update configuration and commands without downtime
  • Debug Utilities: Comprehensive permission and role analysis
  • Multi-Guild Support: Manage multiple Discord servers from one bot
  • Database Statistics: Monitor ticket system performance and usage

Technical Stack

  • Framework: Discord.js v14
  • Database: JSON File System
  • Commands: Slash Command Interface
  • Permissions: Role-Based Access Control (RBAC)
  • Configuration: Environment variables + JSON config

Installation

  1. Clone the repository
  2. Install dependencies: npm install
  3. Configure environment variables in .env
  4. Set up config/config.json with your guild and role IDs
  5. Start the bot: npm start

Configuration

The bot requires two configuration files:

.env

TICKET_CATEGORY_ID=your_category_id
TRANSCRIPT_CHANNEL_ID=your_transcript_channel_id
SUPPORT_ROLE_ID=your_support_role_id
SS_ROLE_ID=your_ss_role_id

config/config.json

Configure guilds, roles, permissions, and ticket access control. See example config for structure.

Ticket Role Permissions

Control which roles can access specific ticket categories by editing ticket_permissions in your config:

{
  "ticket_permissions": {
    "general": ["support_role_id", "helper_role_id"],
    "appeal": ["admin_role_id", "staff_role_id"],
    "store": ["owner_role_id"]
  }
}

Commands

Staff Operations

  • /staff-join - Onboard new team members
  • /staff-fire - Process departures
  • /staff-promote - Execute promotions
  • /staff-demote - Process demotions

Punishment System

  • /punishment-log - Document disciplinary actions

ScreenSharer Management

  • /screensharer-add - Grant SS permissions
  • /screensharer-remove - Revoke SS permissions

Ticket System

  • /setup-ticket - Initialize ticket system
  • /close-ticket - Close with transcript
  • /ticket-add - Add user/role to ticket
  • /ticket-remove - Remove user/role from ticket
  • /ticket-info - View ticket details
  • /ticket-stats - View statistics
  • /db-stats - Database statistics
  • /wipe-ticket-stats - Reset all ticket data

Administrative

  • /reload - Hot-reload configuration
  • /debug-permissions - Analyze permissions
  • /help - Command documentation

Permission Levels

  1. Root1/Root2 (Level 12/11): Full system access
  2. Owner (Level 10): Executive control
  3. Manager (Level 9): Staff management
  4. Head Developer (Level 8): Development oversight
  5. Developer (Level 7): Technical operations
  6. Vice Manager (Level 6): Assistant management
  7. Admin (Level 5): Administrative operations
  8. Sr Moderator (Level 4): Senior moderation
  9. Moderator (Level 3): Standard moderation
  10. Helper (Level 2): Basic support

Database Structure

The bot uses JSON files for data persistence:

  • src/data/database.json - Main database (tickets, categories, user stats, messages)
  • Automatic backups on major operations
  • Easy migration and portability

Support

For issues, feature requests, or contributions, contact the development team.

License

MIT

Made with ❤️ by Dreamrela

⭐ Star this repo if VRBW Utility Bot helps your server!

About

Utilities bot for VRBW. Made by Dreamrela :D

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors