From 4c005caa33a0f917180fb77fd7cc0098722d575c Mon Sep 17 00:00:00 2001 From: xclicx <97340999+xclicx@users.noreply.github.com> Date: Sun, 17 Nov 2024 20:04:08 +0100 Subject: [PATCH] Update README_FR.md --- README_FR.md | 180 ++++++++++++++------------------------------------- 1 file changed, 47 insertions(+), 133 deletions(-) diff --git a/README_FR.md b/README_FR.md index b866bd5cdc..b317bd4a09 100644 --- a/README_FR.md +++ b/README_FR.md @@ -2,170 +2,84 @@ Eliza Banner -## la fonctionnalité +## Fonctionnalités -- 🛠 soutenir la connexion discord/ twitter /telegram -- 👥 soutien aux agents multimodaux -- 📚 simple à importer des documents et interagir avec les documents -- mémoire et stockage des documents accessibles -- 🚀 haute scalabilité, vous pouvez personnaliser les clients et les comportements pour une extension fonctionnelle -- ☁ ️ plusieurs modèles, y compris Llama, OpenAI Grok Anthropic, etc. -- 📦 simple et facile à utiliser +- 🛠 Support des connecteurs Discord/ Twitter / Telegram +- 🔗 Support des différents modèles d'IA (Llama, Grok, OpenAI, Anthropic, etc.) +- 👥 Gestion de plusieurs agents et assistance +- 📚 Import et intéractions avec différents types de documents simplifiés +- 💾 Accès aux données en mémoire et aux documents stockés +- 🚀 Grande personnalisation possible : création de nouveaux clients et de nouvelles actions +- 📦 Simplicité d'utilisation Que pouvez-vous faire avec Eliza? -- 🤖 le chatbot -- 🕵 ️ Agents autonomes -- 📈 processus métier pour automatiser le traitement -- 🎮 jeux PNJ +- 🤖 Chatbot +- 🕵 ️Agents autonomes +- 📈 Processus automatisés +- 🎮 PNJ intéractifs +- 🧠 Trading automatisé -# commencez à utiliser -**pré-requis (obligatoire) :** +# Premiers pas +**Pré-requis (obligatoire) :** + +- [Python 2.7+](https://www.python.org/downloads/) - [Node.js 22+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) -- installation Nodejs - [pnpm](https://pnpm.io/installation) -- travailler avec PNPM - -### éditer le fichier.env - -- copiez.env.example en.env et remplissez la valeur appropriée -- modifier l’environnement twitter et entrer votre compte twitter et mot de passe - -### modifier les fichiers de rôles - -- voir le document `src/core/defaultCharacter ts` - vous pouvez le modifier -- vous pouvez également utiliser `node --loader ts-node/esm src/index.ts --characters="path/to/your/character.json" ` et simultanément plusieurs robots. - -Après avoir terminé la configuration des fichiers de compte et de rôle, lancez votre bot en tapant la ligne de commande suivante: - -``` -pnpm i -pnpm start -``` -# personnalisez votre Eliza +> **Note pour Windows :** WSL est requis -### ajouter un comportement régulier +### Editer le fichier .env -Pour éviter les conflits Git dans le répertoire core, nous vous recommandons d’ajouter les actions personnalisées dans le répertoire custom_actions et de les configurer dans le fichier elizaconfig.yaml. Vous pouvez consulter l’exemple dans le fichier elizaconfig.example.yaml. +- Copier le fichier d'example et le remplir le avec les valeurs adéquates -## configurez différents grands modèles - -### configurer Llama - -Vous pouvez exécuter en définissant la variable d’environnement `XAI_MODEL` à `meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo` ou `meta-llama/Meta-Llama-3.1-405B-Instruct` Llama 70B ou 405B modèle - -### configurer OpenAI - -Vous pouvez exécuter le modèle OpenAI en définissant la variable d’environnement `XAI_MODEL` à `gpt-4o-mini` ou `gpt-4o` - -## autres demandes - -Vous devrez peut-être installer Sharp. Si vous voyez une erreur au démarrage, essayez d’installer avec la commande suivante: - -``` -pnpm install --include=optional sharp ``` - -# paramètres de l’environnement - -Vous devez ajouter des variables d’environnement à votre fichier.env pour vous connecter à différentes plates-formes: - +cp .env.example .env ``` -# Required environment variables -DISCORD_APPLICATION_ID= -DISCORD_API_TOKEN= # Bot token -OPENAI_API_KEY=sk-* # OpenAI API key, starting with sk- -ELEVENLABS_XI_API_KEY= # API key from elevenlabs - -# ELEVENLABS SETTINGS -ELEVENLABS_MODEL_ID=eleven_multilingual_v2 -ELEVENLABS_VOICE_ID=21m00Tcm4TlvDq8ikWAM -ELEVENLABS_VOICE_STABILITY=0.5 -ELEVENLABS_VOICE_SIMILARITY_BOOST=0.9 -ELEVENLABS_VOICE_STYLE=0.66 -ELEVENLABS_VOICE_USE_SPEAKER_BOOST=false -ELEVENLABS_OPTIMIZE_STREAMING_LATENCY=4 -ELEVENLABS_OUTPUT_FORMAT=pcm_16000 - -TWITTER_DRY_RUN=false -TWITTER_USERNAME= # Account username -TWITTER_PASSWORD= # Account password -TWITTER_EMAIL= # Account email -TWITTER_COOKIES= # Account cookies -X_SERVER_URL= -XAI_API_KEY= -XAI_MODEL= +### Modifier les fichiers personnage +1. Ouvrir le document `src/core/defaultCharacter.ts` afin de modifier le personnage par défaut -# For asking Claude stuff -ANTHROPIC_API_KEY= +2. Pour ajouter des personnages personnalisés : + - Lancer la commande `pnpm start --characters="path/to/your/character.json"` + - Plusieurs fichiers personnages peuvent être ajoutés en même temps -WALLET_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY -WALLET_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY +### Lancer Eliza -BIRDEYE_API_KEY= +Après avoir terminé la configuration et les fichiers personnage, lancer le bot en tapant la ligne de commande suivante: -SOL_ADDRESS=So11111111111111111111111111111111111111112 -SLIPPAGE=1 -RPC_URL=https://api.mainnet-beta.solana.com -HELIUS_API_KEY= - - -## Telegram -TELEGRAM_BOT_TOKEN= +```bash +pnpm i +pnpm build +pnpm start -TOGETHER_API_KEY= +# Le projet étant régulièrement mis à jour, il vous faudra parfois le nettoyer avant de recommencer à travailler dessus +pnpm clean ``` -# paramètres locaux - -### ensemble CUDA +#### Ressources additionelles -Si vous avez une carte graphique nvidia haute performance, vous pouvez faire l’accélération locale avec la ligne de commande suivante CUDA +Il vous faudra peut-être installer Sharp. +Si il y a une erreur lors du lancement du bot, essayez d'installer Sharp comme ceci : ``` -pnpm install -npx --no node-llama-cpp source download --gpu cuda +pnpm install --include=optional sharp ``` -Assurez-vous d’avoir le kit complet CUDA installé, y compris cuDNN et cuBLAS - -### exécution locale +### Communauté et réseaux sociaux -Ajoutez XAI_MODEL et définissez-le à l’une des options ci-dessus [use Llama run](#run-with-llama) -Vous pouvez laisser X_SERVER_URL et XAI_API_KEY vides, qui téléchargera le modèle de huggingface et le consultera localement +- [GitHub](https://github.com/ai16z/eliza/issues). Pour partager les bugs découverts lors de l'utilisation d'Eliza, et proposer de nouvelles fonctionnalités. +- [Discord](https://discord.gg/ai16z). Pour partager ses applications et rencontrer la communauté. -# le client - -Pour savoir comment configurer votre bot discord, vous pouvez consulter la documentation officielle de discord - -# le développement - -## le test - -Ligne de commande pour plusieurs méthodes de test: - -```bash -pnpm test # Run tests once -pnpm test:watch # Run tests in watch mode -``` - -Pour les tests spécifiques à la base de données: - -```bash -pnpm test:sqlite # Run tests with SQLite -pnpm test:sqljs # Run tests with SQL.js -``` +## Contributeurs -Les tests sont écrits en Jest et se trouvent dans le fichier SRC /\*_/_.test.ts. L’environnement de test est configuré comme suit: + + + -- chargement des variables d’environnement de.env.test -- utilisez un temps d’attente de 2 minutes pour exécuter des tests de longue durée -- support du module ESM -- exécuter les tests dans l’ordre (--runInBand) +## Historique d'étoiles -Pour créer un nouveau test, ajoutez un fichier.test.ts à côté du code à tester. +[![Star History Chart](https://api.star-history.com/svg?repos=ai16z/eliza&type=Date)](https://star-history.com/#ai16z/eliza&Date)