Giter Site home page Giter Site logo

puppet's Introduction

Puppet

A Discord bot built using Discord.js

Note: This bot is still a work in progress and new features are being added on a regular basis. As a result, things may break from time to time. I apologize for any inconvenience this may cause. If you would like to contribute to the development of the bot, feel free to make a pull request.

Features ✨

  • Moderation: Basic moderation like /kick, /ban, /mute, and /lock
  • Music: Play songs from YouTube, Spotify, and SoundCloud by using the /play command
  • GPT-3: GPT-3 integration, which enables advanced language processing capabilities such as text generation and question answering using Cohere API
  • Information: Get information on various stuff such as /weather, /anime, /manga, /book, etc.
  • Games: Play games such as /truth or /dare

Slash Commands ⌨️

This bot uses slash commands to perform its various functions. You can see all the available commands in the source code.

Getting Started 🚀

To add this bot to your Discord server, you will need to follow these steps:

  1. Install Node.js, which is required to run the bot
  2. Create a bot application on the Discord developer portal
  3. Invite the bot to your Discord server by generating an invite link from the Discord developer portal
  4. Clone the repository using git clone https://github.com/Sushipie/Sad_Machine.git
  5. Configure the bot by creating a .env file in the root directory and adding necessary environment variables such as the bot token, Tenor API key, and Cohere API key if necessary. You can look at the included .env.example file as an example
  6. Navigate to the folder and run npm install. This will install the required dependencies for your bot
  7. Run the bot using the command src/node index.js

Hosting ☁️

I am hosting the bot on Fly.io. It is a great alternative to Heroku's free tier that has been shut down. If you want to host your own bot, you can follow these steps:

  1. Sign up for a Fly.io account
  2. Install the Fly CLI
  3. Authenticate with Fly by running flyctl auth login and following the prompts
  4. Create a new Fly app by running flyctl launch from your bot's directory

Fly.io will create a fly.toml file that basically configures the remote machine your app runs on. You need to add the following lines to the file to make your bot run on their servers

[build] 
	builder = "heroku/buildpacks:20"

You also need to add a Procfile in the bot's directory with the following line:

worker: node src/index.js

After following these steps, your bot should be up and running on your Discord server. ✅

puppet's People

Contributors

ahmadthakur avatar

Stargazers

KIRA avatar Meryem Yunus avatar Nooriya avatar

Watchers

 avatar

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.