lumenpyx 0.2.0

A 2D pixel art renderer with realistic lighting
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

<p align="center">
  <img src="https://github.com/ABC-Engine/lumenpyx/assets/76850177/0f7de667-ee5e-4f72-bbc3-440b12cbf7d1">
</p>
<h2 align="center"> A unique 2D-pixel art renderer with heightmaps to simulate 3d shadows. </h2>

# Examples

This is the best example I have for now, the renderer is capable of much more than this, but I'm not a great artist. 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

Here is a static scene:
![image](https://github.com/ABC-Engine/lumenpyx/assets/76850177/385e640b-97c9-4b45-aa86-496ad5e474b2)


# 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!