F.R.E.Y.A. — Fast Rendering Engine for Your Adventures

Welcome to F.R.E.Y.A., a rendering engine project built with Odin lang.

Prerequisites

Before you can build or run F.R.E.Y.A., you need the following software installed on your system:

• Odin lang: dev-2025-04 version or compatible.
• GLFW3: A multi-platform library for OpenGL, OpenGL ES, and Vulkan development.
• OpenGL 4.5: Ensure your graphics card drivers support OpenGL 4.5 or higher.
• Assimp (Open Asset Import Library): A library to load various 3D model formats.
• Git: For cloning the repository.
• Git LFS (Large File Storage): For handling large asset files stored in the repository.

(Installation methods vary by operating system. Use your system's package manager like apt, brew, pacman, choco, etc., or follow the official installation guides.)

Getting Started

You have two options to get F.R.E.Y.A. running: using a pre-built release or building it from the source code.

Option 1: Using a Pre-built Release (Recommended)

1. Navigate to the Releases page of this repository.
2. Download the latest release archive suitable for your operating system.
3. Extract the archive.
4. Run the animagik executable found inside the extracted folder.

If a release isn't available for your system, or if it doesn't function correctly, proceed to build it from the source code.

Option 2: Building from Source

Follow these steps if you prefer or need to build the project yourself.

1. Clone the Repository

git clone https://github.com/bytemomo/freya.git

cd freya

2. Fetch Dependencies (LFS Assets & Submodules)

git lfs pull
git submodule update --init --recursive

This command downloads required large assets and initializes necessary library submodules.

3. Compile the Project

Create a build directory:

mkdir -p build/

You can compile using either just (a command runner) or the odin compiler directly.

• Using just:

  # Build release version
  just build
  
  # Build debug version
  just build-dbg

• Using odin directly:

  # Build release version -> build/animagik
  odin build animagik -out:build/animagik
  
  # Build debug version -> build/animagik-dbg
  odin build animagik -out:build/animagik-dbg -debug

4. Run the Application

Execute the compiled binary from the project's root directory:

• For the release build:

  ./build/animagik

• For the debug build:

  ./build/animagik-dbg