Skip to content

Latest commit

 

History

History
198 lines (139 loc) · 4.88 KB

README.md

File metadata and controls

198 lines (139 loc) · 4.88 KB

⭐ WALL-E 🤖 ⭐

✨ WALL-E is a WhatsApp chat bot with some cool features. ✨

⚠️ » WALL-E is still under development, feel free to contribute to this repo and leave a ⭐

🤔 What do you mean by "cool features"?:

  • Translate text;
  • Talk to Gemini AI;
  • Search on Google;
  • Speak in 5 languages;
  • Set reminders for yourself;
  • Reveal view once messages;
  • Change its prefix just for you;
  • Remove background from stickers;
  • Rank members by sent msgs count;
  • Create stickers with photos and gifs;
  • Mass delete group msgs for all members;
  • Mention all users in a group in a single msg;
  • Run code in multiple programming languages;
  • Download videos and audios from many websites;

and more.

🤔 How to install?

1 - 🛠️ Install runtimes and tools:

🪧 » Recommended version: 22 or higher

OPTIONAL TOOLS

🪧 » Recommended version: 16 or higher Database is required to use some cmds like rank/remind or to permanently save users prefix/language. but you can run it without a database.

  • FFMPEG (For gif stickers)

🪧 » Run sudo apt install ffmpeg to install it on Debian/Ubuntu

🪧 » Recommended version: 3.12 or higher

WALL-E also support these languages, but you DON'T need to install it if you won't use:

🪧 » Recommended version: 1.1.41 or higher

🪧 » Recommended version: 2.1.4 or higher

🪧 » Recommended version: 2.1 or higher

  • G++ 🔥

🪧 » Recommended version: 11.4 or higher

2 - 📁 Download or clone the repository:

# Click on "Code" > "Download ZIP" > Extract

# or
# Clone this repo
git clone https://github.com/Sunf3r/WALL-E # You need to have git installed to do this

3 - 🌿 Preparing the environment:

You can configure the bot however you want in the following files:

  • settings.json (settings/settings.json)
{
	"bot": {
		"link": "dsc.gg/wallebot", // support channel link
		"region": {
			"timezone": "America/Sao_Paulo",
			"logLanguage": "pt"
		}
	},

	"sticker": {
		"packName": ["pack", "name"], // sticker pack name
		"author": ["wall-e", "sticker maker"] // sticker author name
	},

	"db": {
		"user": {
			"prefix": ".", // default prefix to new users
			"language": "pt", // default language to new users
			"cacheLimit": 500, // max users in memory
			"msgsLimit": 200 // max msgs in memory (per user)
		},
		"group": {
			"msgsLimit": 200 // max msgs in memory (per group)
		}
	}
}
  • .env (settings/.env.example)

💡 » Open the file to set sensitive keys and rename ".env.example" to ".env" if you have a database, remove the # before DATABASE_URL and set it

3 - 🧰 Installing dependencies and starting 🚀:

💡 » Open the folder in terminal

cd WALL-E

# This script will do everything to prepare the bot for
# *the first time, but you need to do steps 1~3 first*
npm run setup
# It will: install tsc/pm2/prisma as global modules,
# install node modules,
# generate prisma schema, build source,
# create python virtual environment,
# install python dependencies,
# and >start services< with pm2

# if you have a database, this one will also push db schema
npm run setup:full

# To stop all services:
npm run stop

# To start it again:
npm start
# yea, you don't need "run" for start.
# Just "npm start" instead of "npm run start"

4 - 🔐 Log in:

Just scan the QR Code that will appear on terminal and then it's ready!

⚠️ » All logs and QR codes will appear on settings/logs/walle.log.

-1. 🗒️ Important Notes:

  • Updating:
# Stopping services
npm run stop

# You can update everything just running:
npm run update
# It will: pull commits from repository,
# update node modules, update deno and bun,
# update python dependencies, generate prisma schema,
# and rebuild source
# update won't start services.

# Starting services
npm start

⚠️ » None of these scripts will update Python, LuaJIT, PostgreSQL, G++ or GIT. You still need to do it by yourself

  • I recommend you to reset and log out WhatsApp Web sometimes to fix decrypt bugs
# Stopping services
npm run stop
# Cleaning auth, cache, temp and logs
npm run reset
# Starting all services
npm start
# Scan QR Code

  • Experiencing bugs? Open a issue with your problem or make a pull request with the solution. I will try to fix it as soon as possible.

  • This bot was made to run on Linux, but you can run it on Windows just changing script or using WSL.

  • If you need help, feel free to ask me on Discord.

I Hope you like the project :)