Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/plexi09/justincats
https://github.com/plexi09/justincats
Last synced: 28 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/plexi09/justincats
- Owner: Plexi09
- Created: 2025-01-06T19:46:44.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2025-01-07T17:18:39.000Z (30 days ago)
- Last Synced: 2025-01-07T18:27:48.653Z (30 days ago)
- Language: Python
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# JustCats
JustCats est un bot Discord qui vous permet d'obtenir des images de chats à la demande en utilisant l'API CATAAS.
## Prérequis
- Python 3.11
- Un token Discord pour votre bot
- Les dépendances listées dans `requirements.txt`
> Pour créer un bot Discord et obtenir le token, suivez [ce guide](https://discord.com/developers/docs/quick-start/getting-started#step-1-creating-an-app)
## Installation
1. Clonez ce dépôt :
```sh
git clone https://github.com/Plexi09/JustInCats.git
cd JustInCat
```
2. Créez un environnement virtuel et activez-le :
```sh
python3.11 -m venv venv
source venv/bin/activate # Sur Windows, utilisez `venv\Scripts\activate`
```
3. Installez les dépendances :
```sh
pip install -r requirements.txt
```
4. Créez un fichier [.env](http://_vscodecontentref_/1) en vous basant sur le fichier [.env.example](http://_vscodecontentref_/2) et ajoutez votre token Discord et votre ID:
```env
DISCORD_TOKEN=your_token_here
OWNER_ID=your_id_here
```
## Utilisation
1. Démarrez le bot :
```sh
python bot.py
```
2. Invitez le bot sur votre serveur Discord en utilisant le lien d'invitation généré par le portail des développeurs Discord.
## Commandes
- `/ping` : Vérifiez la latence du bot.
- `/info` : Obtenez des informations sur le bot.
- `/howmanycats` : Affiche le nombre d'images de chats disponibles.
- `/randomcat` : Obtenez une image de chat aléatoire.
- `/customcat` : Obtenez une image de chat avec des options avancées (type, largeur, hauteur, filtre, flou, luminosité, saturation, etc.).
## Arrêter le bot
Pour arrêter le bot, envoyez la commande `!shutdown` en tant que propriétaire du bot.
## Utilisation avec Docker
1. Construisez l'image Docker :
```sh
docker build -t justincats-bot .
```
2. Démarez le conteneur Docker :
```sh
docker run --env-file .env justincats-bot
```
## Contribution
Les contributions sont les bienvenues ! Veuillez soumettre une pull request ou ouvrir une issue pour discuter des changements que vous souhaitez apporter.
## Licence
Ce projet est sous licence MIT. Voir le fichier [LICENSE.md](LICENSE.md) pour plus de détails.