Planar Engine

A 2D Game Engine.

Contents

1. Build
   • Requirements
   • Support
2. Project Structure
3. Dependencies

Build

Requirements

• C++20
• .NET 8 (C# 12)
• Visual Studio 2022 with C++ CMake tools for Windows

Support

Currently Windows is the only operating system supported.

Project Structure

Directory	Description
Asset	Assets that are used by core components
CMake	CMake utility modules
Include	Header and template implementations for Engine and Editor
Script	C# scripting interface
Source	Source for Engine and Editor
ThirdParty	CMake scripts used to fetch dependencies and contains a few third party source files
Website	Source for website hosted using Firebase Hosting

Dependencies

1. Planar Engine

   • Dav1dde/glad (2.0.6) - OpenGL loader
   • glfw/glfw (3.4) - Window, Input, OpenGL context
   • ocornut/imgui (1.91.0-docking) - Editor UI
   • jbeder/yaml-cpp (0.8.0) - Assets
   • nothings/stb (ae721c50) - Image loader
   • g-truc/glm (1.0.1) - Computer graphics types and routines
   • btzy/nativefiledialog-extended (1.2.0) - Select file and folder dialog
   • jarikomppa/soloud (799c535e) - Audio

2. Planar Editor

   • Planar Engine - All core routines
   • .NET SDK (8.0.300) - Build and publish C# projects
   • upx/upx (4.2.4) - Compress EXE and DLL
   • LZMA SDK (24.06) - Compress and extract 7z archives
   • DaanDeMeyer/reproc (14.2.5) - Create and manage processes
   • p-ranav/argparse (3.1) - Parse command line arguments

3. Website

   • rust-lang/mdBook (0.4.40) - Website and documentation