-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
75 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,75 @@ | ||
# DiscordBot | ||
# DiscordBot | ||
|
||
[![GitHub release](https://img.shields.io/github/release/RedFox-Studios/DiscordBot.svg)](https://github.com/RedFox-Studios/DiscordBot/releases) | ||
[![GitHub issues](https://img.shields.io/github/issues/RedFox-Studios/DiscordBot.svg)](https://github.com/RedFox-Studios/DiscordBot/issues) | ||
[![GitHub license](https://img.shields.io/github/license/RedFox-Studios/DiscordBot.svg)](./LICENSE) | ||
|
||
Welcome to **DiscordBot**, a customizable Discord bot developed by RedFox Studios. Designed to be flexible and efficient, this bot provides an array of commands that enhance your Discord server experience. | ||
|
||
## Table of Contents | ||
- [Features](#features) | ||
- [Installation](#installation) | ||
- [Configuration](#configuration) | ||
- [Usage](#usage) | ||
- [Contributing](#contributing) | ||
- [License](#license) | ||
|
||
## Features | ||
- 🛠️ Easily extendable commands | ||
- ⚙️ Configurable settings via `config.json` | ||
- 📜 Modular command structure | ||
|
||
## Installation | ||
To set up and run DiscordBot on your local environment, follow these steps: | ||
|
||
1. **Clone the repository:** | ||
```bash | ||
git clone https://github.com/RedFox-Studios/DiscordBot.git | ||
cd DiscordBot | ||
``` | ||
|
||
2. **Install dependencies:** | ||
```bash | ||
npm install | ||
``` | ||
|
||
3. **Configure the bot:** | ||
Edit `config.json` with your bot token and other configuration details. | ||
|
||
4. **Start the bot:** | ||
```bash | ||
node index.js | ||
``` | ||
|
||
## Configuration | ||
Edit the `config.json` file to customize bot settings, including the Discord bot token and command prefixes. Make sure to keep this file secure. | ||
|
||
Example `config.json`: | ||
```json | ||
{ | ||
"token": "BOT_TOKEN", | ||
"prefix": "!", | ||
"clientId": "CLIENT_ID" | ||
} | ||
``` | ||
|
||
## Usage | ||
The bot comes with a set of pre-configured commands found in the `commands/` directory. You can add or modify commands as needed. | ||
|
||
## Contributing | ||
We welcome contributions! Please fork the repository and create a pull request with your changes. Be sure to follow coding standards and add documentation as necessary. | ||
|
||
## License | ||
This project is licensed under the terms of the [MIT License](./LICENSE). | ||
|
||
--- | ||
|
||
### requirements.txt | ||
If it’s a **Node.js bot**, you won’t need `requirements.txt` (that’s for Python). Instead, use `package.json` to list dependencies like `"discord.js"` for Node.js bots. If you don’t have `package.json` yet, run this: | ||
|
||
```bash | ||
npm init -y | ||
npm install discord.js dotenv | ||
``` | ||
|
||
This creates `package.json` with your dependencies (which acts like `requirements.txt` in Python). Let me know if you need help setting that up! |