https://github.com/cookiecord/cookiecord

[old, unmaintained] Cookiecord is an experimental discord bot framework built in TypeScript using decorators.
https://github.com/cookiecord/cookiecord

discord discord-bot discord-js hacktoberfest typescript

Last synced: 6 days ago
JSON representation

[old, unmaintained] Cookiecord is an experimental discord bot framework built in TypeScript using decorators.

• Host: GitHub
• URL: https://github.com/cookiecord/cookiecord
• Owner: cookiecord
• License: lgpl-3.0
• Created: 2019-08-15T12:58:53.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-07-23T23:43:47.000Z (5 months ago)
• Last Synced: 2024-12-12T02:04:02.948Z (14 days ago)
• Topics: discord, discord-bot, discord-js, hacktoberfest, typescript
• Language: TypeScript
• Homepage: https://cookiecord.js.org
• Size: 737 KB
• Stars: 60
• Watchers: 3
• Forks: 5
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cookiecord

Cookiecord simplifies discord bot development by providing a modern and easy to use interface.

Just import Cookiecord and Discord.js and make your commands (and listeners):

[`example/ping.ts`](https://github.com/cookiecord/cookiecord/blob/master/example/ping.ts)

```ts

import { Message } from "discord.js";

import { command, default as CookiecordClient, Module } from "cookiecord";

class PingModule extends Module {

    constructor(client: CookiecordClient) {

        super(client);

    }

    @command()

    ping(msg: Message) {

        msg.reply("Pong. :ping_pong:");

    }

}

new CookiecordClient().registerModule(PingModule).login(process.env.TOKEN);

```

## Features

-   Simple: Cookiecord aims to keep the API very simple and easy to use.

-   Inhibitors: Cookiecord includes a powerful inhibitor system with builtin inhibitors to make restricting commands super easy.

-   Powerful Argument System: Cookiecord automatically validates the user's input based on the types of the arguments your function takes in.

-   Super Fast Development: Cookiecord can automatically reload all of your commands and listeners (using `CookiecordClient#reloadModulesFromFolder`).

## Installation

If you would like to help test Cookiecord you can make a new cookiecord project with the generator:

```sh

# With Yarn

$ yarn global add cookiecord-generator

# or with NPM

$ npm install -g cookiecord-generator

# And now to make the project:

$ cookiecord-generator generate my-first-bot

```

## Contribute

Pull requests are always welcome but I would like Cookiecord to remain simple so you should probably ask me about it first.

## Support

If you are having issues, please let us know.

We have a support chat on [Discord](https://discord.gg/ubPbX98).

## License

The project is licensed under the LGPL-3 license.