Harmony Engine

Cross-platform game engine and editor for making expansive 2D or 2.5D games.

Feature Roadmap

Disclaimer: This is a very much work in progress and not ready for public consumption.

---

The Harmony Engine consists of two main projects

• The GUI editor (HyEditor) that manages and handles all the offline work
• The engine itself (HyEngine) which is a static library that links into your application.

Technologies Utilized

Engine: OpenGL, SDL2 (or GLFW), Box2d, glad, glm, stb, soil2, rapidjson

Editor: Qt, freetype2, freetype-gl, libogg/vorbis, QtWaitingSpinner

Build: CMake, Emscripten

Editor Features (HyEditor)

• Generate and manage game projects and code builds
  • Manages all the CMake shenanigans under the hood
  • Use any major IDE
  • All library dependencies taken care of, including any specified ones you use
• A full asset pipeline from import -> optimize -> engine
  • Handle various types of assets such as tilesheets, PNG sequences, GLTF, and audio
  • Assets are packed into optimized banks with optional compression techniques
  • Quickly replace and iterate on existing assets
• Visually create every element in the game
  • Manage sprite animations with various states
  • Generate truetype fonts with optional effects such as outlines, inlines, and color blending
  • Audio can be logically grouped into cues with specified weighted randomness
  • Particle effects (TBD)
  • Visualize in-engine Spine® skeletons imports and specify runtime animation blending and mixing
• Create complex Entities using the elements above
  • Apply physics, add colliders, and setup bounding volumes

Engine Features (HyEngine)

• Compile and run the same game code in Windows, Mac, Linux environments. As well as target web and mobile environments by transpiling to wasm via Emscripten.
• Robust and simple programming API, learn once, apply to every type of game object
• First-class support for Spine Animation
• TBD

Installation

1. Clone this repository and navigate inside
   • Initialize the submodules git submodule update --init --recursive
2. CMake is used internally by the Harmony Editor to manage the project and build process. Download and execute the CMake Installer
   • Make sure to add the PATH environment variable during installation
3. Run a pre-built Release of the Harmony Editor, or compile it from source

Compiling the Editor from source

• Compiling the editor requires Qt6 - Only version 6.9.3 has been tested
• Download Qt for open source use: https://www.qt.io/download-qt-installer-oss
  • Note Visual Studio 2022 support requires 'Custom Installation' during the Installation Options
    • Select 'MSVC 2022 64-bit' under the version of Qt6 you're installing
    • Must include "Additional Libraries" -> Qt Multimedia
• Using CMake, choose one of the two methods below:

-- GUI TOOL ---------------------------------------------------------------------------------------------
Open CMake-gui tool

"Where is the source code:" should be:    <path to repo>
"Where to build the binaries:" should be: <path to repo>\build

Press "Configure" button and confirm creating the build directory
In the next dialog, choose which IDE to generate in first combo box

Fill in the value for variable Qt5_DIR. Specify cmake Qt5 directory:
-Example-  C:\Qt\6.9.3\msvc2022_64\lib\cmake\Qt6
  
Press "Configure" again until all red options disappear
Press "Generate" once
Press "Open Project" to open the generated solution (.sln) or navigate to the specified build directory

-- COMMAND LINE ----------------------------------------------------------------------------------------
  
cmake -S "<path to repo>" -B "<path to repo>\build" -DQt6_DIR=<path cmake Qt6> -G "Visual Studio 16 2019"

Fill in the value for variable Qt5_DIR. Specify cmake Qt5 directory:
-Example- C:\Qt\6.9.3\msvc2022_64\lib\cmake\Qt6

This will use default settings to generate a build. If on Windows, CMake will detect which version of 
Visual Studio you have installed to generate if you omit the -G argument. If Visual Studio 2019 is chosen 
it will default to generating 64bit, while older versions of Visual Studio will generate 32bit. You can
explicitly set the archetecture yourself by including the -G and -A arguments. Examples below:
... -G "Visual Studio 16 2019" -A Win32
... -G "Visual Studio 15 2017" -A x64
... -G "Visual Studio 14 2015" -A x64

The solution (.sln) will be placed in the build directory (-B argument above)

If using Visual Studio, installing Qt Visual Studio Tools extension is recommended, otherwise you can use QtCreator

Usage/Examples

HySprite2d hero("Level1", "Hero");
hero.Load();
hero.pos.Set(0.0f, 0.0f);

// Move right and grow larger
hero.pos.Tween(100.0f, 0.0f, 2.5f);
hero.scale.Tween(1.5f, 1.5f, 2.5f);

// TODO: actual useful examples

Documentation

https://hyengine.org/docs/

License

Engine: Modified zlib

Editor: GPL/LGPL