Skip to content

Crazyblox/penumbra

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

185 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

About:

Penumbra is performant modular graphics rendering pipeline which leans into Luau's strengths.

This provides developers who wish to render shaders in constrained environments (ie. no GPU access).

The project contains many example fragment shaders to get started, and is configured by default to run fragment/multi.luau.

Each major module has its purpose described at the top, and comments are provided to help for context.

Setup - Luau:

The Penumbra directory needs to be sat as a direct child of the Pajamas directory in order to run.

Ensure you get it set up successfully in your host runtime before continuing.

Link: https://github.com/Crazyblox/Pajamas

Setup - Roblox:

Look for the latest release of Penumbra here and download the .rbxm for the drag and drop version of Penumbra which is packaged with the Pajamas runtime.

Contributions:

Issues & PRs are welcome; the intent of Penumbra is to remain as minimal and elegant as possible.

What will and what won't be considered is a list I intend to make more clear as the project progresses, but this is a rough start:

  • Before making a PR, create an issue for discussion to see if your intent aligns with this projects goals.
  • PRs with performance implications will be scrutinised heavily. Ensure optimisation, pros/cons, potential drawbacks and repro testing methods are provided.
  • Shader modules which stand out as their own example among the others in the list will be considered; if porting someone else's work, ensure MIT licensing and source is linked. Adhere to the format in which shader_builder outputs.

About

Performant Luau-based graphics shaders

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages