Skip to content

setup.md

Latest commit

 

History

History
193 lines (130 loc) · 5.2 KB

setup.md

File metadata and controls

193 lines (130 loc) · 5.2 KB

Setup Guide for ClueEngine

Introduction

This guide will help you set up ClueEngine on your system using CMake for building the project and Docker for creating a containerized development environment. Most of the necessary dependencies (such as GLAD, SOIL2, GLEW, etc.) are included in the repository, but you will need to install GLFW manually on Linux/macOS.

Prerequisites

Before setting up ClueEngine, ensure the following tools are installed on your system:

  • CMake (for building the project)
  • C++ Compiler (e.g., GCC, Clang, MSVC)
  • GLFW (Required on Linux/macOS)
  • Docker (optional for containerized setup)
  • Visual Studio (Windows only, for .sln support)
  • Docker (for containerized setup)
  • Kubernetes & kubectl (for Kubernetes deployment)

If you prefer using Docker, ClueEngine provides a Dockerfile that automatically installs dependencies and sets up the environment.

Installing Dependencies

Windows

GLFW is included in the repository, so no extra steps are needed.

Linux

Install GLFW3 using your package manager:

# Ubuntu/Debian
sudo apt update && sudo apt install libglfw3-dev

# Arch Linux
sudo pacman -S glfw-x11   # Use glfw-wayland if on Wayland

# Fedora
sudo dnf install glfw-devel

# openSUSE
sudo zypper install glfw-devel

macOS

Install GLFW3 using Homebrew:

brew install glfw

CMake Setup (Preferred Method)

Step 1: Clone the Repository

git clone https://github.com/Klus3kk/ClueEngine.git
cd ClueEngine

Step 2: Build the Project

Use CMake to configure and build the project:

cmake -B build
cmake --build build

This will compile the source code and generate the ClueEngine executable in the bin directory.

Step 3: Run the Engine

Once the project is built, you can run the engine executable:

  • On Linux/macOS:
./bin/ClueEngine
  • On Windows, you can use the .exe file located in the ./bin directory:
./bin/ClueEngine.exe

Visual Studio Setup (Windows Only)

For users on Windows, ClueEngine also provides a Visual Studio Solution file (ClueEngine.sln) that allows you to open and build the project directly in Visual Studio.

Step 1: Open the Solution

  • Launch Visual Studio.
  • Open the ClueEngine.sln file located in the root directory of the project.

Step 2: Build the Project

  • In Visual Studio, right-click the ClueEngine project in the Solution Explorer and select Build.
  • This will compile the project and generate the executable in the bin directory.

Step 3: Run the Engine

  • Once the build is successful, run the project directly from Visual Studio or navigate to the ./bin folder and run the executable:
./bin/ClueEngine.exe

Docker Setup (Alternative Method)

If you prefer an isolated environment, you can set up ClueEngine using Docker. This method ensures that the required dependencies are bundled into the container and isolates the environment.

Step 1: Install Docker

Follow the instructions on the Docker website to install Docker on your system.

Step 2: Build the Docker Image

Navigate to the project directory and build the Docker image:

docker build -t clueengine .

Step 3: Run the Docker Container

Run the Docker container with the following command:

docker run --rm -it --net=host --env DISPLAY=$DISPLAY \
    --device /dev/dri \
    --device /dev/snd \
    --group-add video \
    --group-add audio \
    -v /tmp/.X11-unix:/tmp/.X11-unix \
    clueengine

This command will start the container and run ClueEngine within the isolated environment.

Kubernetes Deployment (Optional)

If you want to deploy ClueEngine using Kubernetes, follow these steps.

Step 1: Install Kubernetes and kubectl

Follow the official Kubernetes installation guide and install kubectl.

Step 2: Build and Push Docker Image

Before deploying on Kubernetes, push the Docker image to a registry (e.g., Docker Hub, AWS ECR, or Google Container Registry).

# Tag and push to Docker Hub (replace YOUR_USERNAME with your Docker Hub username)
docker tag clueengine YOUR_USERNAME/clueengine:v1.1.0
docker push YOUR_USERNAME/clueengine:v1.1.0

Step 3: Apply Kubernetes Configuration

Apply the Kubernetes deployment and service YAML files:

kubectl apply -f k8s/deployment.yaml
kubectl apply -f k8s/service.yaml

Step 4: Check Status

Verify that the deployment is running:

kubectl get pods
kubectl get deployments
kubectl get services

If the pod is failing, check logs:

kubectl logs -f deployment/clueengine

Step 5: Access ClueEngine

If the service is of type NodePort, use:

kubectl get services

Find the NodePort and access ClueEngine via http://localhost:<PORT>.

If using LoadBalancer, wait for the external IP:

kubectl get services clueengine-service

Next Steps

After successfully building and running ClueEngine, you can start creating your 3D scenes! Refer to the User Guide for instructions on how to create and manage objects, materials, lights, and more.