diff --git a/README.md b/README.md index f65fccf25..172af9cdf 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,23 @@ Platform | Build Status ------------ | ------------- -Windows | [![Windows build status](https://github.com/NazaraEngine/NazaraEngine/actions/workflows/windows-build.yml/badge.svg)](https://github.com/NazaraEngine/NazaraEngine/actions/workflows/windows-build.yml) -MSYS2 (MinGW64) | [![Windows build status](https://github.com/NazaraEngine/NazaraEngine/actions/workflows/msys2-build.yml/badge.svg)](https://github.com/NazaraEngine/NazaraEngine/actions/workflows/msys2-build.yml) -Linux | [![Linux build status](https://github.com/NazaraEngine/NazaraEngine/actions/workflows/linux-build.yml/badge.svg)](https://github.com/NazaraEngine/NazaraEngine/actions/workflows/linux-build.yml) -macOS | [![macOS build status](https://github.com/NazaraEngine/NazaraEngine/actions/workflows/macos-build.yml/badge.svg)](https://github.com/NazaraEngine/NazaraEngine/actions/workflows/macos-build.yml) -Emscripten | [![Emscripten build status](https://github.com/NazaraEngine/NazaraEngine/actions/workflows/wasm-build.yml/badge.svg)](https://github.com/NazaraEngine/NazaraEngine/actions/workflows/wasm-build.yml) +Windows | [![Windows build status](https://github.com/NazaraEngine/NazaraEngine/actions/workflows/windows-build.yml/badge.svg?branch=main)](https://github.com/NazaraEngine/NazaraEngine/actions/workflows/windows-build.yml) +MSYS2 (MinGW64) | [![Windows build status](https://github.com/NazaraEngine/NazaraEngine/actions/workflows/msys2-build.yml/badge.svg?branch=main)](https://github.com/NazaraEngine/NazaraEngine/actions/workflows/msys2-build.yml) +Linux | [![Linux build status](https://github.com/NazaraEngine/NazaraEngine/actions/workflows/linux-build.yml/badge.svg?branch=main)](https://github.com/NazaraEngine/NazaraEngine/actions/workflows/linux-build.yml) +macOS | [![macOS build status](https://github.com/NazaraEngine/NazaraEngine/actions/workflows/macos-build.yml/badge.svg?branch=main)](https://github.com/NazaraEngine/NazaraEngine/actions/workflows/macos-build.yml) +Emscripten | [![Emscripten build status](https://github.com/NazaraEngine/NazaraEngine/actions/workflows/wasm-build.yml/badge.svg?branch=main)](https://github.com/NazaraEngine/NazaraEngine/actions/workflows/wasm-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: +- Supports Windows, Linux, macOS and the web (Android and iOS are coming). - 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! +- Its own renderer-agnostic shader language (NZSL - Nazara Shading Language), a single modern language working with all renderer backends - 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)). +- A powerful and extensible frame graph system allowing you to easily define how your rendering works. +- Audio playback and streaming based on [OpenAL-Soft](https://www.openal-soft.org). +- 2D and 3D Physics integration (with [Chipmunk](https://chipmunk-physics.net) and [Jolt Physics]([https://github.com/MADEAPPS/newton-dynamics](https://github.com/jrouwe/JoltPhysics))). - 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. @@ -23,7 +25,7 @@ You can use it in any kind of commercial and non-commercial applications without ## Authors -Jérôme "Lynix" Leclercq - main developper () +Jérôme "SirLynix" Leclercq - main developper () ## Build and install @@ -45,7 +47,8 @@ You can find tutorials on installation, compilation and use on the [official wik ## Links -[Discord](https://discord.gg/MvwNx73) +[Discord](https://discord.sirlynix.be/) +[X (Twitter)](https://twitter.com/SirLynix) [Wiki](https://github.com/NazaraEngine/NazaraEngine/wiki) ## Thanks to: