This repository has been archived on 2022-08-14. You can view files and clone it, but cannot push or open issues or pull requests.
feurBot/README.md

69 lines
3.9 KiB
Markdown
Raw Normal View History

2022-08-02 20:47:20 +02:00
# [Bot Twitter](https://twitter.com/Myshawii)
2021-08-03 20:10:54 +02:00
2021-08-06 02:58:44 +02:00
Bot qui envoie automatiquement des réponses ennuyantes quand les personnes que tu suis finissent leur tweet par un mot spécial.
2021-08-06 02:56:10 +02:00
2021-08-06 02:58:44 +02:00
Certains mots peuvent servir de "trigger" sans être dans la liste, example : `aussi` n'est pas dans la liste, mais en retirant `aus`, on obtient `si`, qui est dans la liste.
2022-08-02 21:33:46 +02:00
| Mot | Réponse | ¦ | Mot | Réponse | ¦ | Mot | Réponse | ¦ | Mot | Réponse | ¦ | Mot | Réponse | ¦ | Mot | Réponse
------|--------- |:-:|---------|-----------|:-:|------|-------------------------------|:-:|-------------------------|------------|:-:|-------|------------------ |:-:|-------|-
quoi | feur | ¦ | con | combre | ¦ | coup | teau | ¦ | ka | pitaine | ¦ | moi | tié/sson/sissure | ¦ | ni | cotine
oui | stiti/fi | ¦ | ok | sur glace | ¦ | ça | pristi/perlipopette/von | ¦ | fais | rtile | ¦ | toi | lette/ture | ¦ | quand | dide/tal/didat
2022-08-05 02:42:19 +02:00
non | bril | ¦ | ouais | stern | ¦ | bon | jour/soir (dépend de l'heure) | ¦ | tant (ou autre syntaxe) | gente | ¦ | top | inambour | ¦ | sol | itaire
nan | cy | ¦ | comment | tateur | ¦ | qui | wi/mono | ¦ | et | eint/ain | ¦ | jour | nal | ¦ | vois | ture
2022-08-02 20:52:24 +02:00
hein | deux | ¦ | mais | on | ¦ | sur | prise | ¦ | la | vabo/vande | ¦ | ya/yo | hourt/yo | ¦ |
ci | tron | ¦ | fort | boyard | ¦ | pas | nini/steur | ¦ | tki | la | ¦ | re | pas/veil/tourne | ¦ |
2021-08-04 16:01:29 +02:00
2021-08-06 02:58:44 +02:00
N'hésitez pas à ouvrir un ticket ou faire une merge-request pour contribuer au projet.
2021-08-03 20:10:54 +02:00
## Lancer le Bot
2021-08-06 02:58:44 +02:00
Donner la permission `Read and Write` (ou `Read + Write + Direct Messages` mais aucun DM n'est envoyé) au bot dans `Settings` puis `App permissions`.
Détails des variables d'environnement :
2021-08-03 20:57:21 +02:00
| Variable | Explication et où elle se trouve
2021-08-03 20:10:54 +02:00
----------------|-
TOKEN | Token d'accès disponible dans la section `Authentication Tokens` sous la sous-rubrique `Access Token and Secret`
TOKEN_SECRET | Token d'accès secret disponible dans la section `Authentication Tokens` sous la sous-rubrique `Access Token and Secret`
CONSUMER_KEY | Clé API disponible dans la section `Consumer Keys`
CONSUMER_SECRET | Clé secrète API disponible dans la section `Consumer Keys`
PSEUDOS | Pseudos du ou des compte.s que vous voulez écouter pour le snipe (a séparer avec une virgule **sans** espaces)
2021-08-05 20:26:25 +02:00
WHITELIST | Pseudos des comptes qui ne seront pas touché par le Bot (facultatif, a séparer avec une virgule **sans** espaces, par défaut la liste est vide)
VERBOSE | Affiche plus de messages dans la console [False\|True] (facultatif, par défaut sur False)
FORCELIST | Force le bot à écouter certains comptes (séparer les comptes avec une virgule **sans** espaces, par défaut la liste est vide)
2021-08-03 20:10:54 +02:00
### En local
Pour le lancer, complètez le `.envexample` et renomme le en `.env`.
Ensuite, installez les dépendances avec `pip install -r requirements.txt`.
Et enfin lancez `python3 main.py`.
### Avec Docker
2021-08-03 20:10:54 +02:00
Avec une ligne de commande :
```bash
docker run -d \
--name="feurBot" \
registry.gitlab.com/mylloon/feurbot:latest \
--TOKEN="" \
--TOKEN_SECRET="" \
--CONSUMER_KEY="" \
--CONSUMER_SECRET="" \
2021-08-05 21:53:58 +02:00
--PSEUDOS=""
```
Ou avec un `docker-compose.yml` :
```bash
version: "2.1"
services:
feurBot:
image: registry.gitlab.com/mylloon/feurbot:latest
container_name: feurBot
environment:
- TOKEN=
- TOKEN_SECRET=
- CONSUMER_KEY=
- CONSUMER_SECRET=
- PSEUDOS=
restart: unless-stopped
```