Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tobyg74/chisatobot
Chisato BOT is a WhatsApp BOT that uses a library from Baileys
https://github.com/tobyg74/chisatobot
baileys baileys-bot wa-bot whatsapp whatsapp-api whatsapp-bot whatsapp-md
Last synced: about 1 month ago
JSON representation
Chisato BOT is a WhatsApp BOT that uses a library from Baileys
- Host: GitHub
- URL: https://github.com/tobyg74/chisatobot
- Owner: TobyG74
- License: gpl-3.0
- Created: 2020-11-09T12:23:43.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-23T15:23:45.000Z (7 months ago)
- Last Synced: 2024-10-01T07:41:31.625Z (about 1 month ago)
- Topics: baileys, baileys-bot, wa-bot, whatsapp, whatsapp-api, whatsapp-bot, whatsapp-md
- Language: TypeScript
- Homepage:
- Size: 319 KB
- Stars: 138
- Watchers: 15
- Forks: 255
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ChisatoBOT
This bot uses a library from Baileys
Give this repository a ⭐ if you like it
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![GPL3 License][license-shield]][license-url]
[![JOIN WITH OUT COMMUNITY][community-shield]][community-url]
## Description
- Chisato is a WhatsApp bot with various functions
- There are various features available on Chisato BOT
- ChisatoBOT has a beautiful terminal logger
- Full Installation Tutorial [Click Here](https://mega.nz/file/Qjs0mK5a#eHw6I57tqKks8H_7SJ3gLICY849801Hg3LxJuSIL2mw)
## Table of Contents
- [Getting Started](#getting-started)
- [Build With](#build_with)
- [Installation](#installation)
- [Documentation](#documentation)
- [Community](#community)
## Getting Started
What is needed to run this project :
- [GIT](https://git-scm.com/downloads)
- [NodeJS version 16+](https://nodejs.org/en/)
- [FFMPEG](https://ffmpeg.org/download.html)
- [WEBP](https://storage.googleapis.com/downloads.webmproject.org/releases/webp/index.html)
- You need a Chinese Proxy for the Image to Anime feature
- You need the [OCR Space API KEY](https://ocr.space) to run the OCR feature
If you have problems, you can [open an issue](https://github.com/TobyG74/ChisatoBOT/issues) or join the community to ask questions about it
### Setup Your Mongodb
- Login to the [MongoDB](https://account.mongodb.com/account/login) website
- Create your Database
- Next, select the Database that you created again or click (Database > Connect > Drivers > Copy Your Application Code)
- Paste the mongodb code that you copied into the .env file and don't forget to change `` to your database password
### Setup Your `.env` File
- Edit your [.env](https://github.com/TobyG74/ChisatoBOT/blob/master/.env.example) file
- Rename `.env.example` to `.env`
## Built With
## Installation
### Clone this Project
```
git clone https://github.com/TobyG74/ChisatoBOT
cd ChisatoBOT
```
### Install Dependencies
```
npm install
```
### Setup Prisma
```
npx prisma db push
```
### Build Project
```
npm run build
```
### Run Project
- Run with PM2
```
npm run pm2:start
```
- Without PM2
```
npm start
```
---
## Documentation
### Configuration File [config.json](https://github.com/TobyG74/ChisatoBOT/blob/master/config.json)
- `ownerNotifyOnline` to send a message to the Owner whenever the Bot is Online
- `useLimit` for limit configuration, if `true` then every time the command will use the limit
- `useCooldown` for cooldown configuration, if `true` then every time the command will use the cooldown
```json
{
"ownerNumber": ["YOUR_NUMBER"],
"teamNumber": [],
"timeZone": "Asia/Jakarta",
"prefix": ".",
"maintenance": [], // List Maintenance Command
"stickers": {
"author": "Instagram : ini.tobz",
"packname": "Made by ChisatoBOT"
},
"settings": {
"ownerNotifyOnline": false,
"selfbot": false,
"useLimit": false,
"useCooldown": true,
"autoReadMessage": true,
"autoReadStatus": true
},
"call": {
"status": "reject" // reject, block, off
},
"limit": {
"command": 30
},
"cfonts": {
"font": "block",
"align": "center",
"colors": ["green", "yellow"],
"background": "transparent",
"letterSpacing": 0,
"lineHeight": 0,
"space": true,
"maxLength": "0",
"gradient": false,
"independentGradient": false,
"transitionGradient": false,
"env": "node"
}
}
```
### Config Commands
- Command configuration that you can use
```ts
type ConfigCommands = {
name: string;
alias: string[];
usage: string;
category: string;
description: string;
cooldown?: number; // in seconds
limit?: number;
example?: string;
isOwner?: boolean;
isTeam?: boolean;
isPrivate?: boolean;
isPremium?: boolean;
isGroup?: boolean;
isGroupAdmin?: boolean;
isGroupOwner?: boolean;
isBotAdmin?: boolean;
isProcess?: boolean;
run: (args: CommandsObject) => unknown;
};
```
### Maintenance Command
- To change the command to maintenance status, just type : `.commandname -m`
- To change it again, type the same command
### Log Messages for those affected by Banned or Blocked
### Log Messages for Groups that are Muted
### Log Messages for Commands in Group Chat
### Log Messages for Commands in Private Chat
### Log Messages for Regular Messages
### Log Messages for Eval & Exec Message
---
## Community
- Special thanks to the bot community below who helped develop ChisatoBOT
TobyG74
Arugaz
Nugraizy
Zennn08 (Aqul)
MRHRTZ
Mhankbarbar
ItzNgga
xbnfz01
Faiz Bastomi
Alphanum404
DutaKey
- Special Thanks for My Teams
[contributors-shield]: https://img.shields.io/github/contributors/TobyG74/ChisatoBOT.svg?style=for-the-badge
[contributors-url]: https://github.com/TobyG74/ChisatoBOT/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/TobyG74/ChisatoBOT.svg?style=for-the-badge
[forks-url]: https://github.com/TobyG74/ChisatoBOT/network/members
[stars-shield]: https://img.shields.io/github/stars/TobyG74/ChisatoBOT.svg?style=for-the-badge
[stars-url]: https://github.com/TobyG74/ChisatoBOT/stargazers
[issues-shield]: https://img.shields.io/github/issues/TobyG74/ChisatoBOT.svg?style=for-the-badge
[issues-url]: https://github.com/TobyG74/ChisatoBOT/issues
[license-shield]: https://img.shields.io/github/license/TobyG74/ChisatoBOT.svg?style=for-the-badge
[license-url]: https://github.com/TobyG74/ChisatoBOT/blob/main/LICENSE
[community-shield]: https://img.shields.io/badge/JOIN%20WITH%20OUR%20COMMUNITY-FFFFFF?style=for-the-badge&logo=whatsapp&logoColor=0FB830
[community-url]: https://whatsapp.com/channel/0029VaGQpAOKAwEfkKNh6Z0X
