Updated readme

This commit is contained in:
antopilo
2023-07-08 20:17:44 -04:00
parent 32ba9e23d4
commit b18b4cd788

View File

@@ -1,17 +1,18 @@
# Nuake
![Nuake](Editor/resources/Images/logo.png)
## 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.
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)
## 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](Editor/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)
@@ -40,6 +41,7 @@ We are currently looking for contributors, feel free to join the discord if you
4. Build and run
# 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)
> The current documentation is not up to date.
You can access the current documentation [here](https://nuake.readthedocs.io/en/latest/index.html).