https://github.com/theassassin0128/node
A Multipurpose discord bot
https://github.com/theassassin0128/node
bot discord-bot discord-js javascript lavalink-musicbot moderation-bot music-bot
Last synced: 3 months ago
JSON representation
A Multipurpose discord bot
- Host: GitHub
- URL: https://github.com/theassassin0128/node
- Owner: theassassin0128
- License: mit
- Created: 2022-12-06T09:28:37.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-04-02T00:37:29.000Z (3 months ago)
- Last Synced: 2025-04-02T01:29:48.921Z (3 months ago)
- Topics: bot, discord-bot, discord-js, javascript, lavalink-musicbot, moderation-bot, music-bot
- Language: JavaScript
- Homepage: https://theassassin0128.github.io/Node/
- Size: 1.24 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
[![Version][version-shield]][version-shield-link]
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![Support Server][support-shield]][support-server]
[![MIT License][license-shield]][license-url]
[![CodeQL][codeql]][codeql-url]
[![Dependency Review][dependency-review]][dependency-review-url]
[![CodeFactor][code-factor]][code-factor-url]
# 🚀 Node - Multipurpose Discord Bot
**Node** is a multipurpose Discord bot that is built with [discord.js](https://github.com/discordjs/discord.js), a powerful [Node.js](https://nodejs.org) module that allows you to easily interact with the [Discord API](https://discord.com/developers/docs/intro).
[✉️ Invite Node][bot-invite] • [🆘 Support Server][support-server] • [📝 Bug & Request Feature][issues-url]
## 📊 Road Map
- [x] **Basic Bot**
- [x] **Music Bot**
- [x] **Moderation Bot**
- [x] **Information Bot**
- [ ] **Website**
- [ ] **Dashboard**
- [ ] **Documentation**
## 💡 Features
- **Advanced Logger**
- **Moderation Tools**
- **Music Streaming**
- **Server Management**
- **Highly Customizable**
- **Multi-Language Support**
- **Custom Scripts**
- **Advanced Error Handler**
- **Predefined Types**
- **Basic Sharding**
- **Advanced Validation**
- **Templates for Events, Commands & Contexts**
## 🔧 Requirements
Before you get started, you need to have the following:
- [](https://nodejs.org/en/download/) (Recommend LTS or Higher)
- [](https://github.com/lavalink-devs/lavalink) (V4 or Higher)
- [](https://www.mongodb.com/try/download/community) (Required for MongoDB database)
## 🚀 Get Started
1. First clone the repository:
```bash
git clone https://github.com/theassassin0128/Node.git
```
2. Change to the directory:
```bash
cd Node
```
3. Install the required packages:
```bash
pnpm install # you can also use npm if you want
```
> [!NOTE]
> Install `pnpm` if you don't have it installed
```bash
npm install -g pnpm
```
4. Copy `example.lavalink-nodes.js` to `lavalink-nodes.js`
> [!IMPORTANT]
> If you are using external nodes then add them. For locally hosted node no need to add extra info.
5. Copy `.env.example` to `.env` and fill in all the required values.
6. Now go to [Discord Developer Page](https://discord.com/developers/applications) select your application and head to OAuth2 tab. In OAuth2 URL Generator select "bot" and "application.commands" scopes, scroll down select "Administrator" permission, copy the URL, open the URL and invite the bot to your server.
7. Start the bot:
```bash
# You can also use npm if you want
pnpm start
pnpm run dev # if you want to run in dev mode
```
8. Start using the bot. Use `/ping` or `/botinfo` commands.
> [!NOTE]
> By default, the bot loads slash commands globally. To load slash commands to a single server, go to `src/config.js`, in `bot` change value of `global` to `false`. This will make sure that the slash commands are available only in your server.
## 🗝️ Sharding
**Sharding** is not recommended for bots that are in less than **2,000 servers**. By default the bot runs without sharding. To enable sharding, start the bot like this:
```bash
pnpm run shard
pnpm run devShard # if you want to run in dev mode
```
## 📜 Commands
> [!NOTE]
> There will be a dedicated markdown file for commands in future.
> For now here are some public commands of the bot.
| Name | Description |
| -------- | ---------------------------------------------- |
| ping | 🏓 Pong! Replies with bot's response time. |
| botinfo | 📖 View bot's information. |
| invite | returns a link button with bot's invite URL. |
| language | 🌐 Change your language for the bot. |
| play | ▶ Play songs or tracks from available sources. |
| purge | 🧹 Delete bulk amount of messages. |
## 🤝 Contributing
Please check the [issues page](https://github.com/theassassin0128/Node/issues) for open issues and feature requests.
Thank you for your interest in contributing to this project! Remember to follow these guidelines when contributing:
1. Fork the repository and create a new branch for your feature or bug fix.
2. Write clean and concise code that follows the established coding style.
3. Create detailed and thorough documentation for any new features or changes.
4. Write and run tests for your code.
5. Submit a pull request with your changes. Your contribution will be reviewed, and any necessary feedback or changes will be discussed with you.
💖 I appreciate your help in making this project better!
## 📄 License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## 👥 Contributors
Thanks go to these wonderful people for their contributions:
[bot-invite]: https://discord.com/oauth2/authorize?client_id=1030698369435320350
[version-shield]: https://img.shields.io/github/package-json/v/theassassin0128/Node?style=for-the-badge
[version-shield-link]: https://github.com/theassassin0128/Node
[contributors-shield]: https://img.shields.io/github/contributors/theassassin0128/Node?style=for-the-badge
[contributors-url]: https://github.com/theassassin0128/Node/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/theassassin0128/Node?style=for-the-badge
[forks-url]: https://github.com/theassassin0128/Node/network/members
[stars-shield]: https://img.shields.io/github/stars/theassassin0128/Node?style=for-the-badge
[stars-url]: https://github.com/theassassin0128/Node/stargazers
[issues-shield]: https://img.shields.io/github/issues/theassassin0128/Node?style=for-the-badge
[issues-url]: https://github.com/theassassin0128/Node/issues
[support-shield]: https://img.shields.io/discord/1054284394791178291?logo=discord&colorB=7289DA&style=for-the-badge
[support-server]: https://discord.gg/E6H9VvBdTk
[license-shield]: https://img.shields.io/github/license/theassassin0128/Node?style=for-the-badge
[license-url]: https://github.com/theassassin0128/Node/blob/master/LICENSE
[codeql]: https://img.shields.io/github/actions/workflow/status/theassassin0128/Node/codeql.yml?style=for-the-badge&logo=github&label=Codeql
[codeql-url]: https://github.com/theassassin0128/Node/actions/workflows/codeql.yml
[dependency-review]: https://img.shields.io/github/actions/workflow/status/theassassin0128/Node/dependency-review.yml?style=for-the-badge&label=Dependency%20Review&logo=github
[dependency-review-url]: https://github.com/theassassin0128/Node/actions?query=workflow%3A%22Dependency+Review%22
[code-factor]: https://img.shields.io/codefactor/grade/github/theassassin0128/node?logo=codefactor&logoColor=%23F44A6A&style=for-the-badge
[code-factor-url]: https://www.codefactor.io/repository/github/theassassin0128/node