51 lines
2.9 KiB
Markdown
51 lines
2.9 KiB
Markdown
Platform | Build Status
|
|
------------ | -------------
|
|
Windows | [](https://github.com/DigitalPulseSoftware/NazaraEngine/actions/workflows/windows-build.yml)
|
|
MSYS2 (MinGW64) | [](https://github.com/DigitalPulseSoftware/NazaraEngine/actions/workflows/msys2-build.yml)
|
|
Linux | [](https://github.com/DigitalPulseSoftware/NazaraEngine/actions/workflows/linux-build.yml)
|
|
|
|
# Nazara Engine
|
|
|
|
Nazara Engine is a cross-platform framework aimed at (but not limited to) real-time applications requiring audio, 2D and 3D rendering, network and more (such as video games).
|
|
|
|
Features:
|
|
- 2D and 3D rendering using either Vulkan, OpenGL and OpenGL ES (depending on what's available on the target system).
|
|
- Its own renderer-agnostic shader language (NZSL - Nazara Shading Language), no need to write specialized GLSL code anymore!
|
|
- Easy to customize graphics module providing basis for advanced techniques (such as deferred shading, HDR, PBR rendering and more).
|
|
- Audio playback and streaming based on OpenAL.
|
|
- 2D and 3D Physics integration (with [Chipmunk](https://chipmunk-physics.net) and [Newton Dynamics](https://github.com/MADEAPPS/newton-dynamics)).
|
|
- Optional ECS (Entity-Component-System) classes for helping with entity handling (based on the excellent [entt](https://github.com/skypjack/entt)).
|
|
- A [ENet](https://github.com/lsalzman/enet)-based reliable UDP networking protocol.
|
|
|
|
You can use it in any kind of commercial and non-commercial applications without any restriction ([MIT license](http://opensource.org/licenses/MIT)).
|
|
|
|
## Authors
|
|
|
|
Jérôme "Lynix" Leclercq - main developper (<lynix680@gmail.com>)
|
|
|
|
## Build and install
|
|
|
|
See [INSTALL.md](INSTALL.md) for build instructions.
|
|
|
|
## How to use
|
|
|
|
You can find tutorials on installation, compilation and use on the [official wiki](https://github.com/DigitalPulseSoftware/NazaraEngine/wiki)
|
|
|
|
## Contribute
|
|
|
|
##### Don't hesitate to contribute to Nazara Engine by:
|
|
- Extending the [wiki](https://github.com/DigitalPulseSoftware/NazaraEngine/wiki)
|
|
- Submitting a patch to GitHub
|
|
- Post suggestions/bugs on the forum or the [GitHub tracker](https://github.com/DigitalPulseSoftware/NazaraEngine/issues)
|
|
- [Fork the project](https://github.com/DigitalPulseSoftware/NazaraEngine/fork) on GitHub and [push your changes](https://github.com/DigitalPulseSoftware/NazaraEngine/pulls)
|
|
- Talking about Nazara Engine to other people, spread the word!
|
|
- Doing anything else that might help us
|
|
|
|
## Links
|
|
|
|
[Discord](https://discord.gg/MvwNx73)
|
|
[Wiki](https://github.com/DigitalPulseSoftware/NazaraEngine/wiki)
|
|
|
|
## Thanks to:
|
|
|
|
See [THANKS.md](THANKS.md) |