Build: Add Linux default graphics API (Vulkan)

[roku674]

Summary

• Adds Vulkan as the default graphics API for Linux builds
• Currently, Linux has no default graphics API defined, requiring users to manually specify -p:StrideGraphicsApi=Vulkan
• This aligns Linux with other platforms that have sensible defaults (Windows→Direct3D11, Android→OpenGLES, iOS→OpenGLES)

The Change

<StrideDefaultGraphicsApi Condition="'$(StridePlatform)' == 'Linux'">Vulkan</StrideDefaultGraphicsApi>

Added to sources/targets/Stride.props alongside the existing platform defaults.

Proof of Concept

This fix has been validated in a production Docker environment running a Stride-based game server. Here is the complete working Dockerfile:

# Use the .NET SDK to build the project
FROM mcr.microsoft.com/dotnet/sdk:8.0 AS build
WORKDIR /src

# Copy the project files and restore dependencies
COPY AdAstraImperium.Server/AdAstraImperium.Server.csproj ./AdAstraImperium.Server/
COPY AdAstraImperium.Common/AdAstraImperium.Common.csproj ./AdAstraImperium.Common/
RUN dotnet restore ./AdAstraImperium.Server/AdAstraImperium.Server.csproj

# Copy the rest of the project files and build the project
COPY AdAstraImperium.Server/. ./AdAstraImperium.Server/
COPY AdAstraImperium.Common/. ./AdAstraImperium.Common/
WORKDIR /src/AdAstraImperium.Server
RUN dotnet publish -c Release -r linux-x64 --self-contained false -o /app/publish -p:StrideGraphicsApi=Vulkan -p:StridePlatform=Linux

# Use Debian Bookworm-based .NET runtime for newer Mesa (22.3+)
FROM mcr.microsoft.com/dotnet/runtime:8.0-bookworm-slim AS base

# Install dependencies for Stride/SDL2, Vulkan, and virtual display
# Note: libfreetype-dev and libfreeimage-dev are used instead of runtime packages
# because Stride's NativeLibraryHelper looks for unversioned symlinks (e.g.,
# libfreetype.so, libfreeimage.so) which only exist in -dev packages.
# The Stride NuGet packages don't include Linux builds for freetype and freeimage.
RUN apt-get update && apt-get install -y \
    libsdl2-2.0-0 \
    libsdl2-dev \
    libopenal1 \
    libgl1-mesa-glx \
    libgl1-mesa-dri \
    libvulkan1 \
    mesa-vulkan-drivers \
    vulkan-tools \
    libfreetype-dev \
    libfreeimage-dev \
    xvfb \
    x11-utils \
    procps \
    && rm -rf /var/lib/apt/lists/*

# Set up environment variables for headless rendering with Vulkan support
# Note: STRIDE_GRAPHICS_API is a compile-time setting (MSBuild property), not runtime.
# The Vulkan DLLs are selected during 'dotnet publish' via -p:StrideGraphicsApi=Vulkan
ENV DISPLAY=:99

# Use llvmpipe instead of softpipe - llvmpipe is faster and more stable
# llvmpipe uses LLVM for JIT compilation of shaders
ENV GALLIUM_DRIVER=llvmpipe
ENV LIBGL_ALWAYS_SOFTWARE=1

# Lavapipe (software Vulkan) configuration
ENV VK_ICD_FILENAMES=/usr/share/vulkan/icd.d/lvp_icd.x86_64.json

# Disable Mesa shader cache to avoid potential corruption issues
ENV MESA_SHADER_CACHE_DISABLE=1

# Force single-threaded llvmpipe to reduce chance of race conditions
# Comment this out if you need more performance and stability is acceptable
ENV LP_NUM_THREADS=1

# Enable Mesa debug output for crash diagnostics (remove in production if too verbose)
ENV MESA_DEBUG=silent

WORKDIR /app

# Copy the built files from the build stage to the runtime stage
COPY --from=build /app/publish .

# Expose the port your application runs on
EXPOSE 3000

# Start Xvfb and run the application
# Using shell form to allow backgrounding Xvfb
ENTRYPOINT Xvfb :99 -screen 0 1024x768x24 -ac +extension GLX +render -noreset & sleep 2 && dotnet AdAstraImperium.Server.dll

Key Insights from Production Use

1. Compile-time API selection: The graphics API is a compile-time decision via MSBuild properties (-p:StrideGraphicsApi=Vulkan), not a runtime environment variable
2. Native library symlinks: Stride's NativeLibraryHelper expects unversioned symlinks (libfreetype.so), which requires -dev packages on Linux
3. Headless rendering: Works with llvmpipe/lavapipe software rendering for server scenarios
4. This default ensures Linux builds "just work" without manual configuration

Test Plan

• Linux build completes without specifying -p:StrideGraphicsApi
• Vulkan graphics backend is correctly selected
• Does not affect Windows/Android/iOS builds (they use TargetFramework-based conditions, this uses StridePlatform)

[roku674]

@roku674 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@dotnet-policy-service agree [company="{your company}"]

Options:

• (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.

@dotnet-policy-service agree

• (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.

@dotnet-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ),
and conveys certain license rights to the .NET Foundation ( “.NET Foundation” ) for Your contributions to
.NET Foundation open source projects. This Agreement is effective as of the latest signature date below.

1. Definitions.

“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to .NET Foundation under this Agreement.

“Project” means any of the projects owned or managed by .NET Foundation and offered under a license
approved by the Open Source Initiative (www.opensource.org).

“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”

“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.

2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.

3. Originality of Work. You represent that each of Your Submissions is entirely Your
original work. Should You wish to Submit materials that are not Your original work,
You may Submit them separately to the Project if You (a) retain all copyright and
license information that was in the materials as you received them, (b) in the
description accompanying your Submission, include the phrase "Submission
containing materials of a third party:" followed by the names of the third party and any
licenses or other restrictions of which You are aware, and (c) follow any other
instructions in the Project's written guidelines concerning Submissions.

4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.

5. Licenses.

a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly
or indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable
license in the Submission to reproduce, prepare derivative works of, publicly display, publicly perform,
and distribute the Submission and such derivative works, and to sublicense any or all of the foregoing
rights to third parties.

b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or
indirectly from .NET Foundation, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license
under Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.

c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

6. Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3 ). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6 , THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.

7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or
circumstances of which You later become aware that would make Your representations in this
Agreement inaccurate in any respect.

8. Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.

9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.

10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by .NET Foundation.

.NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1.

To respond to this just for documentation. This is not for/from a company. This is solely me as an individual

Alexander Fields
https://www.alexanderfields.me/experience

[roku674]

@dotnet-policy-service agree

[MeharDT]

Thanks for the PR!

Is Stride's implementation of Vulkan stable enough on Linux for it to replace OpenGL as the default API? Pinging @Jklawreszuk because they work on the Linux platform quite a bit.

[roku674]

Thanks for the PR!

Is Stride's implementation of Vulkan stable enough on Linux for it to replace OpenGL as the default API? Pinging @Jklawreszuk because they work on the Linux platform quite a bit.

Now that you mention it i just noticed a crash in my container I need to investigate if this is because of Vulkan

stack trace: at Stride.Engine.Processors.TransformProcessor.UpdateTransformationsRecursive(Scene scene) in C:\BuildAgent\work\b5f46e3c4829a09e\sources\engine\Stride.Engine\Engine\Processors\TransformProcessor.cs:line 145 at Stride.Engine.Processors.TransformProcessor.UpdateTransformationsRecursive(Scene scene) in C:\BuildAgent\work\b5f46e3c4829a09e\sources\engine\Stride.Engine\Engine\Processors\TransformProcessor.cs:line 147 at Stride.Engine.Processors.TransformProcessor.Draw(RenderContext context) in C:\BuildAgent\work\b5f46e3c4829a09e\sources\engine\Stride.Engine\Engine\Processors\TransformProcessor.cs:line 136 at Stride.Engine.EntityManager.Draw(RenderContext context) in C:\BuildAgent\work\b5f46e3c4829a09e\sources\engine\Stride.Engine\Engine\EntityManager.cs:line 204 at Stride.Games.GamePlatform.OnRunCallback() at Stride.Games.GameWindowSDL.<>c__DisplayClass17_0.<Run>b__0() at Stride.Engine.SceneSystem.Draw(GameTime gameTime) in C:\BuildAgent\work\b5f46e3c4829a09e\sources\engine\Stride.Engine\Engine\SceneSystem.cs:line 220 at Stride.Games.SDLMessageLoop.Run(Window form, RenderCallback renderCallback) at Stride.Games.GameSystemCollection.Draw(GameTime gameTime) at Stride.Games.GameWindowSDL.Run() at Stride.Games.GameBase.Draw(GameTime gameTime) at Stride.Games.GamePlatform.Run(GameContext gameContext) at Stride.Games.GameBase.RawTick(TimeSpan elapsedTimePerUpdate, Int32 updateCount, Single drawInterpolationFactor, Boolean drawFrame) at Stride.Games.GameBase.Run(GameContext gameContext) at Stride.Games.GameBase.RawTickProducer() at Stride.Games.GameBase.Tick() at AdAstraImperium.Server.Program.<>c.<InitializeGame>b__23_0() in /src/AdAstraImperium.Server/Program.cs:line 501 at Stride.Games.GamePlatform.Tick() at System.Threading.ExecutionContext.RunFromThreadPoolDispatchLoop(Thread threadPoolThread, ExecutionContext executionContext, ContextCallback callback, Object state) --- End of stack trace from previous location --- at System.Threading.ExecutionContext.RunFromThreadPoolDispatchLoop(Thread threadPoolThread, ExecutionContext executionContext, ContextCallback callback, Object state) at System.Threading.Tasks.Task.ExecuteWithThreadLocal(Task& currentTaskSlot, Thread threadPoolThread) --- End of stack trace from previous location --- at AdAstraImperium.Server.Program.InitializeGame() in /src/AdAstraImperium.Server/Program.cs:line 501 Unhandled exception. System.NullReferenceException: Object reference not set to an instance of an object. at Stride.Engine.Processors.TransformProcessor.UpdateTransformationsRecursive(Scene scene) in C:\BuildAgent\work\b5f46e3c4829a09e\sources\engine\Stride.Engine\Engine\Processors\TransformProcessor.cs:line 145 at Stride.Engine.Processors.TransformProcessor.UpdateTransformationsRecursive(Scene scene) in C:\BuildAgent\work\b5f46e3c4829a09e\sources\engine\Stride.Engine\Engine\Processors\TransformProcessor.cs:line 147 at Stride.Engine.Processors.TransformProcessor.Draw(RenderContext context) in C:\BuildAgent\work\b5f46e3c4829a09e\sources\engine\Stride.Engine\Engine\Processors\TransformProcessor.cs:line 136 at Stride.Engine.EntityManager.Draw(RenderContext context) in C:\BuildAgent\work\b5f46e3c4829a09e\sources\engine\Stride.Engine\Engine\EntityManager.cs:line 204 at Stride.Engine.SceneSystem.Draw(GameTime gameTime) in C:\BuildAgent\work\b5f46e3c4829a09e\sources\engine\Stride.Engine\Engine\SceneSystem.cs:line 220 at Stride.Games.GameSystemCollection.Draw(GameTime gameTime) at Stride.Games.GameBase.Draw(GameTime gameTime) at Stride.Games.GameBase.RawTick(TimeSpan elapsedTimePerUpdate, Int32 updateCount, Single drawInterpolationFactor, Boolean drawFrame) at Stride.Games.GameBase.RawTickProducer() at Stride.Games.GameBase.Tick() at Stride.Games.GamePlatform.Tick() at Stride.Games.GamePlatform.OnRunCallback() at Stride.Games.GameWindowSDL.<>c__DisplayClass17_0.<Run>b__0() at Stride.Games.SDLMessageLoop.Run(Window form, RenderCallback renderCallback) at Stride.Games.GameWindowSDL.Run() at Stride.Games.GamePlatform.Run(GameContext gameContext) at Stride.Games.GameBase.Run(GameContext gameContext) at AdAstraImperium.Server.Program.<>c.<InitializeGame>b__23_0() in /src/AdAstraImperium.Server/Program.cs:line 501 at System.Threading.ExecutionContext.RunFromThreadPoolDispatchLoop(Thread threadPoolThread, ExecutionContext executionContext, ContextCallback callback, Object state) --- End of stack trace from previous location --- at System.Threading.ExecutionContext.RunFromThreadPoolDispatchLoop(Thread threadPoolThread, ExecutionContext executionContext, ContextCallback callback, Object state) at System.Threading.Tasks.Task.ExecuteWithThreadLocal(Task& currentTaskSlot, Thread threadPoolThread) --- End of stack trace from previous location --- at AdAstraImperium.Server.Program.InitializeGame() in /src/AdAstraImperium.Server/Program.cs:line 501 at System.Threading.Tasks.Task.<>c.<ThrowAsync>b__128_1(Object state) at System.Threading.ThreadPoolWorkQueue.Dispatch() at System.Threading.PortableThreadPool.WorkerThread.WorkerThreadStart() Aborted

[roku674]

Thanks for the PR!

Is Stride's implementation of Vulkan stable enough on Linux for it to replace OpenGL as the default API? Pinging @Jklawreszuk because they work on the Linux platform quite a bit.

Closing this becuase you're right OpenGL seems much more stable than Vulkan when i tested two identical contianers of my game one with Vulkan one with Open GL via an env var

[Ethereal77]

Please note there is currently an ongoing PR to remove OpenGL entirely, and set Vulkan as default API for Linux, MacOS, iOS, and Android.

[roku674]

Please note there is currently an ongoing PR to remove OpenGL entirely, and set Vulkan as default API for Linux, MacOS, iOS, and Android.

Im not sure a complete removal would be prudent I'm running the game on a CPU only system and its stable on OpenGL but not Vulkan

[MeharDT]

Please note there is currently an ongoing PR to remove OpenGL entirely, and set Vulkan as default API for Linux, MacOS, iOS, and Android.

Im not sure a complete removal would be prudent I'm running the game on a CPU only system and its stable on OpenGL but not Vulkan

D3D and Vulkan support are being re-written by xen2 so it shouldn't be an issue once the PR is integrated.