├── Chat_Bot_Url.md ├── Heroku-Deploy-Guide.md ├── Mongo-Atlas-guide.md ├── README.md ├── Self-hosting-guide.md └── Sticker-feature-Guide.md /Chat_Bot_Url.md: -------------------------------------------------------------------------------- 1 | # Chatbot 🔰 2 | ### Follow the instructions:- 3 | 1. Go to [brainshop](http://brainshop.ai)
4 | 2. Click on SIGNUP and enter all the fields asking for 5 | PS: Domain name can be anything (ex-google.com) 6 | 3. Create an account and name the brain anything u like>_<.
7 | 4. Go to settings in your account and copy the api url. 8 | ##Example[Api url] 9 | http://api.brainshop.ai/get?bid=[bid]&key=[key]&uid=[uid]&msg=[msg]
10 | 5. Paste it in your heroku app and deploy🔥💖.
11 | 12 | That's it! You can make your own chatbot api. You can use this api for other projects as well. 13 | 14 | ## 👁️‍🗨️A BOT WITH A BRAIN ROCKS! Úwù 15 | -------------------------------------------------------------------------------- /Heroku-Deploy-Guide.md: -------------------------------------------------------------------------------- 1 | # Heroku Deploy Guide 2 | ## Chitoge 💙
3 | ### Pre-requisite 4 | - 🌐️ Internet 🌐️️ 5 | - 🧠️ Brain 🧠️ 6 | - 🎵️ Music 🎵️ 7 | - 💫 Chill 💫 8 | 1. [Chitoge](https://github.com/ShineiIchijo/Chitoge) - Go there 9 | 2. Scroll down a bit and you will see the "Deploy To Heroku" button in purple color (sorry if you are color blind) 10 | 3. Click on it and login or sign up for Heroku 11 | 4. Enter the following fields 12 | | KEY | VALUE | 13 | | --- | ----------- | 14 | | BOTNAME | Chitoge | 15 | | CHAT_BOT_URL | 'Instructions below for getting url' | 16 | | CRON | 'null' | 17 | | GOOGLE_API_KEY | 'Read below to get the API Key | 18 | | PREFIX | : | 19 | | SESSION | Any text you want but make sure to remember and don't share it | 20 | | MODS | | 21 | | MONGO_URI | YOUR CLUSTER URI | 22 | | TENOR_API_KEY | Read below to get the API Key | 23 | | GENIUS_KEY | Read below to get the API Key | 24 | 25 | `CHAT_BOT_URL` A BOT WITH A BRAIN ROCKS! Click=> [Get ChatBot Url](https://github.com/ShinNouzen/Chitoge-Guides/blob/main/Chat_Bot_Url.md)
26 | `CRON` Cron schedule for clearing all chats (Default: `"0 */6 * * *"`. Every 6 Hours). change this field to `null` if you don't want to schedule. [Learn More](https://www.npmjs.com/package/node-cron)
27 | `GOOGLE_API_KEY` Custom Search JSON API requires the use of an API key. [Get API key here](https://developers.google.com/custom-search/v1/introduction). After getting the API key, insert it while deploying on HEROKU.
28 | `PREFIX` The Prefix of the Bot
29 | `SESSION` A string to keep track of your session.
30 | `MODS` The phone numbers of users who you want to be the bot's Admins separated by a comma and must the numbers must be in the following format: `[cc][number]`. eg: `919744******`
31 | `MONGO_URI` is the Connection URL to your DB ([Mongo-Atlas-Guide](https://github.com/ShinNouzen/Chitoge-Guides/blob/main/Mongo-Atlas-guide.md))
32 | `TENOR_API` is the key for gif searches. Get ur apikey [here.](https://tenor.com/developer/keyregistration) 33 | `GENIUS_KEY` is key for search song lyrics. Get ur apikey [here.](https://genius.com/api-clients#) 34 | 5. Wait for the building to finish, you should always keep an eye on log messages, you can find log messages in the Dashboard -> More -> View logs.
35 | 6. After it builds, click on the "View" or "Open App".
36 | 7. Authenticate By Providing Your SESSION_ID and a QR Code Will Show Up.
37 | 8. Open WhatsApp on your phone -> Click on the 3 Dots on the top Right -> Click on WhatsApp Web -> Click on "Link a Device" and scan the QR from the previous step.
38 | 9. Your heroku app can fall asleep so for keeping it awaken add your app to ([Kaffeine](https://kaffeine.herokuapp.com/))
. It pings your Heroku app every 30 minutes so it will never go to sleep.
39 | 10. Profit! Ultimate! 40 | 41 | ### 😼️ Enjoy and make sure to study! 42 | ### 🐼 More Indeed features Soon! 43 | ### ⭐️ Do not forget to give it a Star! 44 | -------------------------------------------------------------------------------- /Mongo-Atlas-guide.md: -------------------------------------------------------------------------------- 1 | ## 💚️ Mongo Atlas Guide 2 | ----------------- 3 | 1. Go to [MongoDB cloud atlas](https://www.mongodb.com/cloud/atlas) 4 | 5 | 2. Sign up if you don't have an account already or log in if you have one already. 6 | PS: If you don't want to use your email, go to https://temp-mail.org/en/ and generate a temporary disposable email address uwu)/ 7 | 3. Create a new cluster on Mongo Atlas. [It takes time, so don't worry] 8 | 4. After creating a cluster, click on the 'CONNECT' button on the cluster which you've created. 9 | 5. On Setup connection security, I'd recommend you to add 'Your Current IP Address' for security concerns but if you are not willing to go through a little bit of pain, then simply add 'Access from anywhere. Also, you can change this anytime by opening your "IP Access list tab". 10 | 6. Then, create a database user, fill up the name and password and MAKE SURE TO REMEMBER THEM. 11 | 7. Click on the "Choose a connection method" and then click on the "Connect Your Application" option. 12 | 8. Finally, on the "Connect" tab select "Nodejs" as _DRIVER_ with "3.6 or later" in _VERSION_. 13 | 9. Copy the connection string that is provided below and paste it somewhere and replace with 'the password you added while creating database user', also make sure to remove '< >' these from . This will be your _MONGO CLUSTER URI_. 14 | #### Example [Mongo Atlas Cluster URI] 15 | ```mongodb+srv://NekoDaKamiSama:kamisamaofdaculture@cluster0.v93qb.mongodb.net/myFirstDatabase?retryWrites=true&w=majority``` 16 | 17 | 10. That's it You now have a MongoDB cluster hosted on Mongo-Atlas. You can use this cluster for other projects too. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | whatsapp-botto-void-init 2 | # Chitoge Hosting/Deploy Guides 3 | 4 | ## 💻 [Self-Hosting-Guide](https://github.com/ShinNouzen/Chitoge-Guides/blob/main/Self-hosting-guide.md) 5 | ## ☁️ [Heroku-Deploy-Guide](https://github.com/ShinNouzen/Chitoge-Guides/blob/main/Heroku-Deploy-Guide.md) 6 | ## 💚 [Mongo-Atlas-Guide](https://github.com/ShinNouzen/Chitoge-Guides/blob/main/Mongo-Atlas-guide.md) 7 | ## 💫 [Sticker-feature-Guide](https://github.com/ShinNouzen/Chitoge-Guides/blob/main/Sticker-feature-Guide.md) 8 | ## 🔰 [ChatBot_Url_Guide](https://github.com/ShinNouzen/Chitoge-Guides/blob/main/Chat_Bot_Url.md) 9 | 10 | -------------------------------------------------------------------------------- /Self-hosting-guide.md: -------------------------------------------------------------------------------- 1 | # Chitoge Self-hosting Guide 2 | 3 | 4 | ## ⛵ Prerequisites 5 | 6 | - [Git](https://git-scm.com/) 7 | - [Node.JS](https://nodejs.org/en/) 8 | - [WebP](https://developers.google.com/speed/webp/download) 9 | - [FFMpeg](https://ffmpeg.org/download.html) 10 | - [ImageMagick-Legacy](https://imagemagick.org/index.php) 11 | 12 | ## 🍀 Installation 13 | 14 | Run the following code to clone the repo 15 | ```SH 16 | > git clone https://github.com/Synthesized-Infinity/Whatsapp-Botto-Void 17 | > cd Whatsapp-Botto-Void 18 | ``` 19 | Run this to install the depencencies 20 | 21 | ```SH 22 | > npm i && npm i -D 23 | ``` 24 | or 25 | ```SH 26 | > npm ci 27 | ``` 28 | ## ✍ Configuration 29 | 30 | Create a file named `.env` then add the following fields 31 | 32 | ```env 33 | PREFIX=: 34 | SESSION=SESSION_ID 35 | MODS=NUMEBRS_SEPERATED_BY_COMMA 36 | MONGO_URI=YOUR_CLUSTER_URI 37 | ``` 38 | `PREFIX` The Prefix of the Bot
39 | `SESSION` A string to keep track of your session. 40 | `MODS` The phone numbers of users wo you want to be the bot's Admins separated by a comma and must the numbers must be in the following format: `[cc][number]`. eg: `919744******`
41 | `MONGO_URI` is the Connection URL to your DB 42 | To get the connection URL there are two ways 43 | 44 | #1 [Mongo Atlas](http://mongodb.com/cloud/atlas) and create an account \ 45 | After you set up your account create a new Cluster \ 46 | Then copy the connection url to your cluster 47 | ([Mongo-Atlas-Guide](https://github.com/Synthesized-Infinity/Void-Guides/blob/main/Mongo-Atlas-guide.md)) 48 | 49 | #2 If you don't want to use Mongo Atlas you can install MongoDB in your system and use the URI provided in `.env.example` 50 | Follow the instructions [here](https://docs.mongodb.com/manual/installation/) to install MongoDB in your system 51 | 52 | `EIF` is the main endpoint of the [Express-is-fun APIs](https://express-is-fun.herokuapp.com/api). \ 53 | If you want the chatbot functionality add this url there: `https://express-is-fun.herokuapp.com`. Leave it empty if you don't want the chatbot functionality 54 | 55 | `ADMIN_GROUP_JID` If this field is provided, the members of this group will automatically become admins (use the command `id` to get the jid) 56 | 57 | ## ⌨ Building 58 | 59 | Run `npm run build` and the Compiled JS files, Deceleration Files, Maps and Declaration Maps with their folder will appear in the `dist` folder 60 | 61 | ## 💻 Running 62 | 63 | ```SH 64 | npm start 65 | ``` 66 | Running the above command will start the bot. 67 | To authenticate scan the QR which shows up in the terminal or the link which is logged when the QR event fires using the WA-Web Scanner on your WhatsApp. 68 | Now you're on your own. Good Luck! 69 | 70 | ## Don't want to do the hassle of setting up on your own PC? 71 | [Set it up on Heroku](https://github.com/ShinNouzen/Chitoge-Guides/blob/main/Heroku-Deploy-Guide.md) 72 | -------------------------------------------------------------------------------- /Sticker-feature-Guide.md: -------------------------------------------------------------------------------- 1 | # 💫Sticker 2 | 3 | 💫Sticker command is now updated. You can use 4 | sticker --number to get sticker in different qualities.
5 | *note* : number must be *between 1-100* else it'll be set to default 50 value.
6 | 7 | Use case : If normal &sticker command doesn't work because the gif is too big. You can try &sticker with lower quality. like &sticker --1 8 | or vice versa.
9 | 10 | Example command :
11 | &sticker --1
12 | &sticker --crop --1
13 | &sticker --c --50
14 | &sticker --s --40
15 | 16 | ### Note:
17 | That here --c crops the sticker into square
18 | and --s stretches it.
19 | 20 | Also, 21 | 22 | &sticker --love --crop --70
23 | &sticker --happy --40
24 | 25 | here --love --happy organizes the sticker into the Whatsapp's inbuilt emoji pack 26 | ( as per the photo :) 27 | --------------------------------------------------------------------------------