Skip to content
/ Quirk Public

Quirk, πŸ€– A modular WhatsApp bot, πŸ“± which provides you with a database using prisma πŸ“Š and an unstable web-socket connection via node.js 🌐 all this so you can create your commands πŸ’¬ and make new implementations with a simple architecture πŸ› οΈ

License

Notifications You must be signed in to change notification settings

Polabiel/Quirk

Repository files navigation


Quirk β€” Whatsapp Bot

Quirk

Music, Moderation, Fun, and Customizable.

Overview β€’ Installation β€’ Plugins β€’ Community β€’ License

Overview

Quirk is a fully modular bot - meaning all features and commands can be toggled on/off to your liking, making it fully customizable.

Installation is easy, and you DON'T need to know anything about coding! Apart from installation and updates, all parts of the bot can be controlled via Whatsapp.

Installation

Installation requires node.LTS

Which means you can download the following platforms supporting Node.LTS:

If after reading the guide you still encounter issues, feel free to join the Official Discord Server and ask for help in the #Support channel.

Community

Quirk is under continuous development and is supported by an active community that produces new content (functions/plugins) for everyone to enjoy. New features are constantly being added. You can join us here in my Discord community.

Termux

For those who have difficulty using Termux, here's a very basic tutorial.

  1. Install the F-Droid app

F-Droid is a library of Android apps, similar to the Play Store. The difference is that F-Droid is exclusive to open-source apps.

What is F-droid

As it's an app outside the Play Store, you may need to allow some permissions during the installation process.

  1. Install Termux

Open F-Droid, search for Termux, and click install. Termux is a powerful terminal emulator and Linux environment for Android. It allows the installation of various packages (like Node.js) using the apt and pkg libraries.

  1. Install Node.js

Open Termux. We'll use the apt library to install Node.js. But before that, let's update the library. Enter the following commands:

apt update
apt upgrade

If there's any prompt during installation, just press Enter.

To install Node.js, enter the command:

apt install nodejs

Termux Terminal

After installation, we can run Node on our Android device.

Termux Terminal

Then just start by typing the command

npm i && npm run build && npm run start

License

The creation of Quirk was done by Gabriel Oliveira, if you wish to use the project, please leave the credits. MIT

About

Quirk, πŸ€– A modular WhatsApp bot, πŸ“± which provides you with a database using prisma πŸ“Š and an unstable web-socket connection via node.js 🌐 all this so you can create your commands πŸ’¬ and make new implementations with a simple architecture πŸ› οΈ

Topics

Resources

License

Security policy

Stars

Watchers

Forks