Installation

Install jecs using npm, yarn, pnpm, or Wally for Roblox projects

Installation

jecs is available through multiple package managers, making it easy to integrate into your Luau or Roblox TypeScript project.

Package Managers

npm

Install jecs using npm:

npm install @rbxts/jecs

This package is published as @rbxts/jecs version 0.10.3 and includes TypeScript definitions.

yarn

Install jecs using yarn:

yarn add @rbxts/jecs

pnpm

Install jecs using pnpm:

pnpm add @rbxts/jecs

Wally

For Roblox projects using Wally, add jecs to your wally.toml:

wally.toml

[dependencies]
jecs = "ukendio/jecs@0.10.3"

Then install dependencies:

wally install

The Wally package is published under ukendio/jecs and is available in the shared realm, making it compatible with both client and server scripts.

Roblox Studio

If you prefer to work directly in Roblox Studio without a package manager, you can download a pre-built model file:

1. Download the model

   Download the latest model file from GitHub Actions.

2. Extract the archive

   Extract the downloaded ZIP file to access the .rbxm model file.

3. Import into Studio

   In Roblox Studio, right-click on ReplicatedStorage (or your preferred location) and select “Insert from File”, then choose the extracted model file.

Verify Installation

Once installed, verify that jecs is working correctly:

Luau

local jecs = require(path.to.jecs)
local world = jecs.world()

print("jecs installed successfully!")
print(`World created: {world}`)

Package Information

• Current Version: 0.10.3
• License: MIT
• Repository: github.com/Ukendio/jecs
• Author: Ukendio
• Contributors: Ukendio, EncodedVenom

Next Steps

Now that you have jecs installed, head over to the Quickstart guide to learn how to create your first ECS world and start building with entities and components.

jecs has zero dependencies, so the installation is lightweight and won’t bloat your project.