Skip to content
This repository has been archived by the owner on Sep 21, 2022. It is now read-only.

This is a little Bot i made for my Discord server and a couple of friends's server.

License

Notifications You must be signed in to change notification settings

ScrappyCocco/ScroccoDiscordBot

Repository files navigation

Quality Status Vulnerabilities

Scrocco Discord Bot

This is a little Python Bot i made for my Discord server and a couple of friends's Discord server.

Born in middle 2016 as little bot with only few commands, Scrocco is now a complete and fully-functional Discord Bot.

Since May 2019 Scrocco use discord.py > 1.0.1 the latest rewritten version of Discord Python Api made by Danny.

Please see 'Deleted commands' to read about why some commands may not work.

With the closure of Heroku Free in 2022 I will no longer support this bot that was just a little project, and it will be archived.

Getting Started

These instructions will get you a copy of the bot up and running on your local machine for development and testing purposes. If you want the bot up 24/7 you should buy a Python Hosting service for the bot.

Prerequisites

To running the bot you'll need Python (i used python-3.6.X) and to install all the packages in requirements.txt, you can install them with:

pip install -r requirements.txt

You need also all the API key you'll find in bot_data_examples.json (cleverbot, Steam, ...), so you must fill all the variables in "bot_data_examples.json" and rename it in "bot_data.json" (a little documentation of the JSON file can be found in bot_data.schema.json).

If you don't want a command, you have to MANUALLY delete it, this is how:

  1. If the command use an api key, start removing the method that get it and its call in full_startup_check() in botVariablesClass.py. (The JSON is now also validated using the JSON Schema at startup, so if you remove the command, make the JSON validate successfully inserting a fake string);
  2. Now you have to remove the command, locate it and delete the whole command;
  3. Repeat this for every command you don't want in the bot.

(If you remove the check from botVariablesClass.py but not the command code you'll have runtime errors when someone use that command)

Finally, remember to download the git submodules, i use them in the code.

git submodule update --init --recursive

Starting the bot

After you installed and configured everything you can try to run the main class (botMainClass.py) with the command:

py src/botMainClass.py

This will start the bot or show the errors you have to fix.

(If you're using a unix system, remember to change py to python3)

Deleted commands

Since 2016 few APIs have been shut down, so a few commands might be removed from the code.

List of deleted commands:

  • !hacked: using haveibeenpwned API v2 this command checked all the breaches with the given email. Sadly, there's no longer a free API to use. Command deleted in this commit;

  • !rl and !r6: because gaming APIs disappear or change too fast and are not strictly required in this bot. R6 deleted in this commit, RL before;

Note that lots of commands may not work as expected or not work at all because the API has changed or has been removed. I will fix some of them, while others will remain offline, as this is only a simple bot made for fun.

Built Using

Authors

  • ScrappyCocco - Initial work and updates
  • Special thanks to all my friends for helping me testing this bot

License

This project is licensed under the MIT License - see the LICENSE.md file for details

About

This is a little Bot i made for my Discord server and a couple of friends's server.

Topics

Resources

License

Stars

Watchers

Forks

Languages