Skip to content

Latest commit

 

History

History
110 lines (79 loc) · 8.22 KB

README.md

File metadata and controls

110 lines (79 loc) · 8.22 KB
Raw

Stride

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.

Stride Editor

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 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.

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.

Documentation

Find explanations and information about Stride:

Community

Ask for help or report issues:

Building from source

Prerequisites

  1. Latest Git with Large File Support selected in the setup on the components dialog.
  2. Visual Studio 2019 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 v142 - VS2019 C++ x64/x86 build tools (v14.26) or later version (should be enabled by default)
    • C++/CLI support for v142 build tools (v14.26) or later version (not enabled by default)
  • .NET Core cross-platform development
  • Optional (to target UWP): Universal Windows Platform development with
    • Windows 10 SDK (10.0.18362.0) or later version
    • MSVC v142 - VS2019 C++ ARM build tools (v14.26) 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.
  1. FBX SDK 2019.0 VS2015

Build Stride

  1. Open a command prompt, point it to a directory and clone Stride to it: git clone https://github.com/stride3d/stride.git
  2. Open <StrideDir>\build\Stride.sln with Visual Studio 2019 and build Stride.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.

Build Stride without Visual Studio

  1. Install VS build tools with the same prerequisites listed above
  2. Add MSBuild's directory to your system's PATH
  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 dotnet restore Stride.sln then compile

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.
  • Make sure that git 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.

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