Installation - shmellyorc/Box GitHub Wiki

Installation

Follow these steps to get Box Engine up and running in your .NET project.

Prerequisites

.NET SDK 7.0 or later installed on your machine. You can download it from the [official .NET site](https://dotnet.microsoft.com/download).

1. Add the BoxEngine NuGet package

In your existing project directory, run:

dotnet add package BoxEngine

This installs the core Box Engine libraries into your project.

2. (Optional) Install the BoxEngine project template

Box Engine provides a ready-made template to scaffold a new C# game project.

# Install the template package (version 1.0.13-alpha)
dotnet new install BoxEngine.Templates.CSharp::1.0.13-alpha

# Create a fresh Box Engine project
# Replace "MyGame" with your desired project name
dotnet new boxy -n MyGame

This generates a minimal working Box Engine app with a Program.cs already wired to start the engine.

3. Verify your setup

Change into your project folder:
```
cd MyGame
```
Build and run:
```
dotnet run
```

You should see a window open (using the default Box Engine settings). If so, your installation is complete!

Ready for the Getting Started guide? Proceed to Getting Started to learn how to configure and run your first screen.