Skip to main content

@react-ecs/core overview

For API documentation check here.

Intro#

This documentation will cover all the concepts you'll need to use react-ecs.

@react-ecs/core is the primary library in our ecosystem, containing the hooks and components needed to build your ECS.

While @react-ecs/core is render agnostic, it comes with stuff for working with the DOM built in. Other libraries provide render specific integrations. Check out @react-ecs/three for working with ThreeJS scenes.

Installation#

To install:

npm install @react-ecs/core

Or:

yarn add @react-ecs/core

Peer Dependencies#

@react-ecs/core has a number of Peer Dependencies you'll need to install too:

yarn add react react-dom mobx mobx-react

But you may already have these.