Nuake/README.md

# Nuake
![Nuake](Resources/Images/logo.png)

## Quake inspired game engine
Nuake is a game engine currently in developement that focuses on fast level design iteration time that integrates with quake level editing software. 
> It is currently in developement and is not feature complete. We are currently aiming for an alpha release with basic features and a demo level.

![Nuake](Resources/Images/screenshot.png)


You can join the discord server for updates and screenshots or if you want to contribute:

[![Join Server](https://img.shields.io/discord/852625335236558868.svg?label=Discord&logo=Discord&colorB=7289da&style=for-the-badge)](https://discord.gg/kuF4efPK7Y)


## Current Features
- ECS system
- Modern physic engine (Jolt physic) 
- PBR Renderer
- Post processing effects(Bloom, SSAO, SSR, Volumetrics, Procedural Sky)
- Wren Scripting
- Trenchbroom integration

## Planned features
- C# Scripting
- Custom Shaders
- Spatialized audio
- NuakeUI integration
- Dynamic global illumination
- Asset packing
- Terrain editor
- WAD converter

## Contributing
We are currently looking for contributors, feel free to join the discord if you are looking to help the project.

## Compiling the engine
1. Clone the repos using `git clone --recurse-submodules https://github.com/antopilo/Nuake.git`
2. Run the `generate.bat` to generate the sln files.
3. Open `Nuake.sln`
4. Build and run

# Documentation and demos
> The current documentation is not up to date.

You can access the current documentation [here](https://nuake.readthedocs.io/en/latest/index.html).