prepping for Eliza PR

Author: sunsakis

README.md

@@ -1,73 +1,151 @@
-![SBF](sbf.png)
+# Eliza 🤖
 
-# Eliza Solana Plugin Upgrade 🤖
+<div align="center">
+  <img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
+</div>
 
-This is a fork of the Eliza client repository with an improved Solana plug-in and a new character who handles all Solana based transactions: SBF.
+<div align="center">
 
-The transfer action in solana-plugin was split into two separate actions: SEND_SOL and SEND_TOKEN.
+📖 [Documentation](https://elizaos.github.io/eliza/) | 🎯 [Examples](https://github.com/thejoven/awesome-eliza)
 
-This way the agent can handle different transactions better than having both actions in one.
+</div>
 
-Also added more detailed logging and transaction state monitoring.
+## 🌍 README Translations
 
-WARNING: as of this fresh release, there are yet no confirmations before sending out SOL or SPL tokens, so use for experimentation only.
+[中文说明](./README_CN.md) | [日本語の説明](./README_JA.md) | [한국어 설명](./README_KOR.md) | [Persian](./README_FA.md) | [Français](./README_FR.md) | [Português](./README_PTBR.md) | [Türkçe](./README_TR.md) | [Русский](./README_RU.md) | [Español](./README_ES.md) | [Italiano](./README_IT.md) | [ไทย](./README_TH.md) | [Deutsch](./README_DE.md) | [Tiếng Việt](./README_VI.md) | [עִברִית](https://github.com/elizaos/Elisa/blob/main/README_HE.md) | [Tagalog](./README_TG.md) | [Polski](./README_PL.md) | [Arabic](./README_AR.md) | [Hungarian](./README_HU.md) | [Srpski](./README_RS.md) | [Română](./README_RO.md) | [Nederlands](./README_NL.md)
 
-Works with client-twitter, too.
+## 🚩 Overview
 
-# SBF handles Solana transactions
+<div align="center">
+  <img src="./docs/static/img/eliza_diagram.png" alt="Eliza Diagram" width="100%" />
+</div>
 
-As plugins and characters in Eliza agentic world go hand-in-hand, SBF is a character made for leveraging Solana plugin.
+## ✨ Features
 
-# Setup the client
+- 🛠️ Full-featured Discord, Twitter and Telegram connectors
+- 🔗 Support for every model (Llama, Grok, OpenAI, Anthropic, etc.)
+- 👥 Multi-agent and room support
+- 📚 Easily ingest and interact with your documents
+- 💾 Retrievable memory and document store
+- 🚀 Highly extensible - create your own actions and clients
+- ☁️ Supports many models (local Llama, OpenAI, Anthropic, Groq, etc.)
+- 📦 Just works!
 
-`cp .env.example .env`
+## Video Tutorials
 
-Input your ANTHROPIC_API_KEY, SOLANA_PRIVATE_KEY and SOLANA_PUBLIC_KEY in .env.
+[AI Agent Dev School](https://www.youtube.com/watch?v=ArptLpQiKfI&list=PLx5pnFXdPTRzWla0RaOxALTSTnVq53fKL)
 
-I recommend using Anthropic's Claude, because the success rate of calling transfer actions is highly correlated with the intelligence of the AI used, but instead of ANTHROPIC_API_KEY, you can use any other model, so long as you specify it in the character.json file.
+## 🎯 Use Cases
 
-If you plan on using the client-twitter feature, in sbf.character.json change `"clients": []` to `"clients": ["twitter"]`
+- 🤖 Chatbots
+- 🕵️ Autonomous Agents
+- 📈 Business Process Handling
+- 🎮 Video Game NPCs
+- 🧠 Trading
 
-then you need to input your TWITTER_USERNAME, TWITTER_PASSWORD and TWITTER_EMAIL.
+## 🚀 Quick Start
 
-Put in the usernames you want to target in TWITTER_TARGET_USERS separated by commas.
+### Prerequisites
 
+- [Python 2.7+](https://www.python.org/downloads/)
+- [Node.js 23+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+- [pnpm](https://pnpm.io/installation)
 
-run `pnpm install --no-frozen-lockfile` and `pnpm build` to install dependencies and build the project.
+> **Note for Windows Users:** [WSL 2](https://learn.microsoft.com/en-us/windows/wsl/install-manual) is required.
 
-run `pnpm start --character="characters/sbf.character.json"` to start SBF agent up.
+### Use the Starter (Recommended)
 
-run `pnpm start:client` to start the client and chat with SBF using the client.
+```bash
+git clone https://github.com/elizaos/eliza-starter.git
+cd eliza-starter
+cp .env.example .env
+pnpm i && pnpm build && pnpm start
+```
 
-NOTE: If something does not work, make the appropriate changes, delete the agent/data/db.sqlite file and `pnpm build` again to make sure your changes are reflected.
+Once the agent is running, you should see the message to run "pnpm start:client" at the end.
+Open another terminal and move to same directory and then run below command and follow the URL to chat to your agent.
 
-# Using the Solana plug-in
+```bash
+pnpm start:client
+```
 
-If you want the agent to send you SOL or SPL tokens, you need to simply tell the agent to do so.
+Then read the [Documentation](https://elizaos.github.io/eliza/) to learn how to customize your Eliza.
 
-For example type "send 1.5 SOL to Ae8GkmtaJmr3MS3oKStkZyPHuQf3hawn53XD4bQjVQiu".
+### Manually Start Eliza (Only recommended if you know what you are doing)
 
-This will send 1.5 SOL to the address Ae8GkmtaJmr3MS3oKStkZyPHuQf3hawn53XD4bQjVQiu.
+```bash
+# Clone the repository
+git clone https://github.com/elizaos/eliza.git
 
-For sending SPL native tokens, apart from the destination address and amount, the token contract address is also needed.
+# Checkout the latest release
+# This project iterates fast, so we recommend checking out the latest release
+git checkout $(git describe --tags --abbrev=0)
+# If the above doesn't checkout the latest release, this should work:
+# git checkout $(git describe --tags `git rev-list --tags --max-count=1`)
+```
 
+### Start Eliza with Gitpod
 
-example:
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main)
 
-"send 69 GODS (CA: GEVqugYZESSzZaYU6SKdpW6znCCEtH7aoSTzPHbqpump) to Ae8GkmtaJmr3MS3oKStkZyPHuQf3hawn53XD4bQjVQiu"
+### Edit the .env file
 
-That's it. Upon success, you will be sent a transaction hash.
+Copy .env.example to .env and fill in the appropriate values.
 
-## extra feats in client-twitter
+```
+cp .env.example .env
+```
 
-client-twitter was modified to a more sophisticated self-tweet handling - it will still process self-tweets if they're from target users.
+Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON
 
-Features:
-1. More sophisticated handling of self-tweets and target users
-2. Enhanced debugging capabilities
-3. More robust state handling and action processing
-4. Better formatting of character examples and actions
+### Automatically Start Eliza
 
-Let SBF manage your Solana transactions.
+This will run everything to set up the project and start the bot with the default character.
 
-*note: this message was sent from federal prison, but that's totally unrelated to any of this*
+```bash
+sh scripts/start.sh
+```
+
+### Edit the character file
+
+1. Open `packages/core/src/defaultCharacter.ts` to modify the default character. Uncomment and edit.
+
+2. To load custom characters:
+    - Use `pnpm start --characters="path/to/your/character.json"`
+    - Multiple character files can be loaded simultaneously
+3. Connect with X (Twitter)
+    - change `"clients": []` to `"clients": ["twitter"]` in the character file to connect with X
+
+### Manually Start Eliza
+
+```bash
+pnpm i
+pnpm build
+pnpm start
+
+# The project iterates fast, sometimes you need to clean the project if you are coming back to the project
+pnpm clean
+```
+
+#### Additional Requirements
+
+You may need to install Sharp. If you see an error when starting up, try installing it with the following command:
+
+```
+pnpm install --include=optional sharp
+```
+
+### Community & contact
+
+- [GitHub Issues](https://github.com/elizaos/eliza/issues). Best for: bugs you encounter using Eliza, and feature proposals.
+- [Discord](https://discord.gg/ai16z). Best for: sharing your applications and hanging out with the community.
+
+## Contributors
+
+<a href="https://github.com/elizaos/eliza/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=elizaos/eliza" />
+</a>
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=elizaos/eliza&type=Date)](https://star-history.com/#elizaos/eliza&Date)

README_original.md

@@ -101,7 +101,7 @@ export default {
         if (!isTransferContent(runtime, content)) {
             if (callback) {
                 callback({
-                    text: "look, i need like, the token address and stuff to make this work. it's pretty basic protocol stuff, you know?",
+                    text: "Token address needed to send the token.",
                     content: { error: "Invalid transfer content" },
                 });
             }
@@ -158,7 +158,7 @@ export default {
 
             if (callback) {
                 callback({
-                    text: `yeah so like, i sent ${content.amount} tokens to ${content.recipient}\nhere's the receipt thing: ${signature}`,
+                    text: `Sent ${content.amount} tokens to ${content.recipient}\nTransaction hash: ${signature}`,
                     content: {
                         success: true,
                         signature,
@@ -173,7 +173,7 @@ export default {
             elizaLogger.error("Error during token transfer:", error);
             if (callback) {
                 callback({
-                    text: `uh... there might be a small issue with the transfer: ${error.message}`,
+                    text: `Issue with the transfer: ${error.message}`,
                     content: { error: error.message },
                 });
             }
@@ -192,7 +192,7 @@ export default {
             {
                 user: "{{user2}}",
                 content: {
-                    text: "cool cool, sending those tokens now...",
+                    text: "Sending the tokens now...",
                     action: "SEND_TOKEN",
                 },
             },