Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Mark-Marks/sapphire
A lightweight but batteries included Roblox framework
https://github.com/Mark-Marks/sapphire
Last synced: 3 months ago
JSON representation
A lightweight but batteries included Roblox framework
- Host: GitHub
- URL: https://github.com/Mark-Marks/sapphire
- Owner: Mark-Marks
- License: mit
- Created: 2024-07-30T22:09:45.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-10-06T19:06:44.000Z (4 months ago)
- Last Synced: 2024-10-07T21:39:29.830Z (4 months ago)
- Language: Luau
- Size: 221 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-roblox - sapphire - A lightweight but batteries included Roblox framework. (Libraries / Frameworks)
README
[](https://github.com/mark-marks/sapphire/actions/workflows/ci.yml)
[](https://github.com/Mark-Marks/sapphire/blob/main/LICENSE)
[](https://wally.run/package/mark-marks/sapphire)
# sapphire
A lightweight module loader or a batteries included framework
> [!CAUTION]
> Here be dragons! Sapphire and its extensions are barely tested and in alpha
> [!IMPORTANT]
> All crates are versioned differently. Whilst the core may be at `v0.1.0`, an extension could be at `v0.5.3`.\
> Because this is a change @ `v0.1.2`, `sapphire`, `sapphire-lifecycles`, `sapphire-logging` `saphire-net`, `sapphire-data` and `sapphire-ecr` start at `v0.1.2` whilst any other crates don't because they were released after this change.
## Todo
- [x] Set up project
- [x] Make basic, extensible module loader
- [x] Add pre-built extensions:
- [x] `sapphire-lifecycles` - extra lifecycles for `RunService` and `Players`
- [x] `sapphire-logging` - a nice logging library with a log history
- [x] `sapphire-net` - optimized networking library that features defined (like `ByteNet`) events and undefined events, both with buffer serdes, albeit undefined events performing worse due to having to define types and lengths in the buffer
- [x] `sapphire-data` - batteries included wrapper for an existing data library like `keyForm`
- [x] `sapphire-ecr` - scheduler for ECR with niceties
- [x] `sapphire-jecs` - scheduler for JECS with niceties
## Notes
- Partially inspired by [prvdmwrong/prvdmwrong](https://github.com/prvdmwrong/prvdmwrong)!
- Dependency injection doesn't exist because it can be implemented as an extension.
- Typescript support is half assed at best and non existent at worst, feel free to PR good types in and I'll accept them.
- Sapphire and all of its extensions are licensed under [the MIT license](https://opensource.org/license/mit).
- Sapphire and all of its extensions are strictly typed.
- Sapphire is built around decoupling singletons from itself - you don't have to require sapphire in singletons to do anything.
> [!IMPORTANT]
> [JohnnyMorganz/wally-package-types](https://github.com/JohnnyMorganz/wally-package-types) or a package manager which exports types **NEEDS** to be used to get good type support for extensions. All extensions with dependencies rely on them to have exported types.
## Styling guide
There is none, although sapphire tries its best to follow snake_case.
## Documentation
A documentation website doesn't exist yet, although an API reference can be viewed in extension READMEs.
Do note that some API references might not be fully up to date, although the author tries to maintain them.
### [sapphire](/crates/sapphire)
### [sapphire-lifecycles](/crates/sapphire-lifecycles)
### [sapphire-logging](/crates/sapphire-logging)
### [sapphire-net](/crates/sapphire-net)
### [sapphire_data](/crates/sapphire-data)
### [sapphire-ecr](/crates/sapphire-ecr)
### [sapphire-jecs](/crates/sapphire-jecs)