Stride Game Engine

Stride Game Engine (formerly Xenko)

Programming language: C#

License: MIT License

Tags: Game    

Latest version: v4.0.0.1

README

[Stride](sources/data/images/Logo/stride-logo-readme.png)

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> <!-- ALL-CONTRIBUTORS-BADGE:END -->

Welcome to the Stride source code repository!

Stride is an open-source C# game engine for realistic rendering and VR. The engine is highly modular and aims at giving game makers more flexibility in their development. Stride comes with an editor that allows you to create and manage the content of your games or applications visually and intuitively.

To learn more about Stride, visit stride3d.net.

License and governance

.NET Foundation

This project is supported by the .NET Foundation.

License

Stride is covered by the [MIT License](LICENSE.md) unless stated otherwise (i.e. for some files that are copied from other projects). You can find the list of third party projects [here](THIRD%20PARTY.md). Contributors need to sign the following [Contribution License Agreement](docs/ContributorLicenseAgreement.md).

Code of conduct

Stride being a .NET Foundation project, it has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.

Earn money by contributing

If you are a developer with solid experience in C#, rendering techniques, or game development, we want to hire you! We have allocated funds from supporters on OpenCollective and can pay for work on certain projects. More info about this here.

Documentation

Find explanations and information about Stride:

• Stride Manual
• Tutorials
• API Reference
• Release Notes

Community

Ask for help or report issues:

• Chat with the community on Discord
• Discuss topics on Github discussions
• Report engine issues
• Donate to support the project
• List of Projects made by users
• [Localization](docs/localization.md)

Building from source

Prerequisites

1. Latest Git with Large File Support selected in the setup on the components dialog.
2. Visual Studio 2022 with the following workloads:
   • .NET desktop development with .NET Framework 4.7.2 targeting pack
   • Desktop development with C++ with
   • Windows 10 SDK (10.0.18362.0) (it's currently enabled by default but it might change)
   • MSVC v143 - VS2022 C++ x64/x86 build tools (v14.30) or later version (should be enabled by default)
   • C++/CLI support for v143 build tools (v14.30) or later version (not enabled by default)
   • Optional (to target UWP): Universal Windows Platform development with
   • Windows 10 SDK (10.0.18362.0) or later version
   • MSVC v143 - VS2022 C++ ARM build tools (v14.30) or later version (not enabled by default)
   • Optional (to target iOS/Android): Mobile development with .NET and Android SDK setup (API level 27) individual component, then in Visual Studio go to Tools > Android > Android SDK Manager and install NDK (version 19+) from Tools tab.
3. FBX SDK 2019.0 VS2015

Build Stride

1. Open a command prompt, point it to a directory and clone Stride to it: git lfs clone https://github.com/stride3d/stride.git
   • Note that when you use GitHub -> Code -> Download ZIP, this doesn't support Large File Support lfs, make sure you use the command above or that your git client does it for you
2. Open <StrideDir>\build\Stride.sln with Visual Studio 2022 and build Stride.GameStudio in the 60-Editor solution folder (it should be the default startup project) or run it from VS's toolbar.
   • Optionally, open and build Stride.Android.sln, Stride.iOS.sln, etc.

Build Stride without Visual Studio

1. Install Visual Studio Build Tools with the same prerequisites listed above
2. Add MSBuild's directory to your system's PATH (ex: C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\MSBuild\Current\Bin)
3. Open a command prompt, point it to a directory and clone Stride to it: git clone https://github.com/stride3d/stride.git
4. Navigate to /Build with the command prompt, input msbuild /t:Restore Stride.sln then compile.bat

If building failed:

• If you skipped one of the Prerequisites thinking that you already have the latest version, update to the latest anyway just to be sure.
• Visual Studio might have issues properly building if an anterior version is present alongside 2022. If you want to keep those version make sure that they are up to date and that you are building Stride through VS 2022.
• Your system's PATH should not contain older versions of MSBuild (ex: ...\Microsoft Visual Studio\2019\BuildTools\MSBuild\Current\Bin should be removed)
• Some changes might require a system reboot, try that if you haven't yet.
• Make sure that Git, Git LFS and Visual Studio can access the internet.
• Close VS, clear the nuget cache (in your cmd dotnet nuget locals all --clear), delete the hidden .vs folder inside \build and the files inside bin\packages, kill any msbuild and other vs processes, build the whole solution then build and run GameStudio.

Do note that test solutions might fail but it should not prevent you from building Stride.GameStudio.

Contribution Guidelines

Please check our [Contributing Guidelines](docs/CONTRIBUTING.md).

Build Status

Branch	master
Windows D3D11
Windows D3D12
Windows Vulkan
Windows OpenGL
Windows OpenGL ES
UWP
iOS
Android
Linux Vulkan
Linux OpenGL
Tests Windows Simple
Tests Windows D3D11

Contributors ✨

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> xen2💻 Eideren💻 Jorn Theunissen📖 Tebjan Halm💻 Elias Holzer💻 Johan Gustafsson💻 Youness KAFIA💻 Marian Dziubiak💻 AmbulantRex💻 Basewq💻 Jarmo💻 Antonio Junaković💻 Nicolas Musset💻 Novaleaf💻 salahchafai🎨 Mehar💻 Vaclav Elias💻 EternalTamago💻 WhyPenguins💻 Aunnop Kattiyanet💻 Anon🎨 D3ZAX💻 Phr00t💻 sebl💻 Artromskiy💻 Jean-François Pustay💻 Daniel Miller💻 joreg💻 James Rinker💻 Tristan McPherson💻 Eric💻 Sebastian Gregor💻 insomnyawolf💻

<!-- markdownlint-restore --> <!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the all-contributors specification. Contributions of any kind welcome!