Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Zingzy committed Jul 21, 2024
1 parent fd63d0a commit f5e77dd
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 41 deletions.
89 changes: 48 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,50 @@
<p align="center">
<image src='https://raw.githubusercontent.com/zingzy/pollinations.ai-bot/main/static/previews/banner.png' width="550"/>
</p>

<table>
<tr>
<td width="15%"><image src='https://i.spoo.me/299243'/></td>
<td width="75%"><h1>Pollinations.ai Bot</h1>
<i>A discord bot which generates AI images for free ✨</i><br><br>
</td>
</tr>
</table>
<h3 align="center">Pollinations.ai Discord Bot</h3>
<p align="center">Generate AI Images for free under 10 seconds using pollinations.ai 🤖🎨
</p>

Welcome to the **Pollinations.ai Bot** repository! This bot is a discord bot which generates AI images using https://pollinations.ai. It is written in Python using the discord.py library.
<p align="center">
<a href="#-features"><kbd>🔥 Features</kbd></a>
<a href="#-whats-next"><kbd>💡 What's Next</kbd></a>
<a href="#-getting-started"><kbd>🚀 Getting Started</kbd></a>
<a href="https://discord.com/oauth2/authorize?client_id=1123551005993357342"><kbd>➕ Add to your server</kbd></a>
</p>


<p align="center">
<img src="https://img.shields.io/github/last-commit/zingzy/pollinations.ai-bot?logo=github" alt="GitHub last commit">
<img src="https://img.shields.io/github/commit-activity/m/zingzy/pollinations.ai-bot?logo=github" alt="GitHub commit activity">
<img src="https://img.shields.io/github/issues/zingzy/pollinations.ai-bot?logo=github" alt="GitHub issues">
<a href="https://discord.gg/SFasNG4n6b"><img src="https://img.shields.io/discord/885844321461485618?logo=discord" alt="Discord"></a>
</p>


## ⚡ Introduction

🌸 **Pollinations.ai bot** is a discord bot which **generates AI images** using https://pollinations.ai. It is written in `Python` using the `discord.py` library and is currently used in **over 500 discord servers**.

---

### Features
### 🔥 Features

- Generate AI images using the `/imagine` command
- Users can choose from a variety of models like `pixart`, `dreamshaper`, etc.
- Users can also specify the width and height of the image
- Experimental `/multi-imagine` command
- Users can generate images using all available models at once
- Generate **AI images** using the `/pollinate` command
- Users can also speicify whether they want to **AI enhance their prompt** or not.
- Users can also specify the **width** and **height** of the image.
- Generate **multiple variations** of a prompt using the `/multi-pollinate` command
- The bot will generate **4 different** variations of the prompt.

- Generate **random AI images** using the `/random` command

- View **Leaderboard** of the top users using the `/leaderboard` command

---

### Getting Started
### 🚀 Getting Started

1. **Inviting the Bot**: Invite Pollinations.ai bot to your server using the following link: [Invite Pollinations.ai bot](https://discord.com/api/oauth2/authorize?client_id=1123551005993357342&permissions=534791060544&scope=applications.commands%20bot).
1. **Inviting the Bot**: Invite Pollinations.ai bot to your server using the following link: [Invite Pollinations.ai bot](https://discord.com/oauth2/authorize?client_id=1123551005993357342).

2. **Commands**: Use the various commands mentioned above to start generating AI Images.

Expand All @@ -33,26 +53,15 @@ Welcome to the **Pollinations.ai Bot** repository! This bot is a discord bot whi

### ⚙️ How to setup

rename the `.env.example` file to `.env` and enter your `Bot token` And `Mongodb uri`.

#### Create Virtual environment (OPTIONAL)

Linux
#### Rename the `.env.example` file to `.env`

```bash
python3 -m venv .venv
source .venv/bin/activate

mv .env.example .env
```
Windows

```ps
python -m venv .venv
.venv/Scripts/activate
Now open the `.env` file and add your discord bot `TOKEN` and `MONGODB_URI` to the file.

```

#### install dependencies
#### Install dependencies

```bash
pip install -r requirements.txt
Expand Down Expand Up @@ -85,9 +94,9 @@ python main.py

### 📝 Feedback / Issues

To give feedback, ask a question or make a feature request, you can either use the [Github Discussions](https://github.com/Zingzy/pollinations.ai-bot/discussions) or [JOIN OUR SUPPORT SERVER ](https://discord.gg/nBA6kmqaaK)🪬
To give feedback, ask a question or make a feature request, you can either use the [Github Discussions](https://github.com/Zingzy/pollinations.ai-bot/discussions) or [JOIN OUR SUPPORT SERVER ](https://discord.gg/SFasNG4n6b)🪬

Bugs are logged using the github issue system. To report a bug, simply [open a new issue](https://github.com/Zingzy/pollinations.ai-bot/issues/new).
Bugs are logged using the github issue system. To report a bug, simply [open a new issue](https://github.com/Zingzy/pollinations.ai-bot/issues/new) 🪲

---

Expand All @@ -99,17 +108,15 @@ Contributions, issues and feature requests are welcome! Feel free to check [issu

### 💡 what's next

- Creating an interactive website for the bot
- Adding a leaderboard command
- Add **Likes** and **bookmark** view commands
- Add **style** option in pollinate command

Any Other suggestions would be appreciated ...

---

### Contributors

- [@Zinzy](https://github.com/zingzy) - Lead Bot developer

---

[![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/) [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Zingzy/pollinations.ai-bot/graphs/commit-activity) [![Last-Commit](https://badgen.net/github/last-commit/Zingzy/pollinations.ai-bot)](https://github.com/zingzy/pollinations.ai-bot/commits) [![issues](https://badgen.net/github/issues/Zingzy/pollinations.ai-bot)](https://github.com/Zingzy/pollinations.ai-bot/issues)
<a href="https://github.com/zingzy/pollinations.ai-bot/graphs/contributors">
<img src="https://contrib.rocks/image?repo=zingzy/pollinations.ai-bot" />
</a>
Binary file added previews/banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f5e77dd

Please sign in to comment.