https://github.com/wonderlandpark/dokdo

Dokdo. Easy Discord bot debuging tool.
https://github.com/wonderlandpark/dokdo

debug debugging discord discord-js discordbot dokdo hacktoberfest

Last synced: 4 days ago
JSON representation

Dokdo. Easy Discord bot debuging tool.

• Host: GitHub
• URL: https://github.com/wonderlandpark/dokdo
• Owner: wonderlandpark
• License: mit
• Created: 2020-10-14T13:44:28.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-03-25T16:20:03.000Z (8 months ago)
• Last Synced: 2024-11-01T21:17:40.704Z (14 days ago)
• Topics: debug, debugging, discord, discord-js, discordbot, dokdo, hacktoberfest
• Language: TypeScript
• Homepage: https://dokdo.js.org
• Size: 2.86 MB
• Stars: 59
• Watchers: 2
• Forks: 23
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        









    

    





    





## About

Dokdo. Easy Discord bot debuging tool.

It's debugging tool for `discord.js` projects.

## Preview

![sh](assets/dokdo.gif)

## Installation

    Using Discord.js v12?

You could install `[email protected]` by

    

```sh

  npm i dokdo@djsv12

```

    Using Discord.js v13?

You could install `[email protected]` by

    

```sh

  npm i dokdo@djsv13

```

### Stable

```sh

npm i dokdo@latest

```

### Dev

```sh

npm i wonderlandpark/dokdo#main

```

## Features

### Shell command on stdout update

![shell](assets/dokdo.gif)

### Easy shard broadcastEval manager

![shard](assets/shard.png)

## Example usage

```js

const Discord = require('discord.js')

const client = new Discord.Client({ intents: ['GUILDS', 'GUILD_MESSAGES'] })

const Dokdo = require('dokdo')

const DokdoHandler = new Dokdo.Client(client, { aliases: ['dokdo', 'dok'], prefix: '!' }) // Using Bot Application ownerID as default for owner option.

client.on('messageCreate', async message => {

  if (message.content === 'ping') return message.channel.send('Pong') // handle commands first

  DokdoHandler.run(message) // try !dokdo

})

client.login('super secret token')

```

## Notes

### Message contents intent not approved?

You can set the Dokdo prefix including mentions. This allows the client to read the message content.

Example:

```js

new Dokdo(client, {  prefix: '<@285185716240252929>' })

// Commmand Usage: <@285185716240252929>dokdo

```

## Contributing

Please check out it hasn't already been exists before you create issue, and check [the contribution guide](./.github/CONTRIBUTING.md) before you submit Pull Request.