Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jstnmcbrd/discord-cleverbot

Chatbot for Discord
https://github.com/jstnmcbrd/discord-cleverbot

ai bot chatbot discord discord-js

Last synced: about 2 months ago
JSON representation

Chatbot for Discord

Awesome Lists containing this project

README 

        
# discord-cleverbot



[![API status](https://img.shields.io/github/actions/workflow/status/IntriguingTiles/cleverbot-free/api.yml?logo=github&label=API%20status)](https://github.com/IntriguingTiles/cleverbot-free/actions/workflows/api.yml)

[![Validate](https://img.shields.io/github/actions/workflow/status/JstnMcBrd/discord-cleverbot/validate.yml?logo=github&label=Validate)](https://github.com/JstnMcBrd/discord-cleverbot/actions/workflows/validate.yml)



## About



`discord-cleverbot` is a [Discord](https://discord.com/) bot that allows users to interact with the [Cleverbot chat bot](https://www.cleverbot.com/) on Discord. It is developed in [TypeScript](https://www.typescriptlang.org/) and relies on the [Node](https://nodejs.org/) module of [cleverbot-free](https://www.npmjs.com/package/cleverbot-free).



The project was started in December 2017 and has been completely rewritten several times to improve functionality, efficiency, modernity, and simplicity.



## Licensing



Without a specific license, this code is the direct intellectual property of the original developer. It may not be used, copied, modified, or shared without explicit permission.

Please see [GitHub's guide on licensing](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository) and [choosealicense.com](https://choosealicense.com/no-permission/).



For legal reasons, if you choose to contribute to this project, you agree to give up your copyright and hand over full rights to your contribution. However, you will still be attributed for your work on GitHub. Thank you!



## Getting started



### Creating a bot



- Create a new bot account in the [Discord Developer Portal](https://discord.com/developers/applications/).

- Copy the access token of your bot for later.



### Setting up the code



- You will need an environment with [Node](https://nodejs.org/en/download) installed (or use the Dev Container - see the [Development](#development) section below).

- Run `git clone https://github.com/JstnMcBrd/discord-cleverbot.git` to clone the repo.

- Create a new file called `.env` and add your access token, using [`.env.example`](./.env.example) as an example.



### Running the code



- In the top directory, run `npm install` to download all necessary packages.

- Run `npm run build` to build the project.

- Run `npm run commands` to register slash commands with Discord.

- Run `npm start` to start the bot.



### Interacting with the bot



- In the **OAuth2**>**URL Generator** tab in the Discord Developer Portal, generate an invite URL with the `applications.commands` scope.

- Use the invite URL to add the bot to a server.

- Use the `/whitelist` command in a channel to allow the bot to speak there.

- Send messages in the whitelisted channel and watch the bot respond!



## Development



[Visual Studio Code](https://code.visualstudio.com/) is the recommended IDE for development. All settings are included as artifacts in the [`.vscode`](./.vscode) folder and will automatically apply. You can use the built-in debugger and set breakpoints to troubleshoot the code.