Merge pull request #149 from GP-Engine-team/develop

GOLD

Author: badsami

README.md

@@ -1,9 +1,13 @@
 # Green Portal Engine
 
+![](https://i.postimg.cc/PqK3mQgT/engine.png)
+![](https://i.postimg.cc/xdtknXz6/game.png)
+
+
 ## Documents
 [Production Pipeline document](https://docs.google.com/document/d/16_K5LYEYgaHoLp3JxO0UqVd54PJbOMVTss-FqXLqL3I/)  
 [Architecture diagrams](https://drive.google.com/drive/folders/1BV3M4kYvesof0PHtpZnjXgYIOzirfpd5)  
-[Google Drive](https://drive.google.com/drive/folders/13uqdCMKSp5BYv3FkD2sflDcJ6F_QaaVE)  
+[Google Drive](https://drive.google.com/drive/folders/13uqdCMKSp5BYv3FkD2sflDcJ6F_QaaVE)
 
 
 ## Getting started
@@ -12,35 +16,64 @@
 ```batch
 git clone --recurse-submodules https://github.com/GP-Engine-team/GP_Engine.git
 ```
-2. Download the assets [from the Drive](https://drive.google.com/drive/folders/1ElLiWl6cP_Z3WOdevMU3CpLjCIND17XD) and extract them from the root of your local copy of this repository (individually, or 
+If you already cloned the repository, you can use:
+```
+git submodule update
+```
+
+2. Download the assets [from the Drive](https://drive.google.com/drive/folders/1ElLiWl6cP_Z3WOdevMU3CpLjCIND17XD) (`projects` folder or `project.zip`) and extract them from the root of your local copy of this repository
 3. Open [projects/GPGame/GPGame.sln](projects/GPGame/GPGame.sln) in Visual Studio
 4. **Either set the "GPLauncher" or "GPEditor" project as startup project** to launch the game alone, or with the editor, respectively
 5. Choose either Debug or Release mode, and hit F5 to compile
 
-
-## Controls, features
-
-| Key   | Action           |
-|-------|------------------|
-| S     | Move backward    |
-| Z     | Move forward     |
-| Q     | Strafe left      | 
-| D     | Strafe right     | 
-| Space | Jump             |
-| Shift | Toggle sprint    |
-| Esc   | Exit the program |
+Here is a [link toward a build](https://drive.google.com/file/d/1dIkGqgNC_5oT-BVQ8gtu9o-6xPqjjMRD/view?usp=sharing).
+
+
+## Features
+- [x] Fully-fledged game editor with various edition tools
+- [x] Game launcher
+- [x] Serialization
+- [x] Reflexion
+- [x] Resource manager
+- [x] Custom resource and resource importation under multiple formats (.fbx, .obj, .wav, .jpeg, ...)
+- [x] Custom prefab exportation and importation
+- [x] Sound (Stereo, mono, spatialized)
+- [x] In-game UI
+- [x] Lights
+- [x] Shadows
+- [x] Scripts
+- [x] Hot reload with Visual Studio
+- [x] Particle system
+- [x] Animation system
+- [x] PhysX-based physics
+- [x] Custom math library implemented with unit tests (see the [GPM repository](https://github.com/GP-Engine-team/gpm))
+- [x] A game made entirely with the engine's editor
+
+
+## Game controls
+
+| Key         | Action           |
+|-------------|------------------|
+| S           | Move backward    |
+| Z           | Move forward     |
+| Q           | Strafe left      | 
+| D           | Strafe right     | 
+| R           | Reload           |
+| Space       | Jump             |
+| Shift       | Toggle sprint    |
+| Right-click | Aim              |
+| Left-click  | Fire             |
+| Esc         | Exit the program |
 
 
 ## Known bugs
-- Sounds are sometimes played with lags, in a fragmented way
-- Inputs declared in game-code collide with inputs declared in editor-code
-- When the editor's window is minimized, OpenGL errors are raised and visible in the console
-- The `ResourceManager` can't take a single template argument
+- Sounds sometimes stutter when there are several sources playing sound simultaneously
+- On older/low-end machines, FPS drops may sometimes be experienced
 
-## Repository folders architecture
 
+## Repository folders architecture
 - `editor/`: code relative to the editor
-- `engine/`: the heart of the C++ API
+- `engine/`: the heart of the engine's C++ API
 - `generator/`: reflexion with Refureku
 - `launcher/`: game-only launcher code
 - `projects/`: where the games made with the engine are edited
@@ -50,7 +83,7 @@ git clone --recurse-submodules https://github.com/GP-Engine-team/GP_Engine.git
 The following diagram, as well as other more specific UML diagrams, are [available on the project's Google Drive](https://drive.google.com/drive/folders/1BV3M4kYvesof0PHtpZnjXgYIOzirfpd5).
 
 Click the image to get a zoomable version of it.
-[![Global architecture diagram](https://i.postimg.cc/2ynPdCtG/Global-project-architecture.png)](https://postimg.cc/1V5Cs1sV)
+[![Global architecture diagram](https://i.postimg.cc/yYQ1561h/Global-project-architecture.png)](https://postimg.cc/bsnfSh2d)
 
 ## Dependencies
 
@@ -63,6 +96,6 @@ Click the image to get a zoomable version of it.
 - [glad](https://github.com/Dav1dde/glad) with [GL_KHR_Debug](https://www.khronos.org/registry/OpenGL/extensions/KHR/KHR_debug.txt)
 - [stb_image](https://github.com/nothings/stb/blob/master/stb_image.h)
 - [stb_image_write](https://github.com/nothings/stb/blob/master/stb_image_write.h)
-- [stb_perlin](https://github.com/nothings/stb/blob/master/stb_perlin.h)
 - [Refureku](https://github.com/jsoysouvanh/Refureku)
 - [RapidXML](http://rapidxml.sourceforge.net/manual.html)
+- [ImGuizmo](https://github.com/CedricGuillemet/ImGuizmo)

editor/include/Editor/Editor.hpp

@@ -37,13 +37,13 @@ class Editor
     GLFWwindow* m_window;
 
 public:
-    std::string         paperPress;
     SceneEditor         sceneEditor;
     GameViewer          gameViewer;
     LogInspector        logInspector;
     ProjectContent      projectContent;
     SceneGraph          sceneGraph;
     GameControlBar      gameControlBar;
+    std::string         paperPress;
     std::string         saveFolder;
     GPE::IInspectable*  inspectedObject;
     GPE::ReloadableCpp* reloadableCpp;
@@ -56,6 +56,7 @@ class Editor
 
 private:
     void setupDearImGui();
+    void setupWindowIcon();
 
     void renderLog();
     void renderStyleEditor();

editor/include/Editor/GameViewer.hpp

@@ -27,6 +27,8 @@ class GameViewer
     bool cursorTrackingStateInGame = false;
     bool setMouseInWindow          = false;
 
+    void checkInputs(EditorStartup& startup);
+
 public:
     GameViewer(int width = 1, int height = 1);
 

editor/include/Editor/ProjectContent.hpp

@@ -61,6 +61,22 @@ struct DirectoryInfo
         }
         return rst;
     }
+
+    size_t computeSize() const
+    {
+        size_t rst = 0;
+
+        for (auto&& it = files.cbegin(); it != files.cend(); ++it)
+        {
+            rst += it->size;
+        }
+
+        for (auto&& it = directories.cbegin(); it != directories.cend(); ++it)
+        {
+            rst += it->computeSize();
+        }
+        return rst;
+    }
 };
 
 class ProjectContent

editor/resources/Icone/green_portal.png

@@ -23,6 +23,7 @@
 #include <imgui/backends/imgui_impl_glfw.h>
 #include <imgui/backends/imgui_impl_opengl3.h>
 #include <imgui/imgui.h>
+#include <stb/stb_image.h>
 
 using namespace GPE;
 
@@ -50,6 +51,20 @@ void Editor::setupDearImGui()
     ImGuiLoadStyle(PATH_UI_STYLE, ImGui::GetStyle());
 }
 
+
+void Editor::setupWindowIcon()
+{
+    GLFWimage icon;
+
+    icon.pixels = stbi_load("..\\..\\editor\\resources\\icone\\green_portal.png",
+                            &icon.width, &icon.height, nullptr, 4);
+
+    glfwSetWindowIcon(m_window, 1, &icon);
+
+    stbi_image_free(icon.pixels);
+}
+
+
 void Editor::renderStyleEditor()
 {
     if (showAppStyleEditor)
@@ -78,6 +93,8 @@ void Editor::renderMenuBar()
             //{
             //    sceneEditor.view.unbindScene();
             //    Scene& scene = Engine::getInstance()->sceneManager.setCurrentScene(fileName);
+            //     if (Engine::getInstance()->sceneManager.OnSceneChange)
+            //      Engine::getInstance()->sceneManager.OnSceneChange();
             //    loadScene(&scene, path.c_str());
             //}
 
@@ -304,7 +321,8 @@ void Editor::renderShadowMap()
         const ImVec2 size{ImGui::GetContentRegionAvail()};
         ImGui::Image((void*)(intptr_t)Engine::getInstance()
                          ->sceneManager.getCurrentScene()
-                         ->sceneRenderer.getShadowMap()->depthMap,
+                         ->sceneRenderer.getShadowMap()
+                         ->depthMap,
                      size, {.0f, 1.f}, {1.f, .0f});
     }
     else
@@ -391,11 +409,24 @@ void Editor::unbindCurrentScene()
 
 /* ========================== Constructor & destructor ========================== */
 Editor::Editor(GLFWwindow* window, GPE::Scene& editedScene)
-    : sceneEditor(editedScene), gameViewer{}, logInspector{}, projectContent(*this),
-      sceneGraph(*this), gameControlBar{}, saveFolder{}, m_window{window}, inspectedObject{nullptr},
-      showAppStyleEditor{false}, showImGuiDemoWindows{false}
+    : sceneEditor         (editedScene),
+      gameViewer          {},
+      logInspector        {},
+      projectContent      (*this),
+      sceneGraph          (*this),
+      gameControlBar      {},
+      paperPress          {},
+      saveFolder          {},
+      m_window            {window},
+      inspectedObject     {nullptr},
+      reloadableCpp       {nullptr},
+      showAppStyleEditor  {false},
+      showImGuiDemoWindows{false},
+      showShadowMap       {false},
+      OnUIBeginFrame      {}
 {
     setupDearImGui();
+    setupWindowIcon();
 }
 
 void Editor::setSceneInEdition(GPE::Scene& scene)
@@ -447,14 +478,14 @@ void Editor::updateKeyboardShorthand(EditorStartup& startup)
     if (!sceneEditor.view.capturingInputs() && ImGui::IsKeyPressed(GLFW_KEY_S) &&
         (ImGui::IsKeyDown(GLFW_KEY_LEFT_CONTROL) || ImGui::IsKeyDown(GLFW_KEY_RIGHT_CONTROL)))
     {
-        if (startup.game().state == EGameState::STOPPED
-            || (ImGui::IsKeyDown(GLFW_KEY_RIGHT_SHIFT) || ImGui::IsKeyDown(GLFW_KEY_LEFT_SHIFT)))
+        if (startup.game().state == EGameState::STOPPED ||
+            (ImGui::IsKeyDown(GLFW_KEY_RIGHT_SHIFT) || ImGui::IsKeyDown(GLFW_KEY_LEFT_SHIFT)))
         {
             saveCurrentScene();
         }
     }
 
-    if (!sceneEditor.view.capturingInputs() && ImGui::IsKeyPressed(GLFW_KEY_C) &&
+    if (!sceneEditor.view.capturingInputs() && !ImGui::IsAnyItemActive() && ImGui::IsKeyPressed(GLFW_KEY_C) &&
         (ImGui::IsKeyDown(GLFW_KEY_LEFT_CONTROL) || ImGui::IsKeyDown(GLFW_KEY_RIGHT_CONTROL)))
     {
         if (GameObject* inspectedGo = dynamic_cast<GameObject*>(inspectedObject))
@@ -464,7 +495,7 @@ void Editor::updateKeyboardShorthand(EditorStartup& startup)
         }
     }
 
-    if (!sceneEditor.view.capturingInputs() && ImGui::IsKeyPressed(GLFW_KEY_V) &&
+    if (!sceneEditor.view.capturingInputs() && !ImGui::IsAnyItemActive() && ImGui::IsKeyPressed(GLFW_KEY_V) &&
         (ImGui::IsKeyDown(GLFW_KEY_LEFT_CONTROL) || ImGui::IsKeyDown(GLFW_KEY_RIGHT_CONTROL)))
     {
         if (paperPress.size())

editor/src/Editor.cpp

@@ -150,10 +150,6 @@ void EditorStartup::openGame()
         io.setCursorTrackingState(false);
     }
 
-    // Ending the game must not close the whole engine when the editor is opened
-    // The editor handles exiting the whole application itself
-    m_engine->exit = [&]() { m_editor.releaseGameInputs(); };
-
     // If the editor was not already shown, show it after the game is fully instanciated
     glfwMaximizeWindow(GPE::Engine::getInstance()->window.getGLFWWindow());
 }
@@ -175,22 +171,18 @@ void EditorStartup::closeGame()
 
     // TODO: are the scenes previously loaded removed by m_game's destructor?
     m_editor.setSceneInEdition(m_engine->sceneManager.setCurrentScene("Default scene"));
-
-    // There is no more active game, replace m_engine->exit to something not dependant on m_game
-    m_engine->exit = [&]() { m_engine->window.close(); };
 }
 
 void EditorStartup::playGame()
 {
-    m_engine->sceneManager.getCurrentScene()->behaviourSystem.onGameAssert = [&](const char* msg)
-    {
+    m_engine->sceneManager.getCurrentScene()->behaviourSystem.onGameAssert = [&](const char* msg) {
         Log::getInstance()->logError(msg);
         stopGame();
     };
 
     Engine::getInstance()->sceneManager.OnSceneChange = std::bind(&EditorStartup::startScene, this);
 
-    //m_editor.gameViewer.lockInputToGame();
+    // m_editor.gameViewer.lockInputToGame();
 
     if (m_game->state == EGameState::STOPPED)
     {
@@ -201,10 +193,10 @@ void EditorStartup::playGame()
     m_fixedUpdate = [&](double fixedUnscaledDeltaTime, double fixedDeltaTime) {
         if (m_game->state == EGameState::PLAYING)
         {
-            m_engine->physXSystem.advance(fixedDeltaTime);
             m_engine->sceneManager.getCurrentScene()->behaviourSystem.fixedUpdate(fixedDeltaTime);
-
             m_game->fixedUpdate(fixedUnscaledDeltaTime, fixedDeltaTime);
+            m_engine->physXSystem.updateController(fixedDeltaTime);
+            m_engine->physXSystem.advance(fixedDeltaTime);
         }
     };
 
@@ -244,6 +236,10 @@ void EditorStartup::playGame()
     m_engine->inputManager.setCursorLockState(false);
     m_engine->inputManager.setCursorTrackingState(false);
     m_engine->inputManager.setCursorMode(GLFW_CURSOR);
+
+    // Ending the game must not close the whole engine when the editor is opened
+    // The editor handles exiting the whole application itself
+    m_engine->exit = [&]() { m_editor.releaseGameInputs(); };
 }
 
 void EditorStartup::pauseGame()
@@ -277,6 +273,9 @@ void EditorStartup::stopGame()
     if (m_game->state == EGameState::STOPPED)
         return;
 
+    // reset time scale
+    m_engine->timeSystem.setTimeScale(1.f);
+
     m_engine->soundSystem.stopAllComponents();
     m_engine->sceneManager.getCurrentScene()->behaviourSystem.startOnBehaviourAdd = false;
     m_engine->sceneManager.getCurrentScene()->behaviourSystem.onGameAssert        = nullptr;
@@ -302,6 +301,9 @@ void EditorStartup::stopGame()
         }
     };
 
+    // There is no more active game, replace m_engine->exit to something not dependant on m_game
+    m_engine->exit = [&]() { m_engine->window.close(); };
+
     m_editor.reloadCurrentScene();
     m_game->state = EGameState::STOPPED;
 }
@@ -334,6 +336,7 @@ void EditorStartup::update()
 
 void EditorStartup::startScene()
 {
+    m_editor.inspectedObject = nullptr;
     m_editor.setSceneInEdition(*GPE::Engine::getInstance()->sceneManager.getCurrentScene());
     GPE::Engine::getInstance()->sceneManager.getCurrentScene()->behaviourSystem.start();
 }