You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Phuntsok Drak-pa 1b2b0bd1db modified link’s text 1 year ago
img added source files 1 year ago
nhentai added source files 1 year ago
.gitignore Bot’s token now relies on environment variable 1 year ago
Dockerfile tinier image 1 year ago
LICENSE Create LICENSE 1 year ago
README.md forgot to commit this file 1 year ago
README.org updated readme to support only docker-compose 1 year ago
docker-compose.yml updated readme to support only docker-compose 1 year ago
requirements.txt added source files 1 year ago
tastysauce.py modified link’s text 1 year ago

README.md

img

About

TastySauce is a Discord bot whose sole purpose is fetching metadata from the website https://nhentai.net/ when given a token between parenthesis; like so: (177013) (don’t read that one). It is inspired from the Reddit bot you can find on r/Animemes, and will later implement some similar output.

Dependencies

TastySauce depends primarily on nhentai.py, which can still be found on PyPi, but its homepage and its original repository seem to be down. If you are its author, don’t hesitate to contact me in order to add updated links to this README. I slightly modified nhentai/nhentai.py in order to get different tag categories. It also obviously depends on Discord.py which powers the bot itself, which has not been modified. The other dependencies are mainly dependencies for nhentai.py.

Invite TastySauce

Maybe you do not want to build the bot itself, but instead you just want to invite it on your server? I got you covered! You can invite the official instance of TastySauce by clicking here!

Be aware though that I cannot ensure 24/7 uptime of TastySauce. If you notice it is down, shoot me a tweet (faster), a DM (fast, P'undrak#0001) or an email (slower).

Running the project

First, you will need docker and docker-compose installed on your machine. If they aren’t installed yet, go check Docker’s or your distro’s instruction on how to get them.

To Run This Project, you will only need the docker-compose.yml file from this repository. You can get it by running the following command on your machine:

wget -c https://raw.githubusercontent.com/Phundrak/TastySauce/master/docker-compose.yml

Or you can clone the whole project if you wish.

Due to obvious security reasons, I am not giving away the token of my bot in the source code, and you should not either. This is why this project will try to get it from your environment variables. To do so, edit the docker-compose file to add the environment key `BOTTOKEN`, like so:

version: '3'
services:
  bot:
    image: phundrak/tastysauce:latest
    command: python tastysauce.py
    environment:
      - BOT_TOKEN=yourtoken
    volumes:
      - .:/code

You can now run the project within a contained environment by running the following command:

docker-compose up

If you wish to have it detached from your terminal, you can add the `-d` switch to the command:

docker-compose up -d

And that’s it! Your bot should be up and running once your container is built, which happens only the first time you launch it. If you want to stop TastySauce, simply hit Ctrl-c in your terminal if you haven’t detached the process, or run docker-compose down if you did.

Licence

This project is under the free GPLv3 licence. You can find the complete licence in <LICENCE.md>.

Contributing

Submit a pull request, and I’ll review it when I’ll have time to (this is not a project I will pour a lot of efforts into). Simply be aware that I’d prefer it if your code is written with meaningful variables (I should fix that), comments (I should fix that), and be aware that readability is above all. Also, don’t be an asshole (that’s the project’s Code of Conduct for y’all).