README + Water -> Liquid (#22)

* Create README.md
* Changed naming of water to liquid
* Set start project to "Game"
* Fixed minimizing and resizing
* Update Engine submodule

Author: SoapyEnigma

README.md

@@ -0,0 +1,43 @@
+## What is Novus
+Novus is an MMO Engine.
+
+Currently Novus is developing a game/server solution where our main focus is to be feature complete with the most popular MMOs out there.
+Long term, we hope to support many more features.
+
+## The Novus Promise
+The project was made with the promise that we would always focus on reliability, redundancy, and performance over convenience. We achieve this through making use of experience, but also applying modern techniques and design patterns.
+
+The end-goal is to provide a game/server setup, capable of tackling all of the limitations set by the current standard. Solving those issues are complicated, but we start by applying a proper foundation for our architecture to allow for better flow of information(data) and performance.
+
+## Novus Discord
+The project has an official [Discord](https://discord.gg/gz6FMZa).
+You will find the developers to be active on the discord and always up for answering any questions you might have regarding the project. Despite Novus not currently being ready for production level use, we are always welcoming any users that want to try using it.
+
+## Dependencies
+* [OpenSSL 1.1.0](https://www.openssl.org/source/)
+* [Premake5](https://premake.github.io/)
+* [Vulkan 1.1 (or higher)](https://vulkan.lunarg.com/)
+
+## Libraries
+Here we include a honorable mention to all the libraries included directly into the source of Novus. You do not need to download these on your own, but we felt it was important to address these as without them, Novus would be a lot more time consuming to develop.
+* [All Libraries from Engine](https://github.com/novusengine/Engine)
+* [Jolt](https://github.com/jrouwe/JoltPhysics)
+
+## How to build (Microsoft Visual 2022)
+>[!TIP]
+> It's recommended to fork, clone, and build [Engine](https://github.com/novusengine/Engine) first.
+1. Download the dependencies.
+2. Fork and clone the repositry
+3. Open the project folder and open a terminal within the project's directory.
+4. Use the command `premake5 vs2022`
+> [!NOTE]
+> You can change the files generated by using a different [action](https://premake.github.io/docs/using-premake) than `vs2022`.   
+5. Open the new `Build` folder and double click the `Game.sln` file.
+6. Use `ctrl`+`shift`+`b` to build the solution or right click the solution and select `Build Solution`
+7. The solution builds to `../Build/Bin/Game/[BuildConfig]`
+
+## How to use
+1. You must take the `Data` folder generated by the `AssetConverter.exe` (see [AssetConverter](https://github.com/novusengine/AssetConverter)) and place it in the `Game/Build/` folder if you plan to run the project from IDE or place it in the `Build/Bin/Game/[BuildConfig]` folder if you wish to directly run the `Game.exe`.
+>[!TIP]
+>It is highly recommended to [symlink](https://schinagl.priv.at/nt/hardlinkshellext/linkshellextension.html) the `Data` folder to avoid copying/moving a large (~16GB) folder.
+2. Either run the `Game.exe` or run the project from your IDE.

Source/Game/Game/Editor/MapSelector.cpp

@@ -272,19 +272,47 @@ namespace Editor
                             mapLoader->LoadMap(internalMapNameHash);
                         }
 
+                        if (ImGui::MenuItem("Unload"))
+                        {
+                            MapLoader* mapLoader = ServiceLocator::GetGameRenderer()->GetMapLoader();
+                            mapLoader->UnloadMap();
+                        }
+
                         ImGui::EndPopup();
                     }
                     else
                     {
                         popupMapID = std::numeric_limits<u32>().max();
                     }
 
+                    _currentSelectedMapID = currentMapIDSelected;
+
                     ImGui::PopID();
                 }
             }
 
             ImGui::EndListBox();
         }
+
+        f32 mapHandlerButtonWidth = ImGui::GetWindowSize().x * 0.5f - 19.5f; // Black Magic GUI Math
+
+        if (ImGui::Button("Load Map", ImVec2(mapHandlerButtonWidth, 50.0f)))
+        {
+            MapLoader* mapLoader = ServiceLocator::GetGameRenderer()->GetMapLoader();
+
+            const Definitions::Map& map = mapStorage.GetByID(_currentSelectedMapID);
+            const std::string& internalName = mapStorage.GetString(map.internalName);
+
+            u32 internalMapNameHash = StringUtils::fnv1a_32(internalName.c_str(), internalName.length());
+            mapLoader->LoadMap(internalMapNameHash);
+        }
+
+        ImGui::SameLine();
+        if (ImGui::Button("Unload Map", ImVec2(mapHandlerButtonWidth, 50.0f)))
+        {
+            MapLoader* mapLoader = ServiceLocator::GetGameRenderer()->GetMapLoader();
+            mapLoader->UnloadMap();
+        }
     }
 
 	void MapSelector::DrawImGui()

Source/Game/Game/Editor/MapSelector.h

@@ -19,5 +19,7 @@ namespace Editor
 	private:
 		void* _mapIcons[5] = { nullptr };
 		vec2 _mapIconSizes[5];
+
+		u32 _currentSelectedMapID = 0;
 	};
 }

Source/Game/Game/Editor/PerformanceDiagnostics.cpp

@@ -7,7 +7,7 @@
 #include <Game/Rendering/GameRenderer.h>
 #include <Game/Rendering/Model/ModelRenderer.h>
 #include <Game/Rendering/Terrain/TerrainRenderer.h>
-#include <Game/Rendering/Water/WaterRenderer.h>
+#include <Game/Rendering/Liquid/LiquidRenderer.h>
 #include <Game/Rendering/Debug/JoltDebugRenderer.h>
 #include <Game/Application/EnttRegistries.h>
 #include <Game/ECS/Singletons/EngineStats.h>
@@ -554,7 +554,7 @@ namespace Editor
         GameRenderer* gameRenderer = ServiceLocator::GetGameRenderer();
         TerrainRenderer* terrainRenderer = gameRenderer->GetTerrainRenderer();
         ModelRenderer* modelRenderer = gameRenderer->GetModelRenderer();
-        WaterRenderer* waterRenderer = gameRenderer->GetWaterRenderer();
+        LiquidRenderer* liquidRenderer = gameRenderer->GetLiquidRenderer();
         JoltDebugRenderer* joltDebugRenderer = gameRenderer->GetJoltDebugRenderer();
 
         const std::string rightHeaderText = "Survived / Total (%)";
@@ -591,7 +591,7 @@ namespace Editor
         bool viewRendersTerrainCulling = true; // Only main view supports terrain culling so far
         bool viewRendersOpaqueModelsCulling = true;
         bool viewRendersTransparentModelsCulling = viewID == 0; // Only main view supports transparent cmodel culling so far
-        bool viewRendersWaterCulling = viewID == 0; // Only main view supports mapObjectgs culling so far
+        bool viewRendersLiquidCulling = viewID == 0; // Only main view supports mapObjectgs culling so far
         bool viewRendersJoltDebug = viewID == 0;
 
         // Terrain
@@ -630,11 +630,11 @@ namespace Editor
             DrawCullingResourcesDrawCalls("Model (T)", viewID, cullingResources, viewSupportsOcclusionCulling, viewDrawCalls, viewDrawCallsSurvived);
         }
 
-        // Water
-        if (viewRendersWaterCulling)
+        // Liquid
+        if (viewRendersLiquidCulling)
         {
-            CullingResourcesBase& cullingResources = waterRenderer->GetCullingResources();
-            DrawCullingResourcesDrawCalls("Water", viewID, cullingResources, viewSupportsOcclusionCulling, viewDrawCalls, viewDrawCallsSurvived);
+            CullingResourcesBase& cullingResources = liquidRenderer->GetCullingResources();
+            DrawCullingResourcesDrawCalls("Liquid", viewID, cullingResources, viewSupportsOcclusionCulling, viewDrawCalls, viewDrawCallsSurvived);
         }
 
         // Jolt Debug
@@ -660,7 +660,7 @@ namespace Editor
         GameRenderer* gameRenderer = ServiceLocator::GetGameRenderer();
         TerrainRenderer* terrainRenderer = gameRenderer->GetTerrainRenderer();
         ModelRenderer* modelRenderer = gameRenderer->GetModelRenderer();
-        WaterRenderer* waterRenderer = gameRenderer->GetWaterRenderer();
+        LiquidRenderer* liquidRenderer = gameRenderer->GetLiquidRenderer();
         JoltDebugRenderer* joltDebugRenderer = gameRenderer->GetJoltDebugRenderer();
 
         const std::string rightHeaderText = "Survived / Total (%)";
@@ -697,7 +697,7 @@ namespace Editor
         bool viewRendersTerrainCulling = true; // Only main view supports terrain culling so far
         bool viewRendersOpaqueModelsCulling = true;
         bool viewRendersTransparentModelsCulling = viewID == 0; // Only main view supports transparent cmodel culling so far
-        bool viewRendersWaterCulling = viewID == 0; // Only main view supports water culling so far
+        bool viewRendersLiquidCulling = viewID == 0; // Only main view supports liquid culling so far
         bool viewRendersJoltDebug = viewID == 0;
 
         // Terrain
@@ -736,11 +736,11 @@ namespace Editor
             DrawCullingResourcesTriangle("Model (T)", viewID, cullingResources, true, viewSupportsOcclusionCulling, viewTriangles, viewTrianglesSurvived);
         }
 
-        // Water
-        if (viewRendersWaterCulling)
+        // Liquid
+        if (viewRendersLiquidCulling)
         {
-            CullingResourcesBase& cullingResources = waterRenderer->GetCullingResources();
-            DrawCullingResourcesTriangle("Water", viewID, cullingResources, true, viewSupportsOcclusionCulling, viewTriangles, viewTrianglesSurvived);
+            CullingResourcesBase& cullingResources = liquidRenderer->GetCullingResources();
+            DrawCullingResourcesTriangle("Liquid", viewID, cullingResources, true, viewSupportsOcclusionCulling, viewTriangles, viewTrianglesSurvived);
         }
 
         // Jolt Debug

Source/Game/Game/Gameplay/MapLoader.cpp

@@ -9,7 +9,7 @@
 #include "Game/Rendering/Terrain/TerrainLoader.h"
 #include "Game/Rendering/Model/ModelLoader.h"
 #include "Game/Rendering/Model/ModelRenderer.h"
-#include "Game/Rendering/Water/WaterLoader.h"
+#include "Game/Rendering/Liquid/LiquidLoader.h"
 #include "Game/Util/ServiceLocator.h"
 
 #include <Base/Memory/Bytebuffer.h>
@@ -123,7 +123,7 @@ void MapLoader::ClearRenderersForMap()
 {
     _terrainLoader->Clear();
     _modelLoader->Clear();
-    _waterLoader->Clear();
+    _liquidLoader->Clear();
 
     ServiceLocator::GetGameRenderer()->GetJoltDebugRenderer()->Clear();
 

Source/Game/Game/Gameplay/MapLoader.h

@@ -19,7 +19,7 @@ class MapLoader
     };
 
 public:
-    MapLoader(TerrainLoader* terrainLoader, ModelLoader* modelLoader, WaterLoader* waterLoader) : _terrainLoader(terrainLoader), _modelLoader(modelLoader), _waterLoader(waterLoader) { }
+    MapLoader(TerrainLoader* terrainLoader, ModelLoader* modelLoader, LiquidLoader* liquidLoader) : _terrainLoader(terrainLoader), _modelLoader(modelLoader), _liquidLoader(liquidLoader) { }
 
     void Update(f32 deltaTime);
 
@@ -34,7 +34,7 @@ class MapLoader
 private:
     TerrainLoader* _terrainLoader = nullptr;
     ModelLoader* _modelLoader = nullptr;
-    WaterLoader* _waterLoader = nullptr;
+    LiquidLoader* _liquidLoader = nullptr;
 
     u32 _currentMapIndex = std::numeric_limits<u32>().max();
     moodycamel::ConcurrentQueue<LoadDesc> _requests;

Source/Game/Game/Rendering/GameRenderer.cpp

@@ -8,8 +8,8 @@
 #include "Terrain/TerrainManipulator.h"
 #include "Model/ModelRenderer.h"
 #include "Model/ModelLoader.h"
-#include "Water/WaterRenderer.h"
-#include "Water/WaterLoader.h"
+#include "Liquid/LiquidRenderer.h"
+#include "Liquid/LiquidLoader.h"
 #include "Material/MaterialRenderer.h"
 #include "Skybox/SkyboxRenderer.h"
 #include "Editor/EditorRenderer.h"
@@ -137,14 +137,14 @@ GameRenderer::GameRenderer(InputManager* inputManager)
     _modelLoader = new ModelLoader(_modelRenderer);
     _modelLoader->Init();
 
-    _waterRenderer = new WaterRenderer(_renderer, _debugRenderer);
-    _waterLoader = new WaterLoader(_waterRenderer);
+    _liquidRenderer = new LiquidRenderer(_renderer, _debugRenderer);
+    _liquidLoader = new LiquidLoader(_liquidRenderer);
 
     _terrainRenderer = new TerrainRenderer(_renderer, _debugRenderer);
-    _terrainLoader = new TerrainLoader(_terrainRenderer, _modelLoader, _waterLoader);
+    _terrainLoader = new TerrainLoader(_terrainRenderer, _modelLoader, _liquidLoader);
     _terrainManipulator = new TerrainManipulator(*_terrainRenderer, *_debugRenderer);
 
-    _mapLoader = new MapLoader(_terrainLoader, _modelLoader, _waterLoader);
+    _mapLoader = new MapLoader(_terrainLoader, _modelLoader, _liquidLoader);
 
     _materialRenderer = new MaterialRenderer(_renderer, _terrainRenderer, _modelRenderer);
     _skyboxRenderer = new SkyboxRenderer(_renderer, _debugRenderer);
@@ -182,8 +182,8 @@ void GameRenderer::UpdateRenderers(f32 deltaTime)
     _terrainManipulator->Update(deltaTime);
     _modelLoader->Update(deltaTime);
     _modelRenderer->Update(deltaTime);
-    _waterLoader->Update(deltaTime);
-    _waterRenderer->Update(deltaTime);
+    _liquidLoader->Update(deltaTime);
+    _liquidRenderer->Update(deltaTime);
     _materialRenderer->Update(deltaTime);
     _joltDebugRenderer->Update(deltaTime);
     _debugRenderer->Update(deltaTime);
@@ -197,7 +197,12 @@ f32 GameRenderer::Render()
 {
     // If the window is minimized we want to pause rendering
     if (_window->IsMinimized())
+    {
+        ImGui::End();
+        ImGui::Render();
+        
         return 0.0f;
+    }
 
     Editor::EditorHandler* editorHandler = ServiceLocator::GetEditorHandler();
     bool isEditorMode = editorHandler->GetViewport()->IsEditorMode();
@@ -348,9 +353,9 @@ f32 GameRenderer::Render()
     _modelRenderer->AddTransparencyCullingPass(&renderGraph, _resources, _frameIndex);
     _modelRenderer->AddTransparencyGeometryPass(&renderGraph, _resources, _frameIndex);
 
-    _waterRenderer->AddCopyDepthPass(&renderGraph, _resources, _frameIndex);
-    _waterRenderer->AddCullingPass(&renderGraph, _resources, _frameIndex);
-    _waterRenderer->AddGeometryPass(&renderGraph, _resources, _frameIndex);
+    _liquidRenderer->AddCopyDepthPass(&renderGraph, _resources, _frameIndex);
+    _liquidRenderer->AddCullingPass(&renderGraph, _resources, _frameIndex);
+    _liquidRenderer->AddGeometryPass(&renderGraph, _resources, _frameIndex);
 
     _materialRenderer->AddMaterialPass(&renderGraph, _resources, _frameIndex);
 

Source/Game/Game/Rendering/GameRenderer.h

@@ -32,8 +32,8 @@ class EditorRenderer;
 class DebugRenderer;
 class JoltDebugRenderer;
 class CanvasRenderer;
-class WaterLoader;
-class WaterRenderer;
+class LiquidLoader;
+class LiquidRenderer;
 class UIRenderer;
 class PixelQuery;
 
@@ -56,13 +56,13 @@ class GameRenderer
 
 	TerrainRenderer* GetTerrainRenderer() { return _terrainRenderer; }
 	ModelRenderer* GetModelRenderer() { return _modelRenderer; }
-	WaterRenderer* GetWaterRenderer() { return _waterRenderer; }
+	LiquidRenderer* GetLiquidRenderer() { return _liquidRenderer; }
 	DebugRenderer* GetDebugRenderer() { return _debugRenderer; }
 	JoltDebugRenderer* GetJoltDebugRenderer() { return _joltDebugRenderer; }
 
 	TerrainLoader* GetTerrainLoader() { return _terrainLoader; }
 	ModelLoader* GetModelLoader() { return _modelLoader; }
-	WaterLoader* GetWaterLoader() { return _waterLoader; }
+	LiquidLoader* GetLiquidLoader() { return _liquidLoader; }
 	MapLoader* GetMapLoader() { return _mapLoader; }
 
 	TerrainManipulator* GetTerrainManipulator() { return _terrainManipulator; }
@@ -103,8 +103,8 @@ class GameRenderer
 	ModelRenderer* _modelRenderer = nullptr;
 	ModelLoader* _modelLoader = nullptr;
 
-	WaterRenderer* _waterRenderer = nullptr;
-	WaterLoader* _waterLoader = nullptr;
+	LiquidRenderer* _liquidRenderer = nullptr;
+	LiquidLoader* _liquidLoader = nullptr;
 
 	MapLoader* _mapLoader = nullptr;