refactor: Move engine into its own project

- The engine is now located in the `engine` folder
- Header files are now in `engine/include` and source files are in `engine/src`

CMakeLists.txt

@@ -6,3 +6,7 @@ set(CMAKE_CXX_STANDARD 17)
 # Add source files
 file(GLOB_RECURSE SOURCES src/*)
 add_executable(Textual_Game ${SOURCES})
+
+# Link libraries
+add_subdirectory(engine)
+target_link_libraries(Textual_Game Engine)

engine/CMakeLists.txt

@@ -0,0 +1,11 @@
+cmake_minimum_required(VERSION 3.5)
+project(Engine)
+
+set(CMAKE_CXX_STANDARD 17)
+
+# Add source files
+file(GLOB_RECURSE ENGINE_SOURCES src/*)
+add_library(Engine ${ENGINE_SOURCES})
+
+# Set include directory
+target_include_directories(Engine PUBLIC include)

src/engine/components/gravityComponent.h → engine/include/engine/components/gravityComponent.h

@@ -1,6 +1,6 @@
 #pragma once
 
-#include "_component.h"
+#include <engine/components/_component.h>
 
 class GravityComponent : public Component {
 private:

src/engine/components/scriptComponent.h → engine/include/engine/components/scriptComponent.h

@@ -1,4 +1,6 @@
-#include "_component.h"
+#pragma once
+
+#include <engine/components/_component.h>
 
 class ScriptComponent : public Component {
 private:

src/engine/components/spriteComponent.h → engine/include/engine/components/spriteComponent.h

@@ -1,7 +1,7 @@
 #pragma once
 
-#include "_component.h"
-#include "../common.h"
+#include <engine/components/_component.h>
+#include <engine/common.h>
 #include <vector>
 #include <iterator>
 

src/engine/components/transformComponent.h → engine/include/engine/components/transformComponent.h

@@ -1,6 +1,6 @@
 #pragma once
 
-#include "_component.h"
+#include <engine/components/_component.h>
 
 /**
  * @brief A component that represents the position, scale, and rotation of an entity.

src/engine/ecs.h → engine/include/engine/ecs.h

@@ -1,14 +1,23 @@
 #pragma once
 
-#include "entities/_entity.h"
-#include "systems/_system.h"
+#include <engine/entity.h>
+#include <engine/systems/_system.h>
 #include <memory>
 #include <set>
 
 class ECS {
     static std::multiset<std::unique_ptr<Entity>> _entities;
     static std::set<std::unique_ptr<System>> _systems;
     static bool _isRunning;
+
+    /**
+     * @brief Adds a system to the ECS
+     * @tparam SystemType
+     */
+    template <typename SystemType>
+    static void AddSystem() {
+        _systems.insert(std::make_unique<SystemType>());
+    }
 public:
     /**
      * @brief Adds an entity to the ECS
@@ -21,19 +30,13 @@ class ECS {
         _entities.insert(std::make_unique<EntityType>());
     }
 
-    /**
-     * @brief Adds a system to the ECS
-     * @tparam SystemType
-     */
-    template <typename SystemType>
-    static void AddSystem() {
-        _systems.insert(std::make_unique<SystemType>());
-    }
-
     static std::multiset<std::unique_ptr<Entity>>& GetEntities();
 
     static void GameLoop();
 
+    /**
+     * @brief Stops the game loop
+     */
     static void StopGame();
 };
 

src/engine/entities/_entity.h → engine/include/engine/entity.h

@@ -1,15 +1,13 @@
 #pragma once
 
-#include "../components/_component.h"
+#include <engine/components/_component.h>
 #include <memory>
 #include <typeindex>
 #include <unordered_map>
 #include <unordered_set>
 #include <string>
 #include <iostream>
 
-#define ComponentMap std::unordered_map<std::type_index, std::unique_ptr<Component>>
-
 /*
  * @brief The base class for all entities
  */
@@ -20,7 +18,7 @@ class Entity {
      * The value is a unique pointer to the component.
      * This is a map so that we can easily access the component by its type.
      */
-    ComponentMap components;
+    std::unordered_map<std::type_index, std::unique_ptr<Component>> components;
 
     // Tells systems the order in which to execute the entity
     int executionPriority = 0;
@@ -59,7 +57,9 @@ class Entity {
         return ((components.find(typeid(ComponentTypes)) != components.end()) && ...);
     }
 
+    // Orders the entity inside of sets
     bool operator<(const Entity &other) const;
 
-    bool gotDestroyed() const;
+    // Check if the entity is destroyed
+    [[nodiscard]] bool gotDestroyed() const;
 };

src/engine/systems/_system.h → engine/include/engine/systems/_system.h

@@ -1,8 +1,5 @@
 #pragma once
 
-#include "../entities/_entity.h"
-
-
 /**
  * @brief Base class for all systems
  */

engine/include/engine/systems/input.h

@@ -0,0 +1,36 @@
+#pragma once
+
+#include <engine/systems/_system.h>
+#include <unordered_map>
+
+enum Key {
+    LEFT = 0,
+    RIGHT,
+    QUIT
+};
+
+class Input : public System {
+    enum KeyState {UP, PRESSED, HELD};
+    static std::unordered_map<Key, KeyState> keys;
+public:
+    /**
+     * @brief Loops over all the keys and tracks their state
+     * @note This function should be called once per frame
+     * to update the key states for the current frame
+     */
+    void Update() override;
+
+    /**
+     * @brief Check if a key is held down
+     * @param key The key to check
+     * @return bool True if the key is held
+     */
+    static bool GetKeyDown(Key key);
+
+    /**
+     * @brief Check if a key is pressed
+     * @param key The key to check
+     * @return bool True if the key is pressed
+     */
+    static bool GetKeyPressed(Key key);
+};

engine/include/engine/systems/renderSystem.h

@@ -0,0 +1,49 @@
+#pragma once
+
+#include <engine/systems/_system.h>
+#include <engine/components/spriteComponent.h>
+#include <string>
+#include <windows.h>
+#include <algorithm>
+#include <iostream>
+
+class RenderSystem : public System {
+    // Handle to the console
+    HANDLE hStdOut = GetStdHandle(STD_OUTPUT_HANDLE);
+    CONSOLE_SCREEN_BUFFER_INFO consoleInfo{};
+
+    // Buffer to store the console
+    std::vector<std::pair<char, Color>> consoleBuffer;
+    int charCount = 0;
+
+    // Queue screen clear
+    bool clearScreen = false;
+
+    /**
+     * @brief Determines the alpha and color of a point
+     * @details The alpha is calculated using the barycentric coordinates method
+     * @param SpriteComponent The points of the triangle strip
+     * @param x The x-coordinate of the point
+     * @param y The y-coordinate of the point
+     * @return A character representing the luminance of the point
+     */
+    static std::pair<char, Color> AlphaColorOfPoint(SpriteComponent &sprite, int x, int y);
+
+    /**
+     * @brief Sets a character at a position in the console
+     * @param x The x-coordinate of the character
+     * @param y The y-coordinate of the character
+     * @param character The character to set
+     */
+    void SetConsoleCharacter(int x, int y, std::pair<char, Color> character);
+
+    /**
+     * @brief Draws a triangle to the console
+     * @param triangleList The points of the triangle strip
+     * @param index The index of the first point in the triangle strip
+     */
+    void DrawTriangle(SpriteComponent &sprite, int index);
+public:
+    RenderSystem();
+    void Update() override;
+};

src/engine/systems/spriteSystem.h → engine/include/engine/systems/spriteSystem.h

@@ -1,7 +1,7 @@
 #pragma once
 
-#include "_system.h"
-#include "../components/spriteComponent.h"
+#include <engine/systems/_system.h>
+#include <engine/components/spriteComponent.h>
 
 class SpriteSystem : public System {
 public:

src/engine/systems/timeSystem.h → engine/include/engine/systems/timeSystem.h

@@ -1,6 +1,6 @@
 #pragma once
 
-#include "_system.h"
+#include <engine/systems/_system.h>
 
 #include <chrono>
 

src/engine/systems/transformSystem.h → engine/include/engine/systems/transformSystem.h

@@ -1,7 +1,7 @@
-#include "_system.h"
-#include "../common.h"
-#include "../components/transformComponent.h"
-#include "../components/spriteComponent.h"
+#include <engine/systems/_system.h>
+#include <engine/common.h>
+#include <engine/components/transformComponent.h>
+#include <engine/components/spriteComponent.h>
 
 class TransformSystem : public System {
 public:

src/engine/components/gravityComponent.cpp → engine/src/engine/components/gravityComponent.cpp

@@ -1,4 +1,4 @@
-#include "gravityComponent.h"
+#include <engine/components/gravityComponent.h>
 
 GravityComponent& GravityComponent::operator=(float gravity) {
     this->_gravity = gravity;

src/engine/components/scriptComponent.cpp → engine/src/engine/components/scriptComponent.cpp

@@ -1,4 +1,4 @@
-#include "scriptComponent.h"
+#include <engine/components/scriptComponent.h>
 
 void ScriptComponent::operator()() {
     _script();

src/engine/components/spriteComponent.cpp → engine/src/engine/components/spriteComponent.cpp

@@ -1,4 +1,4 @@
-#include "spriteComponent.h"
+#include <engine/components/spriteComponent.h>
 
 SpriteComponent::SpriteComponent(std::initializer_list<ColoredPoint> sprite) {
     std::copy(sprite.begin(), sprite.end(), std::back_inserter(_sprite));

src/engine/ecs.cpp → engine/src/engine/ecs.cpp

@@ -1,5 +1,5 @@
-#include "ecs.h"
-#include "systems/timeSystem.h"
+#include <engine/ecs.h>
+#include <engine/systems/timeSystem.h>
 
 // We need to define the static variables here
 std::multiset<std::unique_ptr<Entity>> ECS::_entities;
@@ -13,10 +13,6 @@ std::multiset<std::unique_ptr<Entity>>& ECS::GetEntities() {
     return _entities;
 }
 
-/**
- * @brief Runs the every frame
- * @details It loops over all the systems and calls their UpdateEntity function
- */
 void ECS::GameLoop() {
     while(_isRunning) {
         TimeSystem::FrameStart();
@@ -27,9 +23,6 @@ void ECS::GameLoop() {
     }
 }
 
-/**
- * @brief Stops the game loop
- */
 void ECS::StopGame() {
     _isRunning = false;
 }

src/engine/entities/_entity.cpp → engine/src/engine/entity.cpp

@@ -1,11 +1,9 @@
-#include "_entity.h"
+#include <engine/entity.h>
 
-// Orders the entity inside of sets
 bool Entity::operator<(const Entity &other) const {
     return executionPriority < other.executionPriority;
 }
 
-// Check if the entity is destroyed
 bool Entity::gotDestroyed() const {
     return destroyed;
 }

src/engine/systems/input.cpp → engine/src/engine/systems/input.cpp

@@ -1,14 +1,9 @@
-#include "input.h"
+#include <engine/systems/input.h>
 #include <windows.h>
 
 // Define the static variable
 std::unordered_map<Key, Input::KeyState> Input::keys;
 
-/**
- * @brief Loops over all the keys and tracks their state
- * @note This function should be called once per frame
- * to update the key states for the current frame
- */
 void Input::Update() {
     for(int i = Key::LEFT; i <= Key::QUIT; i++) {
         bool held;
@@ -39,20 +34,10 @@ void Input::Update() {
     }
 }
 
-/**
- * @brief Check if a key is held down
- * @param key The key to check
- * @return bool True if the key is held
- */
 bool Input::GetKeyDown(Key key) {
     return keys[key] != KeyState::UP;
 }
 
- /**
- * @brief Check if a key is pressed
- * @param key The key to check
- * @return bool True if the key is pressed
- */
 bool Input::GetKeyPressed(Key key) {
     return keys[key] == KeyState::PRESSED;
 }