Skip to content

Latest commit

 

History

History
148 lines (95 loc) · 3.29 KB

README.md

File metadata and controls

148 lines (95 loc) · 3.29 KB
Raw

JazzRadio

NodeJS Discord.js

Overview

JazzRadio Bot is a Discord bot that streams smooth jazz music in voice channels. It supports various commands such as /play, /stop, /leave, /info, /vote, and /help. The bot also features a rotating activity status to keep things lively.

You can find this bot here, or you can invite it from here.

Execute /help of the bot to view all available commands!

🌟 Features

  • Play Music: Stream smooth jazz in voice channels.
  • Status Rotation: Rotates activity status messages.
  • Command Handling: Includes commands for playing, stopping, leaving, and more.
  • 24/7: Bot keeps playing the Jazz all day / night long.
  • Error Logging: All errors are kept in an error.log file for you to inspect.

🚀 Requirements

  • Node.js: Version 18.x or later.
  • Discord.js: Version 14.x or later.
  • @discordjs/voice: For voice-related features.

⚙️ Installation

  1. Clone the Repository
  git clone https://github.com/ExceptedPrism3/JazzRadio.git
  cd JazzRadio
  1. Install Dependencies

⚠️ Ensure you have Node.js installed. Then run:

  npm install
  1. Configuration

Create a config.json file in the root directory with the following structure:

{
  "token": "YOUR_DISCORD_BOT_TOKEN",
  "clientId": "YOUR_CLIENT_ID",
  "voteLink": "YOUR_BOT_VOTE_LINK",
  "inviteLink": "YOUR_BOT_INVITE_LINK",
  "statusMessages": [
    "Playing smooth jazz",
    "Streaming 24/7",
    "Chill vibes only",
    "Tune in to relax",
    "Contemporary Jazz",
    "DJ Hmida",
    "Pure Jazz",
    "Saxophone Instrument"
  ],
  "statusInterval": 60000 // Interval in milliseconds
}

Replace the placeholders with the appropriate information.

  1. Register Commands

Run the following command to register your bot's commands while being the project root:

  node utils/deploy-commands.js

🕹️ Usage

  1. Start the Bot
  node index.js

  1. Commands

    Use the commands from the /help command

🤝 Contributing

  1. Fork the Repository

    Create a fork of this repository to make changes.

  2. Clone your Work

  git clone https://github.com/ExceptedPrism3/JazzrRdio.git
  cd JazzRadio
  1. Create a Branch
  git checkout -b your-feature-branch

  1. Make Changes

    Implement your feature or fix.

  2. Commit Changes

  git add .
  git commit -m "Add your commit message here"
  1. Push the Changes
  git push origin your-feature-branch

  1. Create a Pull Request

    Submit a pull request with your changes.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

✉️ Contact

For any questions or feedback, please reach out over the Discord Support Server or open an Issue on GitHub.


🎉 Enjoy using JazzRadio Bot and happy coding!