Installation¶

This guide will help you set up Evoker Engine for development.

Prerequisites¶

Before you begin, ensure you have the following installed:

Required¶

• .NET 9.0 SDK or later - Download here
• Vulkan SDK (runtime only) - Download here

Optional (for Mobile Development)¶

If you want to build for iOS or Android:

dotnet workload install ios android

Installation Methods¶

Method 1: Clone the Repository¶

Clone the Evoker Engine repository to get started:

git clone https://github.com/evokerking1/Evoker-Engine.git
cd Evoker-Engine

Method 2: Use as a Library¶

Add Evoker Engine as a reference to your project:

# Create a new project
dotnet new console -n MyGame

# Add reference to EvokerEngine.Core
dotnet add reference path/to/EvokerEngine.Core/EvokerEngine.Core.csproj

Building the Engine¶

Desktop Platforms (Windows, Linux, macOS)¶

# Build the entire solution
dotnet build

# Build in Release mode
dotnet build -c Release

Mobile Platforms (iOS, Android)¶

To build for mobile platforms (requires workloads installed):

# Build for mobile
dotnet build -p:BuildForMobile=true

# Or build specific platforms
dotnet build -f net9.0-android
dotnet build -f net9.0-ios

Running Tests¶

Evoker Engine includes 149 comprehensive unit tests:

# Run all tests
dotnet test

# Run tests with detailed output
dotnet test --logger "console;verbosity=detailed"

An HTML test report is automatically generated at: EvokerEngine.Tests/TestResults/TestResults.html

Running the Demo¶

Try the included demo application:

cd EvokerEngine.Demo
dotnet run

Demo Controls¶

Keyboard: - ESC - Exit application - F1 - Toggle VSync (logged only) - WASD - Camera movement (logged only)

Gamepad: - A/Cross - Action button - Start - Pause - Left Stick - Movement - Right Stick - Camera

Verify Installation¶

Create a simple test application to verify everything is working:

using EvokerEngine.Core;

var app = new Application("Test App", 800, 600);
app.Run();

Run it:

dotnet run

If you see a window open successfully, your installation is complete! 🎉

Troubleshooting¶

Vulkan SDK Not Found¶

Problem: Build fails with Vulkan-related errors.

Solution: 1. Download and install the Vulkan SDK 2. Restart your terminal/IDE 3. Verify installation: vulkaninfo or vkcube

.NET SDK Version Issues¶

Problem: Build fails with .NET version errors.

Solution: 1. Check your .NET version: dotnet --version 2. Install .NET 9.0 SDK or later 3. Update global.json if present

Mobile Workload Issues¶

Problem: Mobile builds fail.

Solution:

# Update workloads
dotnet workload update

# Repair workloads
dotnet workload repair

# Reinstall workloads
dotnet workload install ios android

Next Steps¶

Now that you have Evoker Engine installed:

• 📖 Continue to Quick Start to create your first application
• 🎮 Learn about Game Development
• 🔧 Explore Modding

Platform-Specific Notes¶