https://github.com/sircryptic/disframe-cogs
cog repository for the DisFrame Discord bot framework!
https://github.com/sircryptic/disframe-cogs
cog discord disframe python
Last synced: 29 days ago
JSON representation
cog repository for the DisFrame Discord bot framework!
- Host: GitHub
- URL: https://github.com/sircryptic/disframe-cogs
- Owner: SirCryptic
- License: mit
- Created: 2025-02-25T20:16:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-25T23:17:31.000Z (over 1 year ago)
- Last Synced: 2025-02-26T00:18:05.599Z (over 1 year ago)
- Topics: cog, discord, disframe, python
- Language: Python
- Homepage: https://sircryptic.github.io/DisWeb
- Size: 348 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DisFrame-Cogs
Welcome to **DisFrame-Cogs**, the community-driven cog repository for the [DisFrame Discord bot framework](https://github.com/sircryptic/disframe)! This is your hub for sharing and discovering custom cogs to enhance your DisFrame bot with new commands, games, utilities, and more—built by the community, for the community.
## What is DisFrame?
DisFrame is a modular Discord bot framework written in Python using `discord.py`. It’s designed for extensibility, allowing you to easily plug in cogs to add features like moderation tools, interactive games, or custom utilities. Learn more at the [DisFrame repo](https://github.com/sircryptic/disframe).
## Purpose
This repository hosts a growing collection of community-created cogs to supercharge your DisFrame bot. Whether you’re looking for an economy game like CoinRush or a unique server tool, you’ll find contributions here to enrich your Discord experience.
## Getting Started
### Prerequisites
- A running DisFrame bot instance (see the [Hosting Guide](https://sircryptic.github.io/DisWeb/pages/guide.html)).
- Familiarity with Python and Discord bot commands.
### Adding Cogs
Enhance your DisFrame bot with these steps:
1. **Explore Available Cogs**:
- Browse the folders in this repo (e.g., `Games/CoinRush`) to find cogs that suit your needs.
2. **Download a Cog**:
- Each cog folder contains a `.py` file (e.g., `coinrush.py`) and may include a `README.md` with instructions.
- Some cogs come with an `assets` folder for resources like images or fonts.
3. **Install the Cog**:
- Copy the `.py` file to your DisFrame bot’s `cmds/` directory (or a subfolder like `cmds/games/` for organization—DisFrame supports this).
- If an `assets` folder is included, place it in your DisFrame root directory (beside `bot.py`) to ensure resources load correctly.
4. **Run Your Bot**:
- Start your bot with `python bot.py`. The cog will load automatically.
- Refer to the cog’s `README.md` for any specific setup steps or usage commands.
## Available Cogs
Here’s a peek at some cogs you can add:
- **[CoinRush](/Games/CoinRush#readme)**: An economy game featuring jobs, items, trading, achievements, and a casino.
More cogs are on the way—contribute yours to grow the collection!
## Contributing
We welcome your contributions to make DisFrame even better! Check out our [CONTRIBUTING.md](CONTRIBUTING.md) for detailed steps on how to:
- Fork the repo and create your own cog.
- Submit a pull request with your enhancements.
- Ensure compatibility and document your work.
Join the conversation on our [DisFrame Discord](https://discord.gg/48JH3UkerX) to share ideas or get help!
## Guidelines
- **Compatibility**: Test your cog with the latest DisFrame version.
- **Documentation**: Provide a `README.md` in your cog’s folder with setup and usage details.
- **Community Spirit**: Keep contributions fun, functional, and free of malicious code.
## Resources
- **DisFrame Framework**: [github.com/sircryptic/disframe](https://github.com/sircryptic/disframe)
- **Hosting Guide**: [sircryptic.github.io/DisWeb/pages/guide.html](https://sircryptic.github.io/DisWeb/pages/guide.html)
- **Community Discord**: [discord.gg/48JH3UkerX](https://discord.gg/48JH3UkerX)
## License
This repository is licensed under the [MIT License](LICENSE) (Copyright © 2025 SirCryptic). Contributors are encouraged to use MIT for their cogs but may choose any compatible open-source license. See individual cog `README.md` files for specific licensing details.
---
**Maintained by**: SirCryptic & the DisFrame Community
**Get Involved**: Star this repo, contribute a cog, or join our community!