diff --git a/README.md b/README.md index 4c779cd..547db4a 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,105 @@ +# Khaotic Engine - C++ Custom Engine -# Khaotic Engine - C++ Custom Engine +Khaotic Engine est un moteur de rendu fait en **C++** réalisé par une petite équipe dans le but d'apprendre à utiliser les API de rendu (OpenGL,DirectX 11/12 et Vulkan). -Khaotic Engine est un moteur de rendu fait en c++ réalisé par une petite équipe dans le but d'apprendre a utilisé les API de rendu (OpenGL,DirectX 11/12 et Vulkan). - -Ce moteur est basé sur DirectX11 utilise ImGui avec une couche d'abstraction pour permetre son usage avec d'autre API. +Ce moteur est basé sur **DirectX11** utilise **ImGui** avec une couche d'abstraction pour permetre son usage avec d'autres API. --- -Khaotic Engine is a rendering engine made in C++ by a small team with the aim of learning how to use rendering APIs (OpenGL, DirectX 11/12 and Vulkan). +Khaotic Engine is a rendering engine made in **C++** by a small team with the aim of learning how to use rendering APIs (OpenGL, DirectX 11/12 and Vulkan). -This DirectX11-based engine uses ImGui with an abstraction layer to enable its use with other APIs. +This **DirectX11** based engine uses **ImGui** with an abstraction layer to enable its use with other APIs. + + +## Installation + +**Par la solution + Debogueur :** + + 1. Télécharger la branche Main + 2. Dezip le Zip + 3. Ouvrir le fichier en .sln + 4. Lancer le déboguage + +---- + +**From solution + Debugger** + + 1. Download the Main branch + 2. Unzip the Zip file + 3. Open the .sln flie + 4. Launch the debugger -## Demo +## Shaders list: + + + - **Diffuse Lighting** + - **Ambiant Lighting** + - **Specular Lighting** + - **Alpha Mapping** + - **Normal Mapping** + - **Specular Mapping** + - **Clipping Planes** + - **Texture Translation** + - **Transparency** + + +*Plus de shaders seront disponibles dans le futur* + +--- + +*More shaders will be added in the future* + + + +## ImGui: + +*Cette partie du moteur est encore en développement, d'autres fonctionnalitées seront ajoutées dans le futur* + +La librairie ImGui est utilisée afin d'interragir avec les éléments du moteur comme les objets. + +### Fonctionnalitées: +- Importer des objets 3D sous format **.obj** +- Ajout d'un cube à la scène +- Modifier les propriétées d'un objet (Position, Rotation, Taille) +- Modifier les objets présents dans la scène +- Création d'un terrain +- Modifier les propriétées des lumières (Position, Couleur RVB) + +---- +*This part of the engine is still in developpement, other features will be added in the future* + +ImGui is used here to allow interraction between the user and the objects in the scene. + +### Features: +- Import 3D objects with the **.obj** format +- Can add a cube tu the scne +- Edit an object prorpieties (Position, Rotation, Scale) +- Edit objects in the current scene +- Terrain generation +- Edit lights proprieties (Position, RGB Color) + + + +## Demo : [![Demo Video](https://img.youtube.com/vi/qCOCTyB_97c/0.jpg)](https://www.youtube.com/watch?v=qCOCTyB_97c) ## Engine Build by : -- [@CatChow0](https://github.com/CatChow0) -- [@miragefr0st](https://github.com/miragefr0st) -- [@StratiX0](https://github.com/StratiX0) -- [@Kagutsuchi84](https://github.com/Mattys8423) -- [@Harpie94](https://github.com/Harpie94) -- [@axelpicou](https://github.com/axelpicou) -- [@GolfOcean334](https://github.com/GolfOcean334) -- [@sutabasuto](https://github.com/sutabasuto) +[](https://github.com/GamingCampus-AdrienBourgois/khaotic-engine?tab=readme-ov-file#engine-build-by-) + +- [@CatChow0](https://github.com/CatChow0) +- [@miragefr0st](https://github.com/miragefr0st) +- [@StratiX0](https://github.com/StratiX0) +- [@Kagutsuchi84](https://github.com/Mattys8423) +- [@Harpie94](https://github.com/Harpie94) +- [@axelpicou](https://github.com/axelpicou) +- [@GolfOcean334](https://github.com/GolfOcean334) +- [@sutabasuto](https://github.com/sutabasuto) + + + +