https://github.com/cog-creators/cog-cookiecutter
Cookiecutter template for making a cog for Red.
https://github.com/cog-creators/cog-cookiecutter
cookiecutter-template red-discordbot
Last synced: 5 months ago
JSON representation
Cookiecutter template for making a cog for Red.
- Host: GitHub
- URL: https://github.com/cog-creators/cog-cookiecutter
- Owner: Cog-Creators
- License: gpl-3.0
- Created: 2020-08-27T17:50:20.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-06-18T15:05:07.000Z (over 1 year ago)
- Last Synced: 2025-03-31T12:01:38.231Z (7 months ago)
- Topics: cookiecutter-template, red-discordbot
- Language: Python
- Homepage:
- Size: 22.5 KB
- Stars: 11
- Watchers: 4
- Forks: 7
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cookiecutter template for Red cogs
[Cookiecutter](https://github.com/audreyr/cookiecutter) template for making a cog for Red.
## Quickstart
Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 1.5.0 or higher):
```
pip install -U cookiecutter
```
Generate a cog for Red:
```
cookiecutter https://github.com/Cog-Creators/cog-cookiecutter
```
### Supported variables
The values of variables `short`, `long`, `install_msg`, and `end_user_data_statement` are put directly inside JSON string quotes, no escaping is done to the input.
- `package_name` - Name of a cog package. This is the folder name the cog will reside in and the name that will have to be used when loading the cog. This name should be lowercase.
- `cog_class_name` - Name of the cog's class. This name is shown in help and needs to be valid Python identifier. This name should be TitleCase.
- `config_identifier` - Config identifier for the cog. This is a unique identifier that will be used in Red's `Config`. We recommend using your Discord user ID.
- `short` - A short description of the cog. See [info.json format documentation](https://docs.discord.red/en/stable/guide_publish_cogs.html#info-json-format).
- `long` - A long description of the cog. See [info.json format documentation](https://docs.discord.red/en/stable/guide_publish_cogs.html#info-json-format).
- `install_msg` (optional) - The message that gets displayed when a cog is installed. See [info.json format documentation](https://docs.discord.red/en/stable/guide_publish_cogs.html#info-json-format).
- `end_user_data_statement` - A statement explaining what end user data the cog is storing. See [info.json format documentation](https://docs.discord.red/en/stable/guide_publish_cogs.html#info-json-format) and [Guidelines for Cog Creators](https://docs.discord.red/en/latest/guide_cog_creation.html#guidelines-for-cog-creators).
- `authors` - Colon-separated list of authors, e.g. "Guido van Rossum; Victor Stinner; Brett Cannon". See [info.json format documentation](https://docs.discord.red/en/stable/guide_publish_cogs.html#info-json-format).
- `tags` - Space-separated list of tags, e.g. "image tools statistics". See [info.json format documentation](https://docs.discord.red/en/stable/guide_publish_cogs.html#info-json-format).