Skip to content

Kyenel64/Locus-Engine

Repository files navigation

Locus Game Engine

Locus Logo
Website & Documentation

Locus is an open-source, general-purpose 2D/3D game engine for Windows.

Progress

Locus is still in early stages of development. Progress for Locus can be followed here.

Core Features

  • Integrated editor
  • C# scripting
  • PBR lighting & materials
  • Custom mesh loading
  • Sprite rendering
  • Primitive shape rendering (Circles, Cubes)
  • 2D physics
  • 3D physics (WIP)
  • UI rendering (WIP)
  • Spritesheets (WIP)
  • Skeletal animations (WIP)
  • 2D particle system (WIP)
  • Audio system (WIP)

Locus Editor

Locus Editor

How to Build

Requirements

  • Windows OS
  • OpenGL 4.5 supported hardware
  • Visual Studio 2022
  • Python 3
  • .NET SDK

1. Downloading source code

  • Run git clone --recursive https://github.com/kyenel64/Locus-Engine in the command prompt. Remember to include --recursive as Locus uses submodules.

2. Run Scripts/Setup.bat

  • Run Scripts/Setup.bat to install premake and generate a Visual Studio solution.
  • IMPORTANT: Make sure 'Shader Toolchain Debug Symbols - 64-bit' is selected if the Vulkan pop-up opens.

3. Build using Visual Studio

  • Open Locus.sln
  • Build solution. (Locus-Editor should be selected as the startup project).

4. Running the engine editor

  • The .exe file will be generated in bin/(Config)-windows-x86_64/Locus-Editor

Sample Project

  • If you would like to run the sample project, import it through the Locus Launcher by selecting the .sln file in the project directory.

Note:

  • Scripts in projects must be compiled manually for now. Build the VS solution within your project directory when making changes to scripts.

Dependencies