{"id":"mark-marks/rubine","name":"rubine","scope":"mark-marks","platform":"roblox","description":"Mirrored from the Wally registry.","version":"0.2.0","latest":"0.2.0","versions":["0.1.0-rc.2","0.1.0-rc.3","0.1.0-rc.4","0.1.0-rc.5","0.1.0-rc.6","0.1.0-rc.7","0.1.0-rc.8","0.2.0","0.3.0-alpha.0"],"license":"MIT","licenseRating":"safe","licenseCaveats":[],"licenseVerified":true,"dependencies":{"ukendio/jecs":{"version":"^0.5.3","alias":"jecs"}},"integrity":"6a98b6ac3f640805be8fb2da45bc6d84347ced14cc2ad6b7a57e578d650d9ccf","likes":0,"downloads":0,"install":"forest install mark-marks/rubine","url":"https://forest.dev/p/roblox/mark-marks/rubine","files":"https://api.forest.dev/ai/package/roblox/mark-marks/rubine/files","readme":"

\r\n \r\n

\r\n\r\n[![CI](https://img.shields.io/github/actions/workflow/status/mark-marks/rubine/ci.yml?style=for-the-badge&label=CI)](https://github.com/mark-marks/rubine/actions/workflows/ci.yml)\r\n[![License: MIT](https://img.shields.io/badge/license-MIT-blue?style=for-the-badge)](https://github.com/Mark-Marks/rubine/blob/main/LICENSE)\r\n\"Wally\"\r\n\"Pesde\"\r\n[![Typescript Version](https://img.shields.io/npm/v/@rbxts/rubine.svg?style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@rbxts/rubine)\r\n\r\nAn ergonomic, runtime agnostic scheduler for [Jecs](https://github.com/ukendio/jecs)\r\n
\r\n\r\n\r\n\r\n## Features\r\n\r\n### 1. Phases\r\nRubine uses phases to bind systems to events and order them.\r\n\r\nPhases live in rubine's Jecs world, having the `Phase` tag, and either the `Event` component or a dependant pair (`pair(DependsOn, another_phase)`).\r\n\r\nPhases can be ordered implicitly:\r\n```luau\r\nlocal event = signal()\r\nlocal my_phase = scheduler.phase(\"my_phase\", event)\r\nlocal my_phase_b = scheduler.phase(\"my_phase_b\", event) -- Ordered after `my_phase`\r\n```\r\nor explicitly:\r\n```luau\r\nlocal event = signal()\r\nlocal my_phase = scheduler.phase(\"my_phase\", event)\r\nlocal my_phase_b = scheduler.phase(\"my_phase_b\", my_phase) -- Ordered after `my_phase`\r\n```\r\nMultiple phases cannot be bound to the same event, but instead depend on one another.\r\n\r\n### 2. Systems\r\nSystems are bound to phases. Whenever an event the system is (indirectly) on is fired, it's ran.\r\n\r\nSystems live in rubine's Jecs world, having the `System` component describing it, and a pair describing what phase it runs on (`pair(DependsOn, phase)`).\r\n\r\nSystems are created with `scheduler.on`:\r\n```luau\r\nlocal function system()\r\nend\r\n\r\nlocal my_system = scheduler.on(my_phase, system)\r\n```\r\ncan have their execution paused:\r\n```luau\r\nscheduler.pause(my_system)\r\n```\r\nand unpaused:\r\n```luau\r\nscheduler.unpause(my_system)\r\n```\r\n\r\nSystems also contain data about the moment they started running and ended, being reset on every run.\r\n```luau\r\ntype System = {\r\n run: (...any) -> (),\r\n paused: boolean,\r\n frame_start: number,\r\n frame_end: number,\r\n}\r\n```\r\n\r\nSystems cannot yield without `_G.__RUBINE_DEBUG_MODE` being true.\r\n\r\n### 3. Hooks\r\nHooks are available via the `abstractions` module.\r\nUnder the hood, they use Jecs hooks to observe changes to the world and run user defined callbacks on them.\r\n\r\nWith them, you can hook onto system calls\r\n```luau\r\nabstractions.hook(\"SystemCall\", function(system_id: Entity, system_data: System, previous_data: System)\r\nend)\r\n```\r\nsystem additions\r\n```luau\r\nabstractions.hook(\"SystemAdd\", function(system_id: Entity, system_data: System)\r\nend)\r\n```\r\nsystem removals\r\n```luau\r\nabstractions.hook(\"SystemRemove\", function(system_id: Entity)\r\nend)\r\n```\r\nand all system changes\r\n```luau\r\nabstractions.hook(\"SystemChange\", function(systme_id: Entity, system_data: System, previous_data: System)\r\nend)\r\n```\r\n\r\n### 4. Pipes\r\nPipes are a tiny abstraction over phases, mainly meant to be used with pipelines.\r\nAll pipe names are unique, being the script name and the line number of where they were defined.\r\n```luau\r\nlocal my_pipe = abstractions.pipe()\r\nscheduler.phase(my_pipe, event)\r\n```\r\n\r\n### 5. Pipelines\r\nPipelines are an abstraction over phases, allowing for handy implicit ordering.\r\n```luau\r\nlocal pipe_a = abstractions.pipe()\r\nlocal pipe_b = abstractions.pipe()\r\nlocal pipe_c = abstractions.pipe()\r\n\r\n-- Pipe A is bound to the given event\r\n-- Pipe B depends on Pipe A\r\n-- Pipe C depends on Pipe B\r\nabstractions.pipeline()\r\n :with(pipe_a)\r\n :with(pipe_b)\r\n :with(pipe_c)\r\n :build(event)\r\n```\r\n\r\n## Installation\r\n\r\n### Pesde\r\nAvailable for use in standalone luau.\r\n\r\n1. `pesde add mark_marks/rubine`\r\n2. `pesde install`\r\n\r\n### Wally\r\nAvailable for use in Roblox.\r\n\r\n1. Add it to your wally manifest\r\n```toml\r\n[dependencies]\r\nrubine = \"mark-marks/rubine@LATEST\" # Replace LATEST with the latest version\r\n```\r\n2. `wally install`\r\n\r\n### NPM (roblox-ts)\r\n1. `npm add @rbxts/rubine`\r\n2. `npm install`\r\n\r\n## Honorable Mentions\r\n\r\n- Abstractions were inspired by the ecs agnostic [Planck scheduler](https://github.com/YetAnotherClown/Planck).\r\n- Logo was kindly created by [alice](https://github.com/alicesaidhi).\r\n","readmeTruncated":false}