Polarity Engine

Polarity Engine is a lightweight, cross-platform 2D game engine for low-level gamedev

• Features
• Project Structure
• Getting Started
• Dev Information
• Roadmap
• Additional Resources
• Credits

---

Features

Right now the engine provides a development framework with abstractions for input, audio, entity-componet-system and 2d texture rendering (only windows right now). It also has a editor with limited use cases at the moment.

---

Project Structure

Brief explanation of key folders/files:

• Polarity - Engine files
• PolarityEditor - Editor
• Sandbox - Example project

Engine File Tree

Polarity
├───assets
├───src
│   ├───engine
│   │   ├───audio
│   │   ├───core
│   │   ├───debug
│   │   ├───ECS
│   │   ├───events
│   │   ├───imGui
│   │   ├───math
│   │   ├───renderer
│   │   ├───scene
│   │   └───utils
│   └───platform
│       ├───openGL
│       └───windows
└───thirdparty

---

Getting Started

The engine should be implemented as a submodule:

Project folder        <-- Have the same name as your game  
├── PolarityEngine/   <-- Engine as submodule (+Sandbox, Tools, Thirdparty)  
└── TestGame/         <-- Your game (Copied version of Sandbox)  

Setup (not up to date)

• Clone the repository as a submodule:

git submodule add https://github.com/AtleEng/PolarityEngine
git submodule update --init --recursive

• Add a premake5.lua file in your Project folder for generating solution
• Copy Sandbox to your Project folder as a starting point
• Remove premake5.lua in PolarityEngine
• In your Project folder use:

PolarityEngine\thirdparty\premake\premake5.exe vs2022

• Now a clean vs solution should have been generated

Inside project folder premake5.lua file

-- This should be in your project folder

workspace "TestGame"--          <-- name of your game
    architecture "x64"
    startproject "TestGame"--   <-- name of your game

    configurations
    {
        "Debug",
        "Release",
        "Dist"
    }

-- Output directory format
outputdir = "%{cfg.buildcfg}-%{cfg.system}-%{cfg.architecture}"

includedir = {}
includedir["GLFW"]      = "%{wks.location}/PolarityEngine/Polarity/thirdparty/GLFW/include"
includedir["Glad"]      = "%{wks.location}/PolarityEngine/Polarity/thirdparty/Glad/include"
includedir["ImGui"]     = "%{wks.location}/PolarityEngine/Polarity/thirdparty/imgui"
includedir["glm"]       = "%{wks.location}/PolarityEngine/Polarity/thirdparty/glm"
includedir["stb_image"] = "%{wks.location}/PolarityEngine/Polarity/thirdparty/stb_image"


group "Dependencies"
    include "PolarityEngine/Polarity/thirdparty/GLFW"
    include "PolarityEngine/Polarity/thirdparty/Glad"
    include "PolarityEngine/Polarity/thirdparty/imgui"
group ""


group "Core"
	include "PolarityEngine/Polarity"
group ""

group "Games"
    include "TestGame"--      <-- name of your game
group ""

Inside your game premake5.lua file

-- This should be in your game folder
project "TestGame"--          <-- name of your game
    location "%{wks.location}/%{prj.name}"
    kind "ConsoleApp"
    language "C++"
    cppdialect "C++17"
    staticruntime "off"

    targetdir ("%{wks.location}/bin/" .. outputdir .. "/%{prj.name}")
    objdir ("%{wks.location}/bin-int/" .. outputdir .. "/%{prj.name}")

    files
    {
        "src/**.h",
        "src/**.cpp"
    }
        
    vpaths
    {
        ["Header Files"] = { "**.h" },
        ["Source Files"] = { "**.cpp" }
    }

    includedirs
    {
        "%{wks.location}/PolarityEngine/Polarity/src",
        "%{wks.location}/PolarityEngine/Polarity/thirdparty",
        "%{includedir.glm}"
    }

    links
    {
        "Polarity"
    }

    filter "system:windows"
    systemversion "latest"
        defines
        {
            "POLARITY_PLATFORM_WINDOWS",
            "POLARITY_ENABLE_ASSERTS",
        }

    filter "configurations:Debug"
        defines "POLARITY_DEBUG"
        runtime "Debug"
        symbols "on"

    filter "configurations:Release"
        defines "POLARITY_RELEASE"
        runtime "Release"
        optimize "on"

    filter "configurations:Dist"
        defines "POLARITY_DIST"
        runtime "Release"
        optimize "on"

Update

To update Polarity in Project folder simply run:

• cd PolarityEngine
• git pull

Then remove the premake5.lua in PolarityEngine

---

Dev information

Dependencies

Library	Purpose
GLFW	Windowing & input
OpenGL	Rendering backend
ImGui	Debug/Editor UI
ImGuizmo	Render gizmos
GLM	Math library
stb_image	Image loading
yaml	Save/load

---

Roadmap

Get a somewhat working editor, then start working on a modular engine system

---

Additional Resources

• very empty right now...

---

Credits

Made by:

• Atle Engelbrektsson