README.md

THIS PROJECT HAS BEEN ARCHIVED

Python based discord bot built to add fun to the guild with memes, provide wisdom with book-recommendations along with XP rating system with TEARS currency.

A discord bot wrapped around the theme of tears and crying. In concept, the idea is absurd but that's more of a reason to make this. :) The bot uses tears as an economy and you can "cry" to get daily credit tears.

NOTE- It is recommended that you add your own discord token while running the bot.

How to test the bot before running it on your server

To test the bot join the Support Server [NOTE- Bot is not active 24x7 as it is hosted on heroku. To get a sample, join TearDropsSupport and ping @Tissue]

How to run the bot on your own server

Invite the bot to your server [NOTE- The bot is still in v0.2.0 and is being constantly updated and bug fixed. Inviting this, might have unintentional complications. If you really want the bot, open an issue so that we can provide a Beta Version to you that is stable and updated slowly]

Hosting the bot locally:

NOTE: To replicate this bot, you will need a bot token. Go get yours at https://discord.com/developers/ (If you need help with this step, feel free to ask for help in our Support Server).

• Clone this repo using git clone
• cd into the bot folder.
• Add the token in a .env file in the project root as follows:

DISCORD_BOT_TOKEN=<your token>

• Install docker and docker-compose and then run:

docker-compose up

• Enjoy! (don't forget to add your own bot into your discord server by generating an invite link from the discord developers application page in OAuth2 section and choose application and check Oauth2 section)
• To stop this instance of the bot, run docker-compose down
• You may do bug-reporting or ask for help in on the SupportServer... or just open an issue on this repo.

How to contribute

Before contributing, here is some information that might help your PR (Pull Request) get merged.

How to set up the development environment

Requirements:

• git
• pip
• python 3.8.1 or higher

1. Fork and clone the repository with git clone https://github.com/<your-username>/TearDrops
2. Get to the clone directory using the command cd Teardrops
3. Copy the contents of the .env.sample file into a new file - .env and add your DISCORD bot token in there.
4. There are two ways to do further setup, pipenv or via docker:
   DOCKER METHOD:
   - Install docker and docker-compose
   - Run the command: docker-compose up
   OR
   THE TRADITIONAL METHOD:
   (Requires pipenv) - Install pipenv
   - Add the mongo connection URI in the .env file
   - Run pipenv sync --dev to install project dependencies and development dependencies
   - Run pipenv run start to run the bot.
   - Run pipenv run lint to lint the code.
   - For downloading more libraries, use pipenv install <package-name>
   - If you're adding any development-dependencies, use-> pipenv install <package-name> --dev\

Requirements:

• python 3
• discord(rewrite branch)
• asyncio(inbuilt with python3.4)
• wikipedia
• aiohttp
• motor(asynchronous client for mongodb)
• dnspython

Contributors ✨

Thanks goes to these wonderful people (emoji key):

All Contributors 📖	Vyom Jain 💻 📆 🎨 📖 🚧 👀	Anubhav 💻 📖 🤔 🚇	Gamerrio 🤔 💻 🎨	Rascal_Two 🐛 💻 🤔	Sayan Dutta 🤔 💻 🎨	Nicholas Carrigan (he/him) 🤔 📖
Michael Mba 🤔	Allan Regush 🤔 📖	Matt (IPv4) Cowley 🤔	Alex Nørgaard 🤔	Nitesh Kumar 💻	TJ LeBlanc 💻	s04 🤔
Rayn Islam 🐛 🤔	Akshaya 🐛	Jay 🤔 📖 🐛	mstanciu552 📖	Utkarsh Singh 🤔 📖	Sreekaran Srinath 📖	Souhit Dey 📖
Karuna Tata 🎨

This project follows the all-contributors specification. Contributions of any kind welcome!