Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stride3d/stride

Stride (formerly Xenko), a free and open-source cross-platform C# game engine.
https://github.com/stride3d/stride

csharp direct3d game-development game-engine gamedev multi-platform stride vulkan xenko

Last synced: 2 days ago
JSON representation

Stride (formerly Xenko), a free and open-source cross-platform C# game engine.

Host: GitHub
URL: https://github.com/stride3d/stride
Owner: stride3d
License: mit
Created: 2018-06-08T05:25:16.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-12-07T10:38:19.000Z (5 days ago)
Last Synced: 2024-12-07T20:21:06.055Z (5 days ago)
Topics: csharp, direct3d, game-development, game-engine, gamedev, multi-platform, stride, vulkan, xenko
Language: C#
Homepage: https://stride3d.net
Size: 34.8 MB
Stars: 6,672
Watchers: 189
Forks: 958
Open Issues: 617
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-game-engine-dev - Stride - Game engine for realistic rendering and VR. Formerly _Xenko_. [[Website](https://www.stride3d.net/)] (Libraries / C#)
fucking-Awesome-Linux-Software - ![Open-Source Software - Stride is an open-source C# game engine for realistic rendering and VR. (Applications / Development)
awesome-list - Stride - An open-source C# game engine for realistic rendering and VR. (Game Engines / Data Management)
Awesome-Linux-Software - ![Open-Source Software - Stride is an open-source C# game engine for realistic rendering and VR. (Applications / Development)

README

        


    

      

      

      

    



[![Join the chat at https://discord.gg/f6aerfE](https://img.shields.io/discord/500285081265635328.svg?style=flat&logo=discord&label=discord&logoColor=f2f2f2)](https://discord.gg/f6aerfE)

[![All Contributors](https://img.shields.io/github/all-contributors/stride3d/stride?color=ee8449)](#contributors)

[![Financial sponsors](https://img.shields.io/opencollective/all/stride3d?logo=opencollective)](https://opencollective.com/stride3d)

[![License](https://img.shields.io/badge/license-MIT-blue)](https://github.com/stride3d/stride/blob/master/LICENSE.md)

[![Contributor Covenant](https://img.shields.io/badge/contributor%20covenant-2.0-4baaaa.svg)](CODE_OF_CONDUCT.md)

# Welcome to the Stride Game Engine

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](https://doc.stride3d.net/latest/en/manual/game-studio/index.html), 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](https://stride3d.net/).

![Stride Editor](https://stride3d.net/images/external/script-editor.png)

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](https://doc.stride3d.net/latest/en/manual/get-started/index.html) guide. There, you'll find detailed instructions on downloading, installing, and getting started with game development in Stride.

## 🤝 Contributing

For questions and general discussions, please join our [Discord server](https://discord.gg/f6aerfE) or participate in [GitHub Discussions](https://github.com/stride3d/stride/discussions).

To report bugs or propose features, please use the [Issues](https://github.com/stride3d/stride/issues) section on GitHub.

We welcome code contributions via pull requests. Issues tagged with **[`good first issue`](https://github.com/stride3d/stride/labels/good%20first%20issue)** are great starting points for code contributions.

You can help us translate Stride; check out our [Localization Guide](https://doc.stride3d.net/latest/en/contributors/engine/localization.html).

### 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 [Open Collective](https://opencollective.com/stride3d) and can pay for work on certain projects. [More information is available here](https://doc.stride3d.net/latest/en/contributors/engine/bug-bounties.html).

## 🗺️ Roadmap

Our [Roadmap](https://doc.stride3d.net/latest/en/contributors/roadmap.html) communicates upcoming changes to the Stride engine.

## 🛠️ Building from Source

### Prerequisites

1. **Latest [Git](https://git-scm.com/downloads)** with **Large File Support** selected during setup. For convenience, you might also use a Git UI client like [GitExtensions](https://gitextensions.github.io/).

2. **[.NET 8.0 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)**

   - Run `dotnet --info` in a console or PowerShell window to see which versions you have installed.

3. **[Visual Studio 2022](https://visualstudio.microsoft.com/downloads/)** (the Community edition is free) with the following workloads:

   - **.NET desktop development** with **.NET Framework 4.7.2 targeting pack** (should be enabled by default)

   - **Desktop development with C++** with:

     - **Windows 11 SDK (10.0.22621.0)** or a later version (should be enabled by default)

     - **MSVC v143 - VS2022 C++ x64/x86 build tools (Latest)** (should be enabled by default)

     - **C++/CLI support for v143 build tools (Latest)** *(not enabled by default)*

   - *Optional* (to target iOS/Android): **.NET Multi-platform App UI development** and the **Android SDK setup** individual component (enabled by default). Then, in Visual Studio, go to `Tools > Android > Android SDK Manager` and install **NDK** (version 20.1+) from the `Tools` tab.

   - *Optional* (to build the VSIX package): **Visual Studio extension development**

> [!NOTE]

> The installation of Visual Studio with the required components may require up to **14 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.

### Build Stride

1. **Clone the repository** using a Git UI client or from the command line:

   ```bash

   git lfs clone https://github.com/stride3d/stride.git

   ```

2. **Open the solution:**

   - Open `\build\Stride.sln` with Visual Studio 2022. 

   - Build the `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.

   - _Optionally_, open and build `Stride.Android.sln`, `Stride.iOS.sln`, etc.

> [!WARNING]

> **Do NOT use GitHub -> Code -> Download ZIP** option, as this won't include the LFS files.

### Build Stride without Visual Studio

1. **Install** [Visual Studio Build Tools](https://aka.ms/vs/17/release/vs_BuildTools.exe) with the same prerequisites listed above.

2. **Add MSBuild to your system's PATH:**

   - Add MSBuild's directory to your `PATH` environment variable (e.g., `C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\MSBuild\Current\Bin`).

3. **Clone the repository:**

   ```bash

   git lfs clone https://github.com/stride3d/stride.git

   ```

4. **Build using the command line:**

   - Navigate to the `/build` directory in the command prompt and run:

   ```bash

   msbuild /t:Restore Stride.sln

   ```

   - Then run:

   ```bash

   compile.bat

   ```

### If Building Fails

* Some errors for test projects are normal, GameStudio will start anyway.

* The Visual Studio extension might fail to build if you are missing the [Visual Studio SDK](https://learn.microsoft.com/en-us/visualstudio/extensibility/installing-the-visual-studio-sdk?view=vs-2022), but Game Studio will start anyway.

* If you skipped any of the **Prerequisites** thinking you already have the latest version, please update to the latest to be sure.

* Visual Studio might have issues building properly if an older version is present alongside 2022. If you want to keep those versions, ensure they are up to date and that you are building Stride using Visual Studio 2022.

* Your system's `PATH` should not contain older versions of MSBuild (e.g., `...\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, for example, if you see these errors:

  * `Could not find a compatible version of MSBuild.`

  * `Path to dotnet executable is not set.`

* Ensure that Git, Git LFS, and Visual Studio can access the internet.

* Close Visual Studio, clear the NuGet cache (`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`.

### Contribution Guidelines

Please check our [Contributing Guidelines](https://doc.stride3d.net/latest/en/contributors/index.html).

## 🔬 Build Status

|Branch| **master** |

|:--:|:--:|

|Windows D3D11|

|Windows D3D12|

|Windows Vulkan|

|Windows OpenGL|

|Windows OpenGL ES|

|iOS|

|Android|

|Linux Vulkan|

|Linux OpenGL|

|Tests Windows Simple| 

|Tests Windows D3D11| 

## 📖 Stride Documentation Landscape

The Stride documentation is organized across different locations. Here's how it's structured:

1. [Stride Game Engine](https://github.com/stride3d/stride) - The main repository for Stride.

   - [Contributing to Stride](https://doc.stride3d.net/latest/en/contributors/engine/index.html) - A guide for developers interested in contributing to or developing the Stride engine.

1. [Stride Website](https://www.stride3d.net/) - The official site showcasing Stride, featuring:

   - [Features](https://www.stride3d.net/features/) 

   - [Blog](https://www.stride3d.net/blog/)

   - [Community](https://www.stride3d.net/community/)

   - [Download](https://www.stride3d.net/download/)

   - [Sponsor](https://www.stride3d.net/sponsor/)

   - [Contributing to the Website](https://doc.stride3d.net/latest/en/contributors/website/index.html) - Guide for contributing to the Stride website.

2. [Stride Docs](https://doc.stride3d.net/) - The official documentation, including:

   - [Manual](https://doc.stride3d.net/latest/en/manual/index.html)

   - [Tutorials](https://doc.stride3d.net/latest/en/tutorials/index.html)

   - [Release Notes](https://doc.stride3d.net/latest/en/ReleaseNotes/ReleaseNotes.html)

   - [Ways to contribute](https://doc.stride3d.net/latest/en/contributors/index.html)

   - [API Reference](https://doc.stride3d.net/latest/en/api/index.html)

   - [Community Resources](https://doc.stride3d.net/latest/en/community-resources/index.html) - Demos, articles, shaders, physics examples, and more.

   - [Contributing to the Docs](https://doc.stride3d.net/latest/en/contributors/documentation/index.html) - Guide for contributing to the Stride documentation.

4. [Stride Community Toolkit](https://stride3d.github.io/stride-community-toolkit/index.html) - A set of C# helpers and extensions to enhance your experience with the Stride game engine.

   - [Contributing to Toolkit](https://github.com/stride3d/stride-community-toolkit) - Contribute to or explore the toolkit's source code.

## 🌐 .NET Foundation

This project is supported by the [.NET Foundation](http://www.dotnetfoundation.org).

## 🛡️ 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](https://github.com/dotnet-foundation/.github/blob/main/CLA/dotnetfoundation.yml).

## ✨ Contributors 

Thanks to all these wonderful people who have contributed to Stride!

  

    

      
_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
💻

      
_Doprez
💻

      
_{Jakub Ławreszuk}
💻

    

    

      
_{Mario Guerra}
💻

      
_tamamutu
💻

      
_IXLLEGACYIXL
💻

      
_arturo
💻

      
_{Chia-Hsiang Cheng}
💻

      
_{Nicolae Tugui}
💻

      
_{Mattias Cibien}
💻

    

    

      
_{Oleg Ageev}
💻

      
_SeleDreams
💻

      
_{Alexandre Castro}
💻

      
_SVNMLR
🎨

      
_{Jeromy Walsh}
💻

      
_{Parham Gholami}
🎨

      
_adrsch
💻

    

    

      
_{Alexander Schill}
💻

      
_froce
💻

      
_{Anthony Marmont}
💻

      
_{MaximilianEmel}
💻

      
_Schossi
💻

      
_{Dagan Hartmann}
💻

    

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!