https://github.com/fildon/boid-flock

https://github.com/fildon/boid-flock

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/fildon/boid-flock
• Owner: fildon
• Created: 2021-07-19T16:36:45.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2021-08-07T09:07:48.000Z (almost 5 years ago)
• Last Synced: 2025-12-30T14:35:50.385Z (6 months ago)
• Language: TypeScript
• Size: 554 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Boid Flock

A React component to render a boids simulation anywhere

![Demo gif](https://raw.githubusercontent.com/fildon/boid-flock/main/static/boid-flock.gif)

## Installation

```shell

npm add 'boid-flock'

```

## Usage

```ts

import { BoidFlock } from "boid-flock";

export function YourComponent() {

  return (

    

      You can render whatever you like in here

    

  );

}

```

Optionally you can pass a `boidCount` prop to the component to control the number of boids rendered.

```ts

import { BoidFlock } from "boid-flock";

export function YourComponent() {

  return (

    

      
There's only 3 boids in my background

    

  );

}

```