https://github.com/abc-engine/lumenpyx

A unique 2D-pixel art renderer with heightmaps to simulate 3d shadows and reflections
https://github.com/abc-engine/lumenpyx

blazingly-fast easy-to-use opengl pixel-art renderer rust

Last synced: 5 days ago
JSON representation

A unique 2D-pixel art renderer with heightmaps to simulate 3d shadows and reflections

• Host: GitHub
• URL: https://github.com/abc-engine/lumenpyx
• Owner: ABC-Engine
• License: mit
• Created: 2024-02-13T03:35:30.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-08-02T16:12:24.000Z (6 months ago)
• Last Synced: 2025-01-21T09:58:08.571Z (6 days ago)
• Topics: blazingly-fast, easy-to-use, opengl, pixel-art, renderer, rust
• Language: Rust
• Homepage:
• Size: 8.46 MB
• Stars: 36
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        


  



 A unique 2D-pixel art renderer with heightmaps to simulate 3d shadows. 


# Examples

Here is an example video, notice the shadows cast from the gravestones and the reflections are all done real time. If this video doesn't load you can view it [here](https://jumpshare.com/v/Qby5rxmfNWXRzXbELPK6?b=nQ38KY77bXG1w5YSpTeR).

https://github.com/ABC-Engine/lumenpyx/assets/76850177/a4d73ff0-6991-4e6d-9390-1343b29a99fb

# Compatibility

This crate is cross-platform.

# Re-Exports

I re-export the Winit crate because it is necessary for window management.

# Getting Started

You can find the crate [here](https://crates.io/crates/lumenpyx) and download it using ```cargo add lumenpyx```. Check out [the discord](https://discord.gg/55R3GsBSYC), we've got a help channel. Check out the [wiki](https://github.com/ABC-Engine/lumenpyx/wiki), the docs for this library are kept there. I will keep updated as time goes on. If there is anything that you would like a docs page for let me know! 

* [Getting Started][home]

  * [Making Sprites][makingsprites]

  * [Rendering a Sprite][renderingasprite]

* [Common Problems and Their Solutions][commonproblemsandsolutions]

  * [Lines in Reflections][linesinreflections]

* [Technical documentation][techdocs]

  * [The Shadow System][shadowsystem]

* [Creating Custom Renderables][customrenderables]

  * [Creating Custom Drawable Objects][customdrawableobjects]

  * [Creating Custom Lights][customlights]

[home]: https://github.com/ABC-Engine/lumenpyx/wiki

[techdocs]: https://github.com/ABC-Engine/lumenpyx/wiki/Technical-Documentation

[commonproblemsandsolutions]: https://github.com/ABC-Engine/lumenpyx/wiki/Common-problems-and-their-solutions

[customdrawableobjects]: https://github.com/ABC-Engine/lumenpyx/wiki/Creating-custom-drawable-objects

[customlights]: https://github.com/ABC-Engine/lumenpyx/wiki/Creating-Custom-Lights

[customrenderables]: https://github.com/ABC-Engine/lumenpyx/wiki/Creating-Custom-Renderables

[renderingasprite]: https://github.com/ABC-Engine/lumenpyx/wiki/Rendering-a-Sprite

[linesinreflections]: https://github.com/ABC-Engine/lumenpyx/wiki/Lines-in-reflections

[shadowsystem]: https://github.com/ABC-Engine/lumenpyx/wiki/The-shadows-system

[makingsprites]: https://github.com/ABC-Engine/lumenpyx/wiki/Making-Sprites

[linesinreflections]: https://github.com/ABC-Engine/lumenpyx/wiki/Lines-in-reflections

[shadowsystem]: https://github.com/ABC-Engine/lumenpyx/wiki/The-shadows-system

# Contributing

Contributions are welcome! Start by filing an issue and we can work forward from there! If you're not sure what to work on but you want to help [Join the discord and ping me](https://discord.gg/6nTvhYRfpm), I'm happy to help!