Merge branch 'develop' into main

.env.example

@@ -20,6 +20,7 @@ IMAGE_OPENAI_MODEL=             # Default: dall-e-3
 ETERNALAI_URL=
 ETERNALAI_MODEL=                # Default: "neuralmagic/Meta-Llama-3.1-405B-Instruct-quantized.w4a16"
 ETERNALAI_API_KEY=
+ETERNAL_AI_LOG_REQUEST=false #Default: false
 
 GROK_API_KEY=                   # GROK API Key
 GROQ_API_KEY=                   # Starts with gsk_
@@ -43,6 +44,9 @@ LIVEPEER_IMAGE_MODEL=           # Default: ByteDance/SDXL-Lightning
 # Speech Synthesis
 ELEVENLABS_XI_API_KEY=          # API key from elevenlabs
 
+# Transcription Provider
+TRANSCRIPTION_PROVIDER=         # Default: local (possible values: openai, deepgram, local)
+
 # Direct Client Setting
 EXPRESS_MAX_PAYLOAD= # Default: 100kb
 
@@ -67,6 +71,7 @@ TWITTER_POLL_INTERVAL=120       # How often (in seconds) the bot should check fo
 TWITTER_SEARCH_ENABLE=FALSE     # Enable timeline search, WARNING this greatly increases your chance of getting banned
 TWITTER_TARGET_USERS=           # Comma separated list of Twitter user names to interact with
 TWITTER_RETRY_LIMIT=            # Maximum retry attempts for Twitter login
+TWITTER_SPACES_ENABLE=false     # Enable or disable Twitter Spaces logic
 
 X_SERVER_URL=
 XAI_API_KEY=
@@ -162,6 +167,14 @@ LARGE_GAIANET_SERVER_URL=       # Default: https://qwen72b.gaia.domains/v1
 GAIANET_EMBEDDING_MODEL=
 USE_GAIANET_EMBEDDING=          # Set to TRUE for GAIANET/768, leave blank for local
 
+# Volcengine Configuration
+VOLENGINE_API_URL=              # Volcengine API Endpoint, Default: https://open.volcengineapi.com/api/v3/
+VOLENGINE_MODEL=
+SMALL_VOLENGINE_MODEL=          # Default: doubao-lite-128k
+MEDIUM_VOLENGINE_MODEL=         # Default: doubao-pro-128k
+LARGE_VOLENGINE_MODEL=          # Default: doubao-pro-256k
+VOLENGINE_EMBEDDING_MODEL=      # Default: doubao-embedding
+
 # EVM
 EVM_PRIVATE_KEY=
 EVM_PROVIDER_URL=
@@ -341,7 +354,7 @@ AWS_S3_UPLOAD_PATH=
 DEEPGRAM_API_KEY=
 
 # Sui
-SUI_PRIVATE_KEY= # Sui Mnemonic Seed Phrase (`sui keytool generate ed25519`)
+SUI_PRIVATE_KEY= # Sui Mnemonic Seed Phrase (`sui keytool generate ed25519`) , Also support `suiprivatekeyxxxx` (sui keytool export --key-identity 0x63)
 SUI_NETWORK=     # must be one of mainnet, testnet, devnet, localnet
 
 # Story
@@ -356,3 +369,7 @@ CRONOSZKEVM_PRIVATE_KEY=
 
 # Fuel Ecosystem (FuelVM)
 FUEL_WALLET_PRIVATE_KEY=
+
+# Tokenizer Settings
+TOKENIZER_MODEL=  # Specify the tokenizer model to be used.
+TOKENIZER_TYPE=   # Options: tiktoken (for OpenAI models) or auto (AutoTokenizer from Hugging Face for non-OpenAI models). Default: tiktoken.

.github/pull_request_template.md

@@ -1,15 +1,15 @@
-<!-- Use this template by filling in information and copy and pasting relevant items out of the html comments. -->
+<!-- Use this template by filling in information and copying and pasting relevant items out of the HTML comments. -->
 
-# Relates to:
+# Relates to
 
 <!-- LINK TO ISSUE OR TICKET -->
 
-<!-- This risks section is to be filled out before final review and merge. -->
+<!-- This risks section must be filled out before the final review and merge. -->
 
 # Risks
 
 <!--
-Low, medium, large. List what kind of risks, and what could be effected.
+Low, medium, large. List what kind of risks and what could be affected.
 -->
 
 # Background
@@ -25,7 +25,7 @@ Features (non-breaking change which adds functionality)
 Updates (new versions of included code)
 -->
 
-<!-- This "Why" section is most relevant if there is no linked issue explaining why. If there is a related issue it might make sense to skip this why section. -->
+<!-- This "Why" section is most relevant if there are no linked issues explaining why. If there is a related issue, it might make sense to skip this why section. -->
 <!--
 ## Why are we doing this? Any context or related work?
 -->
@@ -35,10 +35,10 @@ Updates (new versions of included code)
 <!--
 My changes do not require a change to the project documentation.
 My changes require a change to the project documentation.
-If a docs change is needed: I have updated the documentation accordingly.
+If documentation change is needed: I have updated the documentation accordingly.
 -->
 
-<!-- Please show how you tested the PR. This will really help if the PR needs to be retested, and probably help the PR get merged quicker. -->
+<!-- Please show how you tested the PR. This will really help if the PR needs to be retested and probably help the PR get merged quicker. -->
 
 # Testing
 
@@ -47,7 +47,7 @@ If a docs change is needed: I have updated the documentation accordingly.
 ## Detailed testing steps
 
 <!--
-None, automated tests are fine.
+None: Automated tests are acceptable.
 -->
 
 <!--
@@ -63,22 +63,22 @@ None, automated tests are fine.
 ### After
 -->
 
-<!-- If there is anything about the deploy, please make a note. -->
+<!-- If there is anything about the deployment, please make a note. -->
 <!--
 # Deploy Notes
 -->
 
-<!--  Copy and paste commandline output. -->
+<!--  Copy and paste command line output. -->
 <!--
 ## Database changes
 -->
 
-<!--  If there is something more than the automated steps, please specifiy deploy instructions. -->
+<!--  Please specify deploy instructions if there is something more than the automated steps. -->
 <!--
 ## Deployment instructions
 -->
 
-<!-- If you are on Discord, please join https://discord.gg/ai16z and state your Discord username here for contribute role and join us in #development-feed -->
+<!-- If you are on Discord, please join https://discord.gg/ai16z and state your Discord username here for the contributor role and join us in #development-feed -->
 <!--
 ## Discord username
 

.github/workflows/integrationTests.yaml

@@ -24,8 +24,11 @@ jobs:
                   node-version: "23"
                   cache: "pnpm"
 
+            - name: Clean up
+              run: pnpm clean
+
             - name: Install dependencies
-              run: pnpm install -r
+              run: pnpm install -r --no-frozen-lockfile
 
             - name: Build packages
               run: pnpm build

.github/workflows/jsdoc-automation.yml

@@ -22,6 +22,11 @@ on:
         required: true
         default: ''
         type: string
+      branch:
+        description: 'Target branch for PR (defaults to develop)'
+        required: false
+        default: 'develop'
+        type: string
 
 jobs:
   generate-docs:
@@ -49,7 +54,7 @@ jobs:
           run_install: false
 
       - name: Update lockfile
-        working-directory: packages/jsdoc-automation
+        working-directory: scripts/jsdoc-automation
         run: |
           echo "Updating lockfile..."
           pnpm install --no-frozen-lockfile
@@ -63,11 +68,11 @@ jobs:
         run: pnpm install --no-frozen-lockfile
 
       - name: Install package dependencies
-        working-directory: packages/jsdoc-automation
+        working-directory: scripts/jsdoc-automation
         run: pnpm install --no-frozen-lockfile
 
       - name: Run documentation generator
-        working-directory: packages/jsdoc-automation
+        working-directory: scripts/jsdoc-automation
         run: |
           echo "Node version: $(node --version)"
           echo "NPM version: $(npm --version)"
@@ -78,4 +83,5 @@ jobs:
           INPUT_ROOT_DIRECTORY: ${{ inputs.root_directory }}
           INPUT_PULL_NUMBER: ${{ inputs.pull_number }}
           INPUT_EXCLUDED_DIRECTORIES: ${{ inputs.excluded_directories }}
-          INPUT_REVIEWERS: ${{ inputs.reviewers }}
+          INPUT_REVIEWERS: ${{ inputs.reviewers }}
+          INPUT_BRANCH: ${{ inputs.branch }}

.github/workflows/stale.yml

@@ -12,13 +12,23 @@ jobs:
       issues: write
       pull-requests: write
 
+    env:
+      DAYS_BEFORE_STALE: 30  # Define the days-before-stale value
+      DAYS_BEFORE_CLOSE: 7   # Define the days-before-close value
+
     steps:
     - uses: actions/stale@v5
       with:
         repo-token: ${{ secrets.GITHUB_TOKEN }}
-        stale-issue-message: 'This issue has been automatically marked as stale due to inactivity.'
-        stale-pr-message: 'This pull request has been automatically marked as stale due to inactivity.'
+        stale-issue-message: |
+          This issue has been automatically marked as stale due to ${{
+          env.DAYS_BEFORE_STALE }} days of inactivity.
+          If no further activity occurs within ${{ env.DAYS_BEFORE_CLOSE }} days, it will be closed automatically. Please take action if this issue is still relevant.
+        stale-pr-message: |
+          This pull request has been automatically marked as stale due to ${{
+          env.DAYS_BEFORE_STALE }} days of inactivity.
+          If no further activity occurs within ${{ env.DAYS_BEFORE_CLOSE }} days, it will be closed automatically. Please take action if this pull request is still relevant.
         stale-issue-label: 'no-issue-activity'
         stale-pr-label: 'no-pr-activity'
-        days-before-stale: 30  # Marks issues and PRs as stale after X days of inactivity
-        days-before-close: 7  # Closes issues and PRs X days after being marked as stale
+        days-before-stale: ${{ env.DAYS_BEFORE_STALE }}  
+        days-before-close: ${{ env.DAYS_BEFORE_CLOSE }}  

.gitignore

@@ -1,56 +1,57 @@
-node_modules
-/out
-
-.env
-.env.production
-.env.local
-.env_main
-concatenated-output.ts
-embedding-cache.json
-packages/plugin-buttplug/intiface-engine
-
-.idea
-.DS_Store
-
-dist/
-# Allow models directory but ignore model files
-models/*.gguf
-
-cookies.json
-
-db.sqlite
-searches/
-tweets/
-
-*.gguf
-*.onnx
-*.wav
-*.mp3
-
-logs/
-
-test-report.json
-content_cache/
-test_data/
-tokencache/
-tweetcache/
-twitter_cookies.json
-timeline_cache.json
-
-*.sqlite
-
-characters/
-
-packages/core/src/providers/cache
-packages/core/src/providers/cache/*
-cache/*
-packages/plugin-coinbase/src/plugins/transactions.csv
-
-tsup.config.bundled_*.mjs
-
-.turbo
-
-coverage
-.eslintcache
-
-agent/content
+node_modules
+/out
+
+.env
+.env.production
+.env.local
+.env_main
+concatenated-output.ts
+embedding-cache.json
+packages/plugin-buttplug/intiface-engine
+
+.idea
+.DS_Store
+
+dist/
+# Allow models directory but ignore model files
+models/*.gguf
+
+cookies.json
+
+db.sqlite
+searches/
+tweets/
+
+*.gguf
+*.onnx
+*.wav
+*.mp3
+
+logs/
+
+test-report.json
+content_cache/
+test_data/
+tokencache/
+tweetcache/
+twitter_cookies.json
+timeline_cache.json
+
+*.sqlite
+
+characters/
+
+packages/core/src/providers/cache
+packages/core/src/providers/cache/*
+cache/*
+packages/plugin-coinbase/src/plugins/transactions.csv
+
+tsup.config.bundled_*.mjs
+
+.turbo
+.cursorrules
+
+coverage
+.eslintcache
+
+agent/content

CHANGELOG.md

@@ -1363,4 +1363,4 @@
 
 
 
-\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

README.md

@@ -12,7 +12,13 @@
 
 ## 🌍 README Translations
 
-[中文说明](./README_CN.md) | [日本語の説明](./README_JA.md) | [한국어 설명](./README_KOR.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)
+[中文说明](./README_CN.md) | [日本語の説明](./README_JA.md) | [한국어 설명](./README_KOR.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)
+
+## 🚩 Overview
+
+<div align="center">
+  <img src="./docs/static/img/eliza_diagram.jpg" alt="Eliza Diagram" width="100%" />
+</div>
 
 ## ✨ Features
 
@@ -55,8 +61,10 @@ cd eliza-starter
 cp .env.example .env
 pnpm i && pnpm build && pnpm start
 ```
-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. 
+
+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.
+
 ```bash
 pnpm start:client
 ```
@@ -86,11 +94,12 @@ Copy .env.example to .env and fill in the appropriate values.
 cp .env.example .env
 ```
 
-Note: .env is optional. If your planning to run multiple distinct agents, you can pass secrets through the character JSON
+Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON
+Note: .env is optional. If you're planning to run multiple distinct agents, you can pass secrets through the character JSON
 
 ### Automatically Start Eliza
 
-This will run everything to setup the project and start the bot with the default character.
+This will run everything to set up the project and start the bot with the default character.
 
 ```bash
 sh scripts/start.sh