67aff8ec55 | ||
---|---|---|
.github | ||
bin/packages | ||
build | ||
deps | ||
docs | ||
samples | ||
sources | ||
tests | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
BACKERS.md | ||
LICENSE.md | ||
README.md | ||
THIRD PARTY.md | ||
crowdin.yml | ||
store.config |
README.md
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
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.
Documentation
Find explanations and information about Stride:
Community
Ask for help or report issues:
- Chat with the community on Discord
- Discuss topics on our forums
- Report engine issues
- Donate to support the project
- List of Projects made by users
- Localization
Building from source
Prerequisites
- Latest Git with Large File Support selected in the setup on the components dialog.
- Visual Studio 2019 with the following workloads:
.NET desktop development
with.NET Framework 4.7.2 targeting pack
Desktop development with C++
withWindows 10 SDK (10.0.17763.0)
or later version (should be enabled by default)MSVC v142 - VS2019 C++ x64/x86 build tools (v14.23)
or later version (should be enabled by default)MSVC v142 - VS2019 C++ x64/x86 Spectre-mitigated libs (v14.23)
or later version (should be enabled by default)
.NET Core cross-platform development
- Optional (to target UWP):
Universal Windows Platform development
withWindows 10 SDK (10.0.17763.0)
or later versionMSVC v142 - VS2019 C++ ARM build tools (v14.23)
or later version (should be enabled by default)MSVC v142 - VS2019 C++ ARM Spectre-mitigated libs (v14.23)
or later version (should be enabled by default)
- Optional (to target iOS/Android):
Mobile development with .NET
andAndroid SDK setup (API level 27)
individual component, then in Visual Studio go toTools > Android > Android SDK Manager
and installNDK
(version 19+) fromTools
tab.
Build Stride
- Open a command prompt, point it to a directory and clone Stride to it:
git clone https://github.com/stride3d/stride.git
- Open
<StrideDir>\build\Stride.sln
with Visual Studio 2019 and buildStride.GameStudio
(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.
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 outdated version of 2017 is present alongside 2019. If you want to keep VS 2017 make sure that it is up to date and that you are building Stride through VS 2019.
- Some changes might require a system reboot, try that if you haven't yet.
Do note that test solutions might fail but it should not prevent you from building Stride.GameStudio
.
Contribution Guidelines
Please check our Contributing Guidelines.
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 |