Updated readme

This commit is contained in:
antopilo
2023-07-08 20:11:31 -04:00
parent 94e6cfd0ab
commit 32ba9e23d4
3 changed files with 35 additions and 34 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 859 KiB

View File

@@ -1,44 +1,45 @@
![Nuake](http://antoinepilote.com/assets/NUAKE.png)
# Nuake
Feel free to join the discord server for updates:
![Nuake](Editor/resources/Images/logo.png)
[![Support Server](https://img.shields.io/discord/852625335236558868.svg?label=Discord&logo=Discord&colorB=7289da&style=for-the-badge)](https://discord.gg/kuF4efPK7Y)
# What is it
Nuake is a game engine written from scratch by myself. It is not meant to be a end-all be-all engine and it is not a quakespasm type engine. This is a game engine that focuses on fast level design iteration that integrates with quake level editing software. If you can create quake maps, you can create Nuake levels.
`Warning: It is still very early in development and I dont recommend anyone using this to make their games *yet*. `
## Id Tech inspired game engine
Nuake is a game engine 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 showcasing the current features.
# How to build
You can join the discord server where I post updates and screenshots or are looking to contribute to the project:
[![Join Server](https://img.shields.io/discord/852625335236558868.svg?label=Discord&logo=Discord&colorB=7289da&style=for-the-badge)](https://discord.gg/kuF4efPK7Y)
![Nuake](Editor/resources/Images/screenshot.png)
## 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
# Contributing
Feel free to make pull requests and I will look over them myself.
# Documentation
# Documentation and demos
> The current documentation is not up to date
You can access the current documentation at [here](https://nuake.readthedocs.io/en/latest/index.html)
# Features
- Trenchbroom integration with live reload
- fast ECS & Scene tree system
- Jolt physics
- PBR rendering
- Volumetric lighting
- Parallax mapping
- Game in editor
- Procedural & HDR skies
- Modern UI system
- Wren scripting api and module system
- Triggers and entity editing in TB
# Planned
- Advanced physics features
- Soft bodies, Joints, etc.
- Demo level
- Cross platform
- Optimization
- Water simulation
- Terrain editing
- Exporting
- Custom shaders