/saucebot

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

SauceBot

Discord Maintainability Rating Technical Debt Lines of Code GitHub GitHub release (latest by date)

SauceBot is an open-source Discord bot that utilizes the SauceNao API to find the source of images or anime screencaps.

Documentation

Inviting the bot

You can invite SauceBot to your server using the following invite link. Keep in mind, it's still in beta!

https://discord.com/api/oauth2/authorize?client_id=718642000898818048&permissions=604892224&scope=bot

Using the bot

SauceBot can operate in multiple ways. All of which center around using the ?sauce command.

The first way is to provide a direct URL to the image you want to look up as a command argument, like so,

?sauce https://i.redd.it/rqtzjynwx7351.jpg

Bot demonstration

The second way is to upload an image to the channel and supply ?sauce as the images comment.

Lastly, if someone just uploaded an image to a channel and you want to look up the sauce, just use the ?sauce command without any arguments, and it'll automatically do a search on the last attachment uploaded to that channel!

Increasing your API limits

Each Discord server is currently allotted 50 free API queries/day from a shared pool. This value may change depending on how much Patreon/Github funding the project receives, and how popular the bot becomes.

If you run a larger server and need more API queries, you can upgrade to a limit of 5,000 queries/day by obtaining an enhanced license key directly from SauceNao for $6/month.

To register an API key to your server, run ?apikey YOUR_API_KEY_HERE from a channel that only administrators have access to. (You'll need to grant the bot access to this channel as well, at least temporarily).

You should receive a confirmation message afterwards verifying your API key was successfully linked.

Keep in mind, this will only work for enhanced license keys. Freely registered API keys will not work, as these are still IP restricted (meaning, multiple free accounts cannot be used on the same network). If you want to use a freely registered API key, you'll need to run your own instance of the bot.

Give it a test run!

Want to give SauceBot a try? Join the support discord and use the #sfw-lookups and #nsfw-lookups channels respectively to experiment!

https://discord.gg/p7fstG4

Patreons

Thank you so much to all of our supporters on Patreon! It means a lot to me that you believe in this project enough to help fund it.

Main Characters ($6)

  • Part

Supporting Characters ($3)

  • Tamschi
  • Justin Whang
  • Joe Young
  • SUZUSHIIRO
  • Compsense
  • JL
  • Migi