Code Monkey home page Code Monkey logo

turbo's Introduction

๐Ÿš€ Turbo

Turbo is a Discord bot that does some weird and wacky things. It can function as a normal bot or a selfbot. With fun commands and utility commands suitable for server administrators and general users alike, Turbo is a general purpose bot designed for just about any situation.

Requirements

This bot is coded in Python, so that is required to run it. As well as that, there are some additional Python dependencies that will be installed automatically when running your platform's specific scripts.

  • discord.py (used for Discord integration)
  • aiohttp (used for asynchronous web requests)
  • colorlog (used for logging in console & file)
  • rethinkdb (used for database storage, e.g tags)
  • beautifulsoup4 (used for parsing website HTML)
  • ruamel.yaml (used for parsing YAML files)

Installing

Windows

  1. Install Git for Windows
  2. Open Git Bash (right-click in a folder, select Git Bash or Git Bash Here)
  3. Run git clone https://github.com/conneritayi/Turbo.git -b master
  4. Open updatedeps-win.bat in the new folder

Linux

  1. Install Git using sudo apt-get install git (apt-get may be substituted for a different package manager on your system)
  2. Run git clone https://github.com/conneritayi/Turbo.git -b master
  3. Run updatedeps-linux.sh in the new folder

Mac

  1. Install Git using Homebrew: brew install git
  2. Run git clone https://github.com/conneritayi/Turbo.git -b master in Terminal
  3. Run updatedeps-mac.command in the new folder

Configuration

Open config/turbo.example.ini and edit it. Save it in the config folder as turbo.ini.

Aliases

You can setup aliases for commands. To do so, copy aliases.example.yml to aliases.yml. In there, you can set aliases for different commands. The format in which you should do this is inside the example file. If you still need help, here's another example on how to set three different aliases for the ping command:

ping:
  - p
  - hello
  - test

If you enter an invalid command in the aliases file, the bot will inform you of this when you start it. It won't prevent the bot from starting if you have invalid commands in the file, those will just be ignored.

Running

In order to use various commands, including commands relating to tags, you require a RethinkDB database. Learn how to install RethinkDB here. If a database is unavailable, these commands will be disabled.

Windows

Open runbot-win.bat. If you are using Git Bash, you should run the bot using the command winpty runbot.bat instead to avoid unicode issues.

Linux

Run runbot-linux.sh.

Mac

Run runbot-mac.command.

Commands

The command prefix is set in the configuration file. By default, it is ~. This prefix is needed before all commands.

Command Usage SB1 DB2 C3
ping Test the bot's connection to the Discord API
stats Get statistics about servers, users, and the bot
shutdown <normal/n/hard/h> Terminates the bot script
help [command] Lists all commands. If a command is given, gives usage info
eval <code> Allows you to execute Python code Yes
subprocess <command> Launch a subprocess Yes
snowflake [id/@user/#channel/emote/@role] Get the time created of a snowflake4
status [status] Changes the user/bot's status, or clears it
discrim [discrim] Return a list of visible users with matching discriminator
tags Lists all tags Yes
createtag <"name"> <"content"> Adds a new tag with a given name and content Yes
deletetag <"name"> Deletes a tag Yes
cleartags Deletes all tags Yes
tag <name> Triggers a tag Yes
cat Sends a random cat image
youtube <query> Searches YouTube and returns results
presence <online/idle/dnd/invisible> Changes presence status on Discord
  • 1SB = Selfbot ONLY. The selfbot option must be enabled in the configuration file
  • 2DB = Database REQUIRED. A RethinkDB database connection must be available to use
  • 3C = Creator ONLY. Only the bot application creator can use this command (or the user if selfbot)
  • 4To learn more about snowflakes, read https://discordapp.com/developers/docs/reference#snowflake-id's

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.