npm package: @rbxts/lumin-framework
Description: A feather light framework for Roblox-TS games
Latest version: 11.0.0

# lumin/framework

[![package](https://img.shields.io/badge/dynamic/toml?url=https%3A%2F%2Fraw.githubusercontent.com%2Flumin-org%2Fframework%2Frefs%2Fheads%2Fmain%2Fpesde.toml&query=version&prefix=lumin%2Fframework%40&style=plastic&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB3aWR0aD0iMTAwIiBoZWlnaHQ9IjEwMCIgdmlld0JveD0iMCAwIDEwMCAxMDAiIGZpbGw9Im5vbmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI%2BCjxwYXRoIGZpbGwtcnVsZT0iZXZlbm9kZCIgY2xpcC1ydWxlPSJldmVub2RkIiBkPSJNNDkuNjAyNSAwTDkyLjkwMzggMjVWNzVMNDkuNjAyNSAxMDBMNi4zMDEyNyA3NVYyNUw0OS42MDI1IDBaTTE0LjMwMTMgMjkuNjE4OEw0OS42MDI1IDkuMjM3Nkw4NC45MDM4IDI5LjYxODhWNzAuMzgxMkw0OS42MDI1IDkwLjc2MjRMMzMuNjE0OCA4MS41MzE5VjY3LjM4NDhDMzQuNTE2NyA2OC41MDcxIDM1LjYzODggNjkuNDIxNSAzNi45ODEgNzAuMTI3OUMzOC45NzAxIDcxLjE0OCA0MS4wMzU3IDcxLjY1OCA0My4xNzc5IDcxLjY1OEM0Ni40NDIgNzEuNjU4IDQ5LjE0NTIgNzAuODkyOSA1MS4yODczIDY5LjM2MjlDNTMuNDgwNSA2Ny43ODE4IDU1LjExMjYgNjUuNzY3MiA1Ni4xODM2IDYzLjMxOUM1Ny4wOTE1IDYxLjMzODIgNTcuNjMyIDU5LjI3NCA1Ny44MDU0IDU3LjEyNjNDNTkuODcyMyA1Ny43NDU3IDYyLjIxNTcgNTguMDU1NCA2NC44MzU2IDU4LjA1NTRDNjcuNjkxOCA1OC4wNTU0IDcwLjM2OTUgNTcuNjQ3MyA3Mi44Njg2IDU2LjgzMTNDNzUuMzY3OCA1NS45NjQyIDc3LjQwNzkgNTQuODE2NyA3OC45ODkgNTMuMzg4Nkw3NS43NzU4IDQ3LjgwMzhDNzQuNTUxNyA0OC45MjU4IDcyLjk5NjEgNDkuODQzOSA3MS4xMDkgNTAuNTU3OUM2OS4yMjE5IDUxLjIyMSA2Ny4yMDczIDUxLjU1MjUgNjUuMDY1MiA1MS41NTI1QzYxLjM5MjkgNTEuNTUyNSA1OC42NjQzIDUwLjY4NTQgNTYuODc5MiA0OC45NTEzQzU2LjcxOTUgNDguNzk2MiA1Ni41NjcgNDguNjM2NSA1Ni40MjE3IDQ4LjQ3MkM1NS42MTAyIDQ3LjU1MzkgNTUuMDIxMSA0Ni40ODk2IDU0LjY1NDYgNDUuMjc5MUw1NC42NDQzIDQ1LjI0NTJMNTQuNjY5IDQ1LjI3OTFINzkuMjE4NVY0MS45ODk0Qzc5LjIxODUgMzkuMDMxMyA3OC41NTU1IDM2LjM1MzYgNzcuMjI5NCAzMy45NTY1Qzc1Ljk1NDMgMzEuNTU5MyA3NC4wOTI3IDI5LjY0NjcgNzEuNjQ0NSAyOC4yMTg2QzY5LjI0NzQgMjYuNzM5NSA2Ni4zNjU3IDI2IDYyLjk5OTUgMjZDNTkuNjg0MyAyNiA1Ni44MDI3IDI2LjczOTUgNTQuMzU0NSAyOC4yMTg2QzUxLjkwNjQgMjkuNjQ2NyA1MC4wMTkzIDMxLjU1OTMgNDguNjkzMiAzMy45NTY1QzQ3LjY3NDMgMzUuNzk4MyA0Ny4wNDY5IDM3LjgwNTcgNDYuODEwOCAzOS45Nzg4QzQ1LjY4ODggMzkuNzI4IDQ0LjQ3NzggMzkuNjAyNiA0My4xNzc5IDM5LjYwMjZDNDEuMDM1NyAzOS42MDI2IDM4Ljk3MDEgNDAuMTEyNyAzNi45ODEgNDEuMTMyN0MzNS4zMTYyIDQxLjk2NTEgMzMuOTkwMiA0My4xNTQ5IDMzLjAwMjggNDQuNzAyM1Y0MC4zNjc3SDIwLjY4NTVWNDYuMjU4NUgyNS44MTEzVjc3LjAyNjZMMTQuMzAxMyA3MC4zODEyVjI5LjYxODhaTTU1LjE5NjEgMzYuMDk4NkM1NC42NTI4IDM3LjEwMTUgNTQuMzMyMSAzOC4xMjE2IDU0LjIzNCAzOS4xNTg4SDcxLjc5NzZDNzEuNzk3NiAzOC4wMzY3IDcxLjQ0MDUgMzYuOTQwMSA3MC43MjY1IDM1Ljg2OTFDNzAuMDYzNCAzNC43NDcgNjkuMDY4OSAzMy44MDM1IDY3Ljc0MjggMzMuMDM4NEM2Ni40Njc3IDMyLjI3MzQgNjQuODg2NyAzMS44OTA4IDYyLjk5OTUgMzEuODkwOEM2MS4xMTI0IDMxLjg5MDggNTkuNTA1OCAzMi4yOTg5IDU4LjE3OTggMzMuMTE0OUM1Ni45MDQ3IDMzLjg4IDU1LjkxMDEgMzQuODc0NSA1NS4xOTYxIDM2LjA5ODZaTTQ5LjY0NTEgNTEuNTY5MkM0OS4zMDc2IDUwLjY2NDEgNDguODM4MSA0OS44NzEgNDguMjM2NyA0OS4xODk4QzQ4LjA4ODUgNDkuMDIxOSA0Ny45MzIzIDQ4Ljg2MDkgNDcuNzY4MSA0OC43MDY3QzQ2LjA4NSA0Ny4wNzQ2IDQ0LjA0NDkgNDYuMjU4NSA0MS42NDc4IDQ2LjI1ODVDNDAuMTE3NyA0Ni4yNTg1IDM4LjYxMzEgNDYuNTY0NSAzNy4xMzQgNDcuMTc2NkMzNS44NTk0IDQ3LjY3NzMgMzQuNjg2MyA0OC41NDM4IDMzLjYxNDggNDkuNzc1OVY2MS40N0MzNC42ODYzIDYyLjY2NjQgMzUuODU5NCA2My41Mzc4IDM3LjEzNCA2NC4wODRDMzguNjEzMSA2NC42OTYxIDQwLjExNzcgNjUuMDAyMSA0MS42NDc4IDY1LjAwMjFDNDQuMDQ0OSA2NS4wMDIxIDQ2LjA4NSA2NC4xODYxIDQ3Ljc2ODEgNjIuNTU0QzQ5LjQ1MTIgNjAuOTIxOSA1MC4yOTI4IDU4LjYwMTIgNTAuMjkyOCA1NS41OTIxQzUwLjI5MjggNTQuMDY3OSA1MC4wNzY5IDUyLjcyNyA0OS42NDUxIDUxLjU2OTJaIiBmaWxsPSJ3aGl0ZSIvPgo8L3N2Zz4K&label=pesde&color=F19D1E)](https://pesde.dev/packages/lumin/framework)
[![npm](https://img.shields.io/npm/v/%40rbxts%2Flumin-framework?style=plastic&logo=typescript&logoColor=white&label=rbxts&color=%23CC0000)](https://www.npmjs.com/package/@rbxts/lumin-framework)
[![build](https://img.shields.io/github/actions/workflow/status/lumin-org/framework/release.yml?style=plastic&logo=github&logoColor=FFFFFF&label=build)](https://github.com/lumin-org/framework/blob/main/.github/workflows/release.yml)
[![discord](https://img.shields.io/discord/1105688855375511642?logo=discord&logoColor=white&label=chat&color=4d3dff&style=plastic)](https://lumin-org.github.io/to/discord)

A feather light framework for Luau games.

## Prerequisites

In order to use **lumin/framework** you must have the following dependencies installed:

* [`pesde@^0.6.0`](https://github.com/pesde-pkg/pesde)
* [`rojo@^7.4.4`](https://github.com/rojo-rbx/rojo)

## Usage

This usage examples creates a new, and basic provider that uses a dependency.

```luau
local Dependency = require(path.to.dependency)

local function Init()
    Dependency.NuclearExplosion()
end

return {
    Init = Init,
    Uses = { Dependency } -- Makes the dependency init before this module
}
```

## License

This project is licensed under the [MIT](https://github.com/lumin-org/framework/blob/main/LICENSE) license