Blenderlorama - Blender-Pixelorama Bridge

Overview

Blender Pixel Sync enables artists to work with pixel art textures in Blender while having real-time synchronization with Pixelorama. The tool provides pixel-perfect UV unwrapping, texture management, and live updates between both applications.

Github Repo: https://github.com/yuchenyang1994/blendlorama

---

Features
Blender Addon (blender-part/)

• WebSocket Server: Real-time communication server for data synchronization
• Pixel-Perfect UV Unwrapping: Specialized UV unwrapping algorithms for pixel art
• Texture Management: Automatic texture detection, loading, and management
• UV Export/Import: Export UV layouts to Pixelorama and import back with modifications
• Image State Monitoring: Real-time monitoring of image changes in Blender
• World Grid Tools: Specialized grid setup for pixel art workflow
• Checker Texture Generation: Create checker patterns for texture testing

Pixelorama Extension (blender-lorama/)

• WebSocket Client: Connects to Blender's WebSocket server
• UV Overlay: Visual overlay showing Blender UV layouts in Pixelorama
• Texture Export: Export modified textures back to Blender
• Sync Panel: User interface for managing synchronization settings
• Real-time Updates: Live updates when textures change in Blender

---

Installation
Blender Addon Installation

1. Download the blender-part.zip file
2. In Blender, go to Edit > Preferences > Add-ons
3. Click "Install..." and select the zip file
4. Enable the "Pixelorama Sync" addon

Pixelorama Extension Installation

1. Download BlenderPixelorama.pck file
2. Open Pixelorama
3. Go to Preferences > Extensions > Install Extension
4. Select the pre-packaged .pck file
5. The "BlenderPixelorama" extension will be installed automatically

---

Usage
Setting up the Workflow

1. Start the Blender Server:
   • In Blender, open the Image Editor
   • Go to the "Pixelorama Sync" panel (Image Editor > UI Panel > Pixelorama Sync)
   • Click "Start Server" to begin the WebSocket server
2. Connect from Pixelorama:
   • In Pixelorama, the Blender Pixel Sync panel will appear as a new tab
   • The extension will automatically attempt to connect to Blender
   • Connection status will be displayed in the panel
3. Prepare Your Model:
   • Create or import your 3D model in Blender
   • Apply materials and UV unwrapping
   • Use the pixel-perfect unwrapping tools for optimal results

Working with Textures

1. Export UV Layout:
   • Select your object in Blender
   • Use the UV tools to export the layout to Pixelorama
   • The UV layout will appear as an overlay in Pixelorama
2. Create/Edit Textures:
   • Design your pixel art texture in Pixelorama
   • Use the UV overlay as a guide for precise placement
   • The grid setup ensures pixel-perfect alignment
3. Sync Changes:
   • Changes in Pixelorama can be exported back to Blender
   • Blender will automatically update the texture
   • Real-time synchronization keeps both applications in sync

Recommended Workflow

1. Model Setup:
   • Create your low-poly model in Blender
   • Use the "Setup World Grid" tool for proper pixel art scaling
   • Set grid subdivisions based on your pixel density requirements
2. UV Unwrapping:
   • Use "Pixel Perfect Unwrap" for clean, pixel-aligned UVs
   • Or use "Unwrap to Grid" for grid-based UV layouts
   • Check UVs in the UV Editor for proper alignment
3. Texture Creation:
   • Export UV layout to Pixelorama
   • Create pixel art texture following the UV guides
4. Final Integration:
   • Export texture back to Blender
   • Apply to model and test in 3D view
   • Make adjustments as needed in either application

---

Blender Panel UI

The Blender addon provides several panels:

Server Panel

• Start/Stop Server: Control the WebSocket server
• Connection Status: Shows connected clients and server status
• Port Information: Display server connection details

UV Tools Panel

• Pixel Perfect Unwrap: Unwrap UVs with pixel-perfect precision
• Unwrap to Grid: Create grid-based UV layouts
• Export UV: Send UV data to Pixelorama

Texture Tools Panel

• Check Texture: Validate texture dimensions and format
• Create Checker: Generate checker pattern textures
• Reload Textures: Refresh textures from disk

World Grid Panel

• Setup World Grid: Configure Blender's grid for pixel art
• Grid Subdivisions: Adjust grid density
• Scale Settings: Set appropriate scale for pixel work

---

Compatibility
Blender

• Version: Blender 4.5.0 and later
• Platform: Windows, macOS, Linux

Pixelorama

• Version: Supports Pixelorama API version 8
• Platform: Windows, macOS, Linux

---

Technical Details
Communication Protocol

• WebSocket: Real-time bidirectional communication
• JSON Message Format: Structured data exchange
• Event-Driven: Automatic updates on changes

Supported Features

• Image Formats: PNG, JPG, BMP, and other Blender-supported formats
• UV Coordinates: Full UV map synchronization