phixxy/sparkytron3000
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
a discord bot that i used to practice python3
467 commits 4 branches 0 tags 2.2 MiB
Find a file
phixxy 65e43dacad
Update README.md 
state many cogs will not work out of the box
2024-05-14 16:45:11 -07:00
cogs fixed requirements and a bug with config 2024-05-08 11:45:34 -07:00
data/phixxy.com moved to phixxy.com folder as its the only plugin that uses this 2024-01-23 14:31:50 -08:00
examples fixed bot_base_cog and made an example cog 2024-02-15 22:37:41 -08:00
src allow admin to use bot commands in dms 2024-05-05 00:36:05 -07:00
.gitignore Added base cog to inherit from 2024-02-14 00:59:05 -08:00
CONTRIBUTING.md added CONTRIBUTING.md 2024-02-24 17:53:01 -08:00
README.md Update README.md 2024-05-14 16:45:11 -07:00
requirements.txt fixed requirements and a bug with config 2024-05-08 11:45:34 -07:00
sparkytron3000.py uppercase DISCORD_TOKEN 2024-02-14 22:23:22 -08:00

README.md

Sparkytron 3000 - Discord Bot Documentation

Sparkytron 3000 is a versatile Discord bot that allows you to customize its functionality by enabling or disabling various cogs. Each cog represents a specific feature, such as AI art generation, AI chat, meme maker, and more. This documentation will guide you through the installation process and provide an overview of the available cogs.

Table of Contents

Installation

  1. Clone the Sparkytron 3000 repository from GitHub:

    git clone https://github.com/phixxy/sparkytron-3000.git

  2. Navigate to the project directory:

    cd sparkytron-3000

  3. Install the required Python packages using the provided requirements.txt file:

    pip install -r requirements.txt

Getting Started

To get started with Sparkytron 3000, follow the steps below:

  1. Ensure you have completed the installation steps.

  2. Open sparkytron3000.py in your preferred Python IDE or text editor.

  3. Look for the following line of code and enter your Discord bot token:

    DISCORD_TOKEN = "<YOUR_BOT_TOKEN>"

  4. Save the changes to sparkytron3000.py and exit your editor.

  5. Run the bot using the following command:

    python sparkytron3000.py

  6. Sparkytron 3000 is now active on your Discord server!

Cogs

Sparkytron 3000 provides several cogs that can be enabled or disabled based on your preferences. Each cog adds a unique feature to the bot. Many cogs assume you have variables set in environment variables and therefore will not work by default. Below are some notable cogs:

Stable Diffusion

  • Description: Generates AI-generated art using stable diffusion/automatic1111.
  • Usage: !imagine <kwargs> <prompt>
  • Example: !imagine seed=1 pizza
  • pizza

ChatGPT

  • Description: Implements ChatGPT to generate chat responses and Dalle for AI-generated art.
  • Usage: !chat enable to enable the bot to chat in a channel.
  • Usage: !dalle2 <prompt> or !dalle3 <prompt> to generate an image using Dalle.
  • Example: !dalle3 cute grim reaper profile pic
  • cute grim reaper profile pic (Scaled Down)

Meme Maker

  • Description: Enables meme generation using the Imgflip API.
  • Usage: !meme <topic> generates a random meme using ChatGPT and Imgflip.
  • Example: !meme pizza
  • pizza meme

License

This project is licensed under the MIT License. See the LICENSE file for more details.