This repository contains comprehensive instructions for implementing Farcaster Frames V2 in various project types. These files are designed to be used as context for LLMs (like ChatGPT, Claude, etc.) to help them understand and assist with Frames V2 integration.
Drop these instruction files into your project and use them as context when asking an LLM to help you implement Frames V2 functionality. The LLM will be able to understand the context of how to create Frame V2 integrations based on these files.
This repository includes the following instruction files for different project types:
- LLM_INSTRUCTIONS_vanilla_js.md - Instructions for implementing Frames V2 in a vanilla JavaScript project with a bundler
- LLM_INSTRUCTIONS_nextjs.md - Instructions for implementing Frames V2 in a Next.js project
- LLM_INSTRUCTIONS_static_html.md - Instructions for implementing Frames V2 in a static HTML project without a bundler
Each file contains:
- Specific setup instructions for that project type
- Examples of how to import and use the SDK
- Common patterns and best practices
- A shared reference section with API details and common use cases
Here are some additional resources for working with Frames V2:
- Frame V2 Specification - The complete Frame V2 specification, including many more actions than those covered in the instruction files
- Warpcast Intents - Documentation for Warpcast Composer Intents
- Local Debugging - Documentation for using the local framesjs debugger (so you don't have to use ngrok)
- Deploying and Debugging Frames V2 - A guide for deploying and debugging your frame
- Custom Share Images - Instructions for implementing custom share images
- Clone this repository or download the specific instruction file for your project type
- Include the file in your project or provide it as context to your LLM
- When asking the LLM for help with Frames V2 integration, reference the instruction file so it has the proper context
Feel free to submit pull requests to improve the instruction files or add instructions for additional project types.