Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion core-concepts/plugins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export const myPlugin: Plugin = {

## Core Plugin: Bootstrap

Every agent includes `@elizaos/plugin-bootstrap` which provides essential functionality for message handling, knowledge management, and basic agent operations. For detailed information, see the [Bootstrap Plugin Deep Dive](/plugins/bootstrap/complete-documentation).
Every agent includes `@elizaos/plugin-bootstrap` which provides essential functionality for message handling, knowledge management, and basic agent operations. For detailed information, see the [Bootstrap Plugin Deep Dive](/plugins/bootstrap/complete-documentation.mdx).

## Platform Plugins

Expand Down
10 changes: 10 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,16 @@
"plugins/platform/twitter/examples",
"plugins/platform/twitter/testing-guide"
]
},
{
"group": "Farcaster",
"pages": [
"plugins/platform/farcaster",
"plugins/platform/farcaster/developer-guide",
"plugins/platform/farcaster/cast-flow",
"plugins/platform/farcaster/examples",
"plugins/platform/farcaster/testing-guide"
]
}
]
},
Expand Down
4 changes: 2 additions & 2 deletions guides/plugin-migration/advanced-migration-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: "Advanced breaking changes for evaluators, services, and runtime me
icon: "code"
---

> **Important**: This guide covers advanced breaking changes for evaluators, services, and runtime methods. Read the main [migration guide](./migration-guide) first for actions, providers, and basic migrations.
> **Important**: This guide covers advanced breaking changes for evaluators, services, and runtime methods. Read the main [migration guide](./migration-guide.mdx) first for actions, providers, and basic migrations.

## Table of Contents

Expand Down Expand Up @@ -458,6 +458,6 @@ class MyClient extends Service {

If you encounter issues not covered in this guide:

1. Check the main [migration guide](./migration-guide) for basic migrations
1. Check the main [migration guide](./migration-guide.mdx) for basic migrations
2. Review the v1.x examples in the elizaOS repository for reference implementations
3. Join our Discord community for support
4 changes: 2 additions & 2 deletions guides/plugin-migration/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This comprehensive guide will walk you through migrating your elizaOS plugins fr

Follow these guides in order for a smooth migration:

### 1. [Migration Overview](./migration-guide)
### 1. [Migration Overview](./migration-guide.mdx)
Start here! This guide covers:
- Key differences between 0.x and 1.x
- Breaking changes and new features
Expand Down Expand Up @@ -130,4 +130,4 @@ The 1.x architecture brings:
- **Better performance** - Optimized runtime execution
- **Stronger typing** - Catch errors at compile time

Start with the [Migration Overview](./migration-guide) and work through each guide systematically for the best results!
Start with the [Migration Overview](./migration-guide.mdx) and work through each guide systematically for the best results!
5 changes: 5 additions & 0 deletions images/icons/farcaster.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions plugins/bootstrap.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ Welcome to the comprehensive documentation for the `@elizaos/plugin-bootstrap` p

### Core Documentation

- **[Complete Developer Documentation](/plugins/bootstrap/complete-documentation)**
- **[Complete Developer Documentation](/plugins/bootstrap/complete-documentation.mdx)**
Comprehensive guide covering all components, architecture, and implementation details

- **[Message Flow Diagram](/plugins/bootstrap/message-flow)**
- **[Message Flow Diagram](/plugins/bootstrap/message-flow.mdx)**
Step-by-step breakdown of how messages flow through the system with visual diagrams

- **[Examples & Recipes](/plugins/bootstrap/examples)**
- **[Examples & Recipes](/plugins/bootstrap/examples.mdx)**
Practical examples, code snippets, and real-world implementations

- **[Testing Guide](/plugins/bootstrap/testing-guide)**
- **[Testing Guide](/plugins/bootstrap/testing-guide.mdx)**
Testing patterns, best practices, and comprehensive test examples


Expand Down
8 changes: 4 additions & 4 deletions plugins/defi/evm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ The plugin includes comprehensive error handling for common scenarios:

## Next Steps

- [Complete Documentation →](./evm/complete-documentation)
- [DeFi Operations Flow →](./evm/defi-operations-flow)
- [Examples →](./evm/examples)
- [Testing Guide →](./evm/testing-guide)
- [Complete Documentation →](./evm/complete-documentation.mdx)
- [DeFi Operations Flow →](./evm/defi-operations-flow.mdx)
- [Examples →](./evm/examples.mdx)
- [Testing Guide →](./evm/testing-guide.mdx)
6 changes: 3 additions & 3 deletions plugins/defi/solana.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,6 @@ The plugin includes robust error handling for:
## Next Steps

- [Complete Documentation →](./solana/complete-documentation.mdx)
- [DeFi Operations Flow →](./solana/defi-operations-flow)
- [Examples →](./solana/examples)
- [Testing Guide →](./solana/testing-guide)
- [DeFi Operations Flow →](./solana/defi-operations-flow.mdx)
- [Examples →](./solana/examples.mdx)
- [Testing Guide →](./solana/testing-guide.mdx)
10 changes: 5 additions & 5 deletions plugins/llm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -232,14 +232,14 @@ You can also configure API keys per character:

### Cloud Providers

- [OpenAI Plugin](./openai) - Full-featured with all model types
- [Anthropic Plugin](./anthropic) - Claude models for text generation
- [Google GenAI Plugin](./google-genai) - Gemini models
- [OpenRouter Plugin](./openrouter) - Access to multiple providers
- [OpenAI Plugin](./openai.mdx) - Full-featured with all model types
- [Anthropic Plugin](./anthropic.mdx) - Claude models for text generation
- [Google GenAI Plugin](./google-genai.mdx) - Gemini models
- [OpenRouter Plugin](./openrouter.mdx) - Access to multiple providers

### Local/Self-Hosted

- [Ollama Plugin](./ollama) - Run models locally with Ollama
- [Ollama Plugin](./ollama.mdx) - Run models locally with Ollama

## Best Practices

Expand Down
6 changes: 5 additions & 1 deletion plugins/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Blockchain and DeFi integrations for Web3 functionality:

Connect your agent to popular platforms:

<CardGroup cols={3}>
<CardGroup cols={2}>
<Card title="Discord" icon="discord" href="/plugins/platform/discord">
Full Discord integration with voice, commands, and rich interactions.
</Card>
Expand All @@ -56,6 +56,10 @@ Connect your agent to popular platforms:
<Card title="Twitter" icon="twitter" href="/plugins/platform/twitter">
Twitter/X integration for posting, replying, and timeline management.
</Card>

<Card title="Farcaster" icon="/images/icons/farcaster.svg" href="/plugins/platform/farcaster">
Farcaster social network integration with casting and engagement.
</Card>
</CardGroup>

## LLM Providers
Expand Down
29 changes: 29 additions & 0 deletions plugins/platform/farcaster.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: "Farcaster Integration"
description: "Welcome to the comprehensive documentation for the @elizaos/plugin-farcaster package. This index provides organized access to all documentation resources."
---


The @elizaos/plugin-farcaster enables your elizaOS agent to interact with the Farcaster social network through casting, replying, and engaging with the decentralized social protocol.

## 📚 Documentation

- **[Developer Guide](./farcaster/developer-guide.mdx)** - Detailed technical reference
- **[Cast Flow](./farcaster/cast-flow.mdx)** - Visual guide to cast processing
- **[Examples](./farcaster/examples.mdx)** - Practical implementation examples
- **[Testing Guide](./farcaster/testing-guide.mdx)** - Testing strategies and patterns

## 🔧 Configuration

### Required Settings
- `FARCASTER_NEYNAR_API_KEY` - Neynar API key for authentication
- `FARCASTER_SIGNER_UUID` - Neynar signer UUID for your account
- `FARCASTER_FID` - Your Farcaster ID (FID)

### Optional Settings
- `ENABLE_CAST` - Enable autonomous casting (default: true)
- `ENABLE_ACTION_PROCESSING` - Enable processing interactions (default: false)
- `FARCASTER_DRY_RUN` - Test mode without posting (default: false)
- `CAST_INTERVAL_MIN` - Minimum interval between casts in minutes (default: 90)
- `CAST_INTERVAL_MAX` - Maximum interval between casts in minutes (default: 180)
- `ACTION_TIMELINE_TYPE` - Type of timeline to use for actions (default: ForYou)
Loading