Skip to content

Getting Started

To start a new project with Prism, you'll need to create a world and set up your traits. First, import Prism and create your world:

shared/world.luau
1
2
3
4
5
local prism = require(ReplicatedStorage.prism)

local world = prism.world()

return world

Create your components

Next, define your components module

shared/components.luau
1
2
3
4
5
6
local world = require(shared.world)

return {
    alive = world.spawn(),
    energy = world.spawn()
}

Tip

Check this guide to type your components data

Add a trait to the world

Then, define a behavior to your entities

systems/energy.luau
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
local world = require(shared.world)

local components = require(shared.components)
local alive, energy = components.alive, components.energy

world.query(alive, energy) (function(entity, clean)
    -- regenerate 1 energy every second
    local loop = task.spawn(function()
        while task.wait(1) do
            local energy = world.get(entity, energy)
            world.insert(entity, math.min(100, energy + 1))
        end
    end)

    -- cleanup coroutine on remove
    clean(function() task.cancel(loop) end)
end)

return nil

Create an entity

Now, create an entity with some initial energy and the alive component

1
2
3
local player = world.spawn()
world.insert(player, energy, 50)
world.insert(player, alive, true)

Next steps

You can continue by:

  • Defining more components like Health, Speed, Burning, etc.
  • Creating more complex systems like damage over time, status effects, or AI behavior
  • Exploring the internals of the world, query, and assign APIs