An open API service indexing awesome lists of open source software.

https://github.com/exonymos/krabby-discord-bot

Krabby-kun, is a bot that is designed to be a fun and interactive.
https://github.com/exonymos/krabby-discord-bot

bot discord discord-bot discord-bots discord-js

Last synced: about 2 months ago
JSON representation

Krabby-kun, is a bot that is designed to be a fun and interactive.

Awesome Lists containing this project

README

        

# Krabby-kun

My discord bot, Krabby-kun, is a bot that is designed to be a fun and interactive. It is made with [discord.js](https://discord.js.org/).

[![GitHub license](https://img.shields.io/github/license/Exonymos/krabby-discord-bot)](https://github.com/Exonymos/krabby-discord-bot/blob/main/LICENSE)
[![GitHub issues](https://img.shields.io/github/issues/Exonymos/krabby-discord-bot)](https://github.com/Exonymos/krabby-discord-bot/issues)
[![GitHub last commit](https://img.shields.io/github/last-commit/Exonymos/krabby-discord-bot)](https://github.com/Exonymos/krabby-discord-bot/commits/main)

[![GitHub stars](https://img.shields.io/github/stars/Exonymos/krabby-discord-bot)](https://github.com/Exonymos/krabby-discord-bot/stargazers)
[![GitHub forks](https://img.shields.io/github/forks/Exonymos/krabby-discord-bot)](https://github.com/Exonymos/krabby-discord-bot/network)

## Table of Contents

- [krabby-kun](#krabby-kun)
- [Table of Contents](#table-of-contents)
- [About](#about)
- [Features](#features)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Running the Bot](#running-the-bot)
- [Contributing](#contributing)
- [License](#license)

## About

Krabby-kun is a Discord bot designed to be fun and interactive. It offers a variety of commands for entertainment, moderation, and utility purposes. The bot is built using [discord.js](https://discord.js.org/), a powerful library for interacting with the Discord API.

(back to top)

## Features

- **Fun Commands**: Play games, get random jokes, and more.
- **Moderation Tools**: Kick, ban, timeout users, and purge messages.
- **Utility Commands**: Get user avatars, create embeds, and check bot latency.
- **Interactive Responses**: Dynamic and engaging responses to user interactions.

(back to top)

## Getting Started

To get a local copy up and running, follow these simple steps:

### Prerequisites

- Node.js
- A Discord bot token. You can get one by creating a bot on the [Discord Developer Portal](https://discord.com/developers/applications).

### Installation

1. Clone the repo:
```sh
git clone https://github.com/Exonymos/krabby-discord-bot
```
2. Navigate to the project directory:
```sh
cd krabby-discord-bot
```
3. Install npm packages:
```sh
npm install
```
4. Create a `.env.local` file in the root directory and add the following:
```env
GUILD_ID=YOUR_GUILD_ID
CLIENT_ID=YOUR_CLIENT_ID
TOKEN=YOUR_BOT_TOKEN
```

### Running the Bot

1. Start the bot in development mode:
```sh
npm run dev
```
2. Or start the bot in production mode:
```sh
npm start
```

(back to top)

## Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

(back to top)

## License

Distributed under the MIT License. See [LICENSE](https://github.com/Exonymos/exonymos.me/blob/main/LICENSE) for more information.

(back to top)