CunnyBot

CunnyBot is a cute and funny bot that sends an image from your favorite image board (booru) to your Discord webhook every hour :3

Installation

1. Run npm install to install all the required modules. The required modules will be pulled automatically from the package.json.

2. Create a .env file in the root path of the project.

3. Insert the following text, replacing the values with your own:

   WEBHOOK_URL=your-webhook-url-here

4. Create two text files, allowed_tags.txt and disallowed_tags.txt, and insert your tags separated by spaces, new lines, or both. For example:

   # Example allowed tags:
   gawr_gura murasaki_shion laplus_darknesss
   uruha_rushia blue_archive hoshino_(blue_archive)
   arona_(blue_archive) arisu_(blue_archive) iroha_(blue_archive)
   
   # Example disallowed tags:
   guro vore scat gore pee
   

5. Create a file named configs.js and paste the text bellow. (Optional: edit the variables inside it with the ones you like):

   module.exports = {
     disallowedRatings: "explicit questionable", // The rating you want to exclude. "General" rating is used by Gelbooru to define the SFW posts, but other boorus might use the "safe" rating instead.
     site: "gelbooru", // The website you want to send pictures from.
     allowedTagsFile: "allowed_tags.txt", // The file containing the tags you want to include in the search. The code will pick a random tag instead of using all the tags at once.
     disallowedTagsFile: "disallowed_tags.txt", // The file containing the tags you want to exclude from all the searches.
   
     logToFile: "logs.csv", // The file you want to log every post that was sent. Use "logToFile: false" if you don't want to log it.
     deleteLogsOlderThan: 7, // Days
     preventDuplicates: true, // If enabled the code will reject any posts that already had been sent and will try sending another post (notice: the logging must be enabled for this feature to work)
   
     outputType: "sampleUrl", // the output that will get sent to Discord. You can use fileUrl or sampleUrl (if it does't exist or is NULL, "fileUrl" will be used instead)
   
     sendAtStart: false, // If you want to send the post when the script starts and then every hour at minute zero (true) or only every hour at minute zero (false).
   };

6. Run node index.js to execute the script.

Output

Here's an example of what the output might look like:

You're free to modify the script to customize the output, such as adding embeds, modifying the schedule, and more.

Collaboration

How can I collaborate?

Simply make a pull request, and I will review it. I would be more than happy to have someone improve my code, as it pretty much sucks.

What happens after I make the pull request?

I will regularly review pull requests, and if I find that your version is suitable, it will become part of the next update.

License

This project is licensed under the terms of the MIT License, which allows you to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the conditions specified in the license.