Skip to content

Latest commit

 

History

History
35 lines (23 loc) · 1.28 KB

README.md

File metadata and controls

35 lines (23 loc) · 1.28 KB

Bot-Template

A cookiecutter template for a discord bot with NAFF made by Kigstn

Made for users to get started making discord bot easier.

Features

  • Basic, ready to go bot
  • Implementation of best practises
  • Scales, and general extensibility
  • Example command, context menu, component, and event
  • Logging to both console and file
  • Pip and poetry config
  • Pre-commit config
  • Dockerfile and pre-made docker-compose

Installing

To install the template and get started making your own discord bot, run:

  1. pip install cookiecutter
  2. cookiecutter https://github.com/Discord-Snake-Pit/Bot-Template

Arguments

  • project_name: The name of your project
  • project_slug: A formatted version of your project name, which is used as a filepath and for the docker container names
  • license: What license your project should have. Can be safely ignored should you not plan on openly publishing this project on the internet
  • license_organization: The name that should appear on the license
  • load_debug_commands: If some helpful debug commands should be loaded. These will only be accessible to the owner of the bot
  • discord_token: Your discord bot token. This will not be pushed if you use this project with git