https://github.com/azusfin/sapphire-bot-template

A template repository for discord bot made with sapphire framework
https://github.com/azusfin/sapphire-bot-template

Last synced: 12 months ago
JSON representation

A template repository for discord bot made with sapphire framework

• Host: GitHub
• URL: https://github.com/azusfin/sapphire-bot-template
• Owner: Azusfin
• License: gpl-3.0
• Created: 2022-02-28T06:00:20.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-03-02T04:26:23.000Z (over 4 years ago)
• Last Synced: 2024-12-31T02:43:57.778Z (over 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 48.8 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
**[sapphire](https://npmjs.com/package/@sapphire/framework) bot template**

### File Hierarchy

- `package.json` - configuration file for project

- `config_example.yml` - example of config file

- `config.yml` - configuration file for bot

- `src/index.ts` - entry point

- `src/config.ts` - configuration file relational mapping

- `src/listeners/**` - event listeners

- `src/commands/**` - bot commands

- `src/preconditions/**` - command preconditions

- `src/lib/**` - other things

### Configurations

Bot configurations (token, prefix, ...etc) are put in `config.yml` (YAML),

you may look at `config_example.yml` for an example of the config file

- Go to `src/config.ts` to add more configurations

- Go to `src/commands/**` to create more commands

- Go to `src/listeners/**` to listen for more events

- Go to `src/lib/**` to add other things (eg. Database)

### Startup

Run in command line

- `npm run build`

- `npm start`

## Do what you want as you like :)