1.1.1 • Published 8 years ago

boids-canvas v1.1.1

Weekly downloads
4
License
MIT
Repository
github
Last release
8 years ago

BoidsCanvas

Overview

A sexy looking HTML5 and Javascript implementation of Craig Reynold's boids algorithm for flocking behaviour. Fully plug n' play, modular and customisable.

See it live on CodePen

Go ahead and fork the repo and open demo.html to give it a go!

Usage

Clone the repository to get started. Use this animation on your webpage simply by:

<body>
  <div id="boids-canvas"></div>
  <script type="text/javascript" src="boids-canvas.js"></script>
  <script type="text/javascript">
    var boidsCanvas = new BoidsCanvas(canvasDiv, options);
  </script>
</body>

A number of options are supported:

var options = {
  background: '#ecf0f1',
  density: 'medium',
  speed: 'medium',
  interactive: true,
  mixedSizes: true,
  boidColours: ["#34495e", "#e74c3c", '#2ecc71', '#9b59b6', '#f1c40f', '#1abc9c']
};
var canvasDiv = document.getElementById('boids-canvas');

Options

  • background: specify a hexadecimal colour (as a string) or an image path
  • density: can take values low, medium or high. Defaults to medium.
  • speed: can take values slow, medium or fast. Defaults to medium.
  • interactive: can take values true or false. When true, boids will be attracted to the mouse pointer. Defaults to true.
  • mixedSizes: can take values true or false. When true, boids will be of varying sizes - larger boids even have more inertia. Defaults to true.
  • boidColours: an array of hexadecimal colours (as strings) specifying the colours boids can take (assigned randomly). Defaults to all boids #ff3333