Skip to content

add readme #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 12, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# ModuBotDiscord

ModuBotDiscord is a modular Discord bot framework based on [ModuBotCore](https://github.com/EnderModuBot/core) and [discord.py](https://discordpy.readthedocs.io/). It enables easy development and extension of Discord bots through a flexible, extensible system.

## Features

- Modular command system
- Extendable with custom commands and views
- Permission and owner checks
- Simple configuration via environment variables

## Installation

The recommended way to install is via [PyPI](https://pypi.org/project/ModuBotDiscord/):

```bash
pip install ModuBotDiscord
```

If you want to start your own bot project, use the [ModuBotDiscord Template](https://github.com/EnderModuBot/discord-template):

```bash
git clone https://github.com/EnderModuBot/discord-template.git
cd discord-template
```

> **Note:**
> This repository contains only the source code of ModuBotDiscord and is not runnable as a bot itself.
> For your own projects, please use the template repository.

## Configuration

Create a `.env` file or set the environment variables:

```dotenv
DISCORD_TOKEN=your_discord_bot_token
DISCORD_OWNER_ID=your_user_id
```

## License

MIT License – see [LICENSE](LICENSE)
Loading