README.md
Stride is an open-source C# game engine designed for realistic rendering and VR. Highly modular, it aims to give game makers more flexibility in their development. Stride comes with an editor, Game Studio, which allows you to create and manage the content of your games or applications visually and intuitively. To learn more about Stride, visit stride3d.net.
This README is intended for users who want to build the Stride engine from source or contribute to its development. If your goal is to create games using Stride, we recommend visiting the Get started with Stride guide. There, you'll find detailed instructions on downloading, installing, and getting started with game development in Stride.
Want to get involved? See our Contributing section for how to ask questions, report bugs, submit pull requests (including good first issues), and how you can earn money by contributing via funded tasks/bug bounties.
Our Roadmap communicates upcoming changes to the Stride engine.
dotnet --info in a console or PowerShell window to see which versions you have installed.Tools > Android > Android SDK Manager and install NDK (version 20.1+) from the Tools tab.[!NOTE] The installation of Visual Studio with the required components may require up to 19 GB of disk space, depending on your system and selected components.
[!WARNING] If this is your first time installing the .NET SDK, you might need to restart your system after the installation so that the system can recognize the new environment variables.
git lfs clone https://github.com/stride3d/stride.git
<StrideDir>\build\Stride.sln with Visual Studio 2026.Stride.GameStudio project in the 60-Editor solution folder (it should be the default startup project) or run it directly from Visual Studio's toolbar.Stride.Android.sln, Stride.iOS.sln, etc.[!WARNING] Do NOT use GitHub -> Code -> Download ZIP option, as this won't include the LFS files.
PATH environment variable (e.g., c:\Program Files (x86)\Microsoft Visual Studio\18\BuildTools\MSBuild\Current\Bin).git lfs clone https://github.com/stride3d/stride.git
/build directory in the command prompt and run:msbuild /t:Restore Stride.sln
compile.bat
PATH should not contain older versions of MSBuild (e.g., ...\Microsoft Visual Studio\2019\BuildTools\MSBuild\Current\Bin should be removed).Could not find a compatible version of MSBuild.Path to dotnet executable is not set.dotnet nuget locals all --clear), delete the hidden .vs folder inside \build and the files inside bin\packages, kill any msbuild and other Visual Studio processes, then build the whole solution and run GameStudio.[!WARNING] Test solutions might fail, but this should not prevent you from building
Stride.GameStudio.
Please check our Contributing Guidelines.
| Branch | master |
|---|---|
| Windows D3D11 | <a href="https://teamcity.stride3d.net/viewType.html?buildTypeId=Engine_BuildWindowsD3d11&branch=master&guest=1"></a> |
| Windows D3D12 | <a href="https://teamcity.stride3d.net/viewType.html?buildTypeId=Engine_BuildWindowsD3d12&branch=master&guest=1"></a> |
| Windows Vulkan | <a href="https://teamcity.stride3d.net/viewType.html?buildTypeId=Engine_BuildWindowsVulkan&branch=master&guest=1"></a> |
| Windows OpenGL | <a href="https://teamcity.stride3d.net/viewType.html?buildTypeId=Engine_BuildWindowsOpenGL&branch=master&guest=1"></a> |
| Windows OpenGL ES | <a href="https://teamcity.stride3d.net/viewType.html?buildTypeId=Engine_BuildWindowsOpenGLES&branch=master&guest=1"></a> |
| iOS | <a href="https://teamcity.stride3d.net/viewType.html?buildTypeId=Engine_BuildiOS&branch=master&guest=1"></a> |
| Android | <a href="https://teamcity.stride3d.net/viewType.html?buildTypeId=Engine_BuildAndroid&branch=master&guest=1"></a> |
| Linux Vulkan | <a href="https://teamcity.stride3d.net/viewType.html?buildTypeId=Engine_BuildLinuxVulkan&branch=master&guest=1"></a> |
| Linux OpenGL | <a href="https://teamcity.stride3d.net/viewType.html?buildTypeId=Engine_BuildLinuxOpenGL&branch=master&guest=1"></a> |
| Tests Windows Simple | <a href="https://teamcity.stride3d.net/viewType.html?buildTypeId=Engine_Tests_WindowsSimple&branch=master&guest=1"></a> |
| Tests Windows D3D11 | <a href="https://teamcity.stride3d.net/viewType.html?buildTypeId=Engine_Tests_WindowsD3D11&branch=master&guest=1"></a> |
The Stride documentation is organized across different locations. Here's how it's structured:
This project is supported by the .NET Foundation.
Stride is covered by the MIT License unless stated otherwise (i.e. for some files that are copied from other projects). You can find the list of third-party projects here. Contributors need to sign the following Contribution License Agreement.
Thanks to all these wonderful people who have contributed to Stride!
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="https://stride3d.net"> <sub><b>xen2</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=xen2" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Eideren"> <sub><b>Eideren</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=Eideren" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://www.aggror.com"> <sub><b>Jorn Theunissen</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=Aggror" title="Documentation">π</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/tebjan"> <sub><b>Tebjan Halm</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=tebjan" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/azeno"> <sub><b>Elias Holzer</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=azeno" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="http://www.tinyrocket.se"> <sub><b>Johan Gustafsson</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=johang88" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/ykafia"> <sub><b>Youness KAFIA</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=ykafia" title="Code">π»</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="http://md-techblog.net.pl"> <sub><b>Marian Dziubiak</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=manio143" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/AmbulantRex"> <sub><b>AmbulantRex</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=AmbulantRex" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Basewq"> <sub><b>Basewq</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=Basewq" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/herocrab"> <sub><b>Jarmo</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=herocrab" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://junakovic.com"> <sub><b>Antonio JunakoviΔ</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=cstdbool" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Kryptos-FR"> <sub><b>Nicolas Musset</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=Kryptos-FR" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/jasonswearingen"> <sub><b>Novaleaf</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=jasonswearingen" title="Code">π»</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/salahchafai"> <sub><b>salahchafai</b></sub></a> <a href="#design-salahchafai" title="Design">π¨</a></td> <td align="center" valign="top" width="14.28%"><a href="https://digitaltheory.biz/"> <sub><b>Mehar</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=MeharDT" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="http://www.VaclavElias.com"> <sub><b>Vaclav Elias</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=VaclavElias" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/EternalTamago"> <sub><b>EternalTamago</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=EternalTamago" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/WhyPenguins"> <sub><b>WhyPenguins</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=WhyPenguins" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/aunpyz"> <sub><b>Aunnop Kattiyanet</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=aunpyz" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/makotech222"> <sub><b>Anon</b></sub></a> <a href="#design-makotech222" title="Design">π¨</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/D3ZAX"> <sub><b>D3ZAX</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=D3ZAX" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/phr00t"> <sub><b>Phr00t</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=phr00t" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="http://schnellebuntebilder.de/"> <sub><b>sebl</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=sebllll" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Artromskiy"> <sub><b>Artromskiy</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=Artromskiy" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/TheKeyblader"> <sub><b>Jean-FranΓ§ois Pustay</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=TheKeyblader" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Earthmark"> <sub><b>Daniel Miller</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=Earthmark" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="http://joreg.ath.cx"> <sub><b>joreg</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=joreg" title="Code">π»</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/jrinker03"> <sub><b>James Rinker</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=jrinker03" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/tristanmcpherson"> <sub><b>Tristan McPherson</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=tristanmcpherson" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/ericwj"> <sub><b>Eric</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=ericwj" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/gregsn"> <sub><b>Sebastian Gregor</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=gregsn" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="http://insomnyawolf.github.io"> <sub><b>insomnyawolf</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=insomnyawolf" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Doprez"> <sub><b>Doprez</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=Doprez" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Jklawreszuk"> <sub><b>Jakub Εawreszuk</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=Jklawreszuk" title="Code">π»</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Ethereal77"> <sub><b>Mario Guerra</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=Ethereal77" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/tamamutu"> <sub><b>tamamutu</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=tamamutu" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/IXLLEGACYIXL"> <sub><b>IXLLEGACYIXL</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=IXLLEGACYIXL" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/arturoc"> <sub><b>arturo</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=arturoc" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/garychia"> <sub><b>Chia-Hsiang Cheng</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=garychia" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://nicusorn5.github.io/"> <sub><b>Nicolae Tugui</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=NicusorN5" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://mattiascibien.net"> <sub><b>Mattias Cibien</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=mattiascibien" title="Code">π»</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="http://cnonim.name"> <sub><b>Oleg Ageev</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=cNoNim" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/SeleDreams"> <sub><b>SeleDreams</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=SeleDreams" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/acastrodev"> <sub><b>Alexandre Castro</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=acastrodev" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/SVNMLR"> <sub><b>SVNMLR</b></sub></a> <a href="#design-SVNMLR" title="Design">π¨</a></td> <td align="center" valign="top" width="14.28%"><a href="https://chroniclesofelyria.com"> <sub><b>Jeromy Walsh</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=JeromyWalsh" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://pa.rh.am/"> <sub><b>Parham Gholami</b></sub></a> <a href="#design-parhamgholami" title="Design">π¨</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/adrsch"> <sub><b>adrsch</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=adrsch" title="Code">π»</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/dotlogix"> <sub><b>Alexander Schill</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=dotlogix" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/froce"> <sub><b>froce</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=froce" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://fydar.dev"> <sub><b>Fydar</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=fydar" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/MaximilianEmel"> <sub><b>MaximilianEmel</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=MaximilianEmel" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Schossi"> <sub><b>Schossi</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=Schossi" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/ch3mbot"> <sub><b>Dagan Hartmann</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=ch3mbot" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Nicogo1705"> <sub><b>nicogo.eth</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=Nicogo1705" title="Code">π»</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/ourabigdev"> <sub><b>hatim ourahou</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=ourabigdev" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/kopffarben"> <sub><b>kopffarben</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=kopffarben" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Feralnex"> <sub><b>Tomasz Czech</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=Feralnex" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/TranquilAbyss"> <sub><b>Tranquil Abyss</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=TranquilAbyss" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/levifmorais"> <sub><b>Levi Ferreira</b></sub></a> <a href="#design-levifmorais" title="Design">π¨</a></td> <td align="center" valign="top" width="14.28%"><a href="http://tylerkvochick.com"> <sub><b>Tyler Kvochick</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=tymokvo" title="Documentation">π</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/Arc-huangjingtong"> <sub><b>Arc</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=Arc-huangjingtong" title="Code">π»</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/minktusk"> <sub><b>minktusk</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=minktusk" title="Code">π»</a> <a href="#content-minktusk" title="Content">π</a></td> <td align="center" valign="top" width="14.28%"><a href="https://www.timcassell.net/"> <sub><b>Tim Cassell</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=timcassell" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="http://www.linkedin.com/in/dylan-loe"> <sub><b>Dylan Loe</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=dloe" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/wrshield"> <sub><b>Will S</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=wrshield" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/soorMSWE"> <sub><b>Ryan Soo</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=soorMSWE" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/MechWarrior99"> <sub><b>MechWarrior99</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=MechWarrior99" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/kristian15959"> <sub><b>Proxid</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=kristian15959" title="Code">π»</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="http://yerkoandrei.github.io"> <sub><b>Yerko Andrei</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=YerkoAndrei" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/ComputerSmoke"> <sub><b>Addison Schmidt</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=ComputerSmoke" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/timconner"> <sub><b>Tim Conner</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=timconner" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://www.caleblamcodes.dev/"> <sub><b>Caleb L.</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=ClamEater14" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/net2cn"> <sub><b>net2cn</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=net2cn" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/laske185"> <sub><b>Peter Laske</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=laske185" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/MikhailArsentevTheSecond"> <sub><b>Mikhail Arsentev</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=MikhailArsentevTheSecond" title="Code">π»</a></td> </tr> <tr> <td align="center" valign="top" width="14.28%"><a href="https://github.com/hoelzl"> <sub><b>Matthias HΓΆlzl</b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=hoelzl" title="Code">π»</a></td> <td align="center" valign="top" width="14.28%"><a href="https://github.com/kutal10"> <sub><b>Rahul Pai </b></sub></a> <a href="https://github.com/stride3d/stride/commits?author=kutal10" title="Code">π»</a></td> </tr> </tbody> </table> <!-- markdownlint-restore --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->This project follows the all-contributors specification. Contributions of any kind welcome!