Update README.md

This commit is contained in:
Antoine Pilote
2021-06-13 01:02:08 -04:00
committed by GitHub
parent 84185d4b6b
commit 09d9054bcc

View File

@@ -6,10 +6,10 @@ Nuake is a game engine written from scratch by myself. It is not meant to be a e
`Warning: It is still very early in development and I dont recommend anyone using this to make their games *yet*. `
# How to build
1. Clone the repos
2. Run the `premake5` command
3. Open the project generated by premake
4. Run the editor
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.
@@ -19,24 +19,21 @@ No documentation is currently available, I will try my best to work on this asap
# Features
- Trenchbroom integration with live reload
- Native c++ scripting
- fast ECS
- fast ECS & Scene tree system
- Bullet physics
- PBR rendering
- Volumetric lighting
- Parallax mapping
- Scene tree system
- Game in editor
- Procedural & HDR skies
- IBL
- Serialization
- UI system
- Image based lighting
- Modern UI system
- Wren scripting api and module system
# Planned
- Advanced bullet physics features
- Soft bodies, Joints, etc.
- Demo level
- C# scripting
- Cross platform
- Different rendering API(not a priority)
- Triggers and entity editing in TB