Skip to content

Core Blenderfarm module and minimal command-line client and server.

Notifications You must be signed in to change notification settings

blenderfarm/core

Repository files navigation

Blenderfarm

Distributed Blender renderfarm software. There are no "official" servers; you must host your own server and render nodes.

Important notes

This is alpha software, and backwards compatibility is not expected at this point. Do not use this in any production system (obviously).

Usage

Run bf.py. If you start a server, databases will be created in the directory you're currently in.

To start a blenderfarm server, run bf.py server. If you're stuck, use bf.py help.

Terminology

Server

The Blenderfarm server. This does no real work other than accept new Jobs from clients and divvy them up into Tasks to send to render nodes.

Client

Something that connects to the server. It might upload new jobs; it might perform tasks; or it might do both.

Node

Performs the actual work, one task at a time.

Job

A single "thing", such as a single still image or an animation. The server will attempt to break a single job into multiple tasks; for example, an animation can be rendered by multiple clients, one for each frame.

Task

A single, atomic operation. Clients are given one task at a time, along with all the necessary data (such as .blend files); they execute the task, then upload the finished data to the server.

Example

A user uploads a new .blend file, a 30-frame animation, using blenderfarm-web-server. The server sees that it's an animation and creates 30 tasks. As soon as a client implementing node requests a new task, the server sends a frame render task, along with all the necessary data. Each render node then renders its own frame, then uploads the resulting frame to the server. When all the tasks are complete, the job is marked as complete and the client is notified.

About

Core Blenderfarm module and minimal command-line client and server.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published