Welcome to Binacle.Net Docs

Binacle.Net answers which box an order goes in, in milliseconds. Give it your box sizes and a list of items and it returns the smallest box that holds them, and where every item sits. It is a free and open source 3D bin packing API that you run yourself, shipped as a Docker image.

These docs cover the HTTP API, configuration, deployment, and the ViPaq result format. If you just want to see it work, start with the quick start.

🚀 Quick Start

Get up and running quickly with the essential steps to use Binacle.Net.

🔍 Core Concepts

How the algorithms work, and which one to pick.

🔧 Configuration Basics

Understand how to customize Binacle.Net to fit your specific needs through its flexible configuration system.

🔗 Integration Guide

Step-by-step instructions for integrating Binacle.Net into your platform.

📚 Versions

Access documentation for different versions of Binacle.Net to ensure compatibility and leverage new features.

🗜️ ViPaq Protocol

Understand the compact encoding format for sharing packing information efficiently.