Skip to content

README.md

Latest commit

 

History

History
54 lines (34 loc) · 1.83 KB

README.md

File metadata and controls

54 lines (34 loc) · 1.83 KB
Raw

Community Projects

Welcome to the Blender MCP community! This folder is a space for users to share their creative works, recorded sessions, and documentation.

Important

Core Philosophy: A session should replay successfully on a fresh Blender file. This ensures your contribution is portable and works for everyone.

How to Share Your Project

Before uploading, you need to export a clean recording of your build. Follow this 3-step pipeline:

1) Record a Session

Start the MCP server in recording mode:

python -m src.main serve --record my_session.json --name "My Project"

Then build your scene using n8n or your AI agent as usual. Every modeling command will automatically be saved. When finished, stop the server — your session.json is ready.

Tip

Record only the final successful build. Avoid recording failed experiments to keep sessions clean.

2. Clean the Recording (Recommended)

Large or messy sessions make playback slow for others. Use Studio to tidy it:

  1. Run the Bridge Server, then open http://localhost:8008/studio/ (or cd studio && npm run dev for hot-reload).
  2. Load your session.json.
  3. Delete mistakes or unnecessary commands.
  4. Export JSON to save the cleaned file.

This keeps the community gallery fast and reliable.

3) Upload Your Project

Create a new folder in community/ with the following structure:

community/your_project/
├── README.md           # Instructions and documentation
├── session.json        # The cleaned MCP session
└── assets/
    └── images/        # screenshots, renders, etc.

Then open a Pull Request 🚀

Scaling Up

As the community grows, we may transition from a folder-based structure to an indexed gallery (e.g., a database-backed catalog such as Firestore) to better showcase projects.