Arcane

Arcane is a modern, high-performance game engine designed for Windows, focusing on ease of use and powerful performance. With a robust API and simple integration of popular libraries, Arcane aims to help developers create 2D games with a clean, modern approach.

Features

• Performance-focused: Arcane is optimized for performance and designed with modern hardware and software patterns.
• API-first design: Arcane provides a simple, intuitive API with support for widely used libraries; including GLM, EnTT, spdlog, and nlohmannjson.
• Hot-swappable code: Client code is exported as a DLL and injected into an execution environment, enabling hot-swappable code and easy mod support.

Getting Started

Prerequisites

• Platform: Windows 10+
• Compiler: Visual Studio 2022 (configured via premake)
• Build Tool: Premake5

Installation

1. Clone the Repository:

git clone https://github.com/T3mps/Arcane.git

3. Run Premake5: The repository includes a premake5 file. To set up the project, simply run the premake5 script to configure and generate Visual Studio project files:

premake5 vs2022

4. Build the Project: Open the generated project in Visual Studio, build the solution, and you're ready to start using Arcane.

Example Usage

Below is a basic example of how to use Arcane in a game:

#include "Arcane.h"

void Update(float dt)
{
  // Custom update logic...
}

void Render()
{
  // Custom render logic...
}

ARC_API void EntryPoint()
{
   auto* app = new ARC::Application();
   app->RegisterUpdateCallback<Update>();
   app->RegisterRenderCallback<Render>();
   
   app->Run();
   
   delete app;
}

This example shows how to set up basic game loops with update and render callbacks using the Arcane API.

Documentation

arcane.starworks.space/docs

For the latest updates and upcoming features, refer to the Roadmap and Changelog (coming soon).

License

This project is licensed under the MPL-2.0 License. See the LICENSE file for details.