# binpacking

> binary tree based bin packing algorithm

Latest version **0.0.1** (published 2012-02-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install binpacking
pnpm add binpacking
yarn add binpacking
bun add binpacking
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2012-02-27 |
| First published | 2012-02-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | * |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 23 |
| Author | Jake Gordon |
| Maintainers | jsmarkus |
| Keywords | bin packing, 2d, geometry, css-sprites |

## Links

- npm: https://www.npmjs.com/package/binpacking
- Repository: https://github.com/jsmarkus/node-bin-packing
- npm.io page: https://npm.io/package/binpacking

## Recent versions

- 0.0.1 (latest) — 2012-02-27

## README

Binary Tree Algorithm for 2D Bin Packing
========================================

This project is a javascript experiment to write a binary tree based
bin packing algorithm that is suitable for generating
[CSS sprites](https://github.com/jakesgordon/sprite-factory).

 * You can play with the [demo here](http://codeincomplete.com/posts/2011/5/7/bin_packing/example/)
 * You can find a [description here](http://codeincomplete.com/posts/2011/5/7/bin_packing/)


NodeJS demo
============

 > Note: the node demo is quick and dirty. Npm support, test suite coming soon...

Clone this repository:

    git clone https://github.com/jsmarkus/node-bin-packing

See usage example: https://github.com/jsmarkus/node-bin-packing/blob/master/node-test.js

Run the demo:

    node node-test.js

Demo
====

Clone this repository

    git clone https://github.com/jsmarkus/node-bin-packing

View the index.html file in your favorite browser for examples of algorithm in use with lots of configurable options.

Usage
=====

If you want to use this in your own javascript projects, you need something like this:

    <script src='packer.growing.js'></script>
    <script>
      var packer = new Packer(1000, 1000);   // or:  new GrowingPacker();
      var blocks = [
        { w: 100, h: 100 },
        { w: 100, h: 100 },
        { w:  80, h:  80 },
        { w:  80, h:  80 },
        etc
        etc
      ];

      blocks.sort(function(a,b) { return (b.h < a.h); }); // sort inputs for best results
      packer.fit(blocks);
  
      for(var n = 0 ; n < blocks.length ; n++) {
        var block = blocks[n];
        if (block.fit) {
          DrawRectangle(block.fit.x, block.fit.y, block.w, block.h);
        }
      }
    </script>

See source code comments for more details.

License
=======

See [LICENSE](https://github.com/jakesgordon/bin-packing/blob/master/LICENSE) file.

Contact
=======

If you have any ideas, feedback, requests or bug reports, you can reach me at
[jake@codeincomplete.com](mailto:jake@codeincomplete.com), or via
my website: [Code inComplete](http://codeincomplete.com/posts/2011/5/7/bin_packing/)

---
_Source: https://npm.io/package/binpacking · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
