Stride

https://github.com/stride3d/stride
Admin
Stride is an open-source C# game engine designed for realistic rendering and VR, featuring a modular...
Tokens:48,612
Snippets:122
Trust Score:9.4
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### FFmpeg Build Steps with MSYS2

Source: https://github.com/stride3d/stride/blob/master/deps/FFmpeg/dotnet/notes.txt

Step-by-step instructions for compiling FFmpeg on Windows using MSYS2. This covers environment setup, package installation, and PATH configuration.

```shell
# ref: https://pracucci.com/compile-ffmpeg-on-windows-with-visual-studio-compiler.html

1. checkout ffmpeg
2. download MSYS (http://msys2.github.io)
3. install it C:\workspace\windows\msys64
4. run MSYS command prompt (C:\workspace\windows\msys64\msys2_shell.cmd)
5. install package with "pacman -Su make gcc diffutils autoconf automake gperf yasm python"
6. go to C:\workspace\windows\msys64
7. edit msys2_shell.cmd file
8. uncomment the "set MSYS2_PATH_TYPE=inherit" line so that environment variables are available
9. download yasm http://www.tortall.net/projects/yasm/releases/yasm-1.3.0-win64.exe
10. rename it to yasm.exe and move it to C:\workspace\windows
11. Add C:\workspace\windows to PATH environment variable
```

--------------------------------

### Split Screen Camera Example

Source: https://github.com/stride3d/stride/wiki/Community-Projects

Demonstrates how to implement a split-screen camera setup in Stride.

```C#
https://github.com/profan/XenkoByteSized
```

```C#
https://github.com/spasarto/Stride3dSplitScreen
```

--------------------------------

### Install Stride.StorageTool Globally

Source: https://github.com/stride3d/stride/blob/master/sources/tools/Stride.StorageTool/README.md

Instructions for installing the Stride.StorageTool globally using a PowerShell script. This includes enabling script execution and running the install script.

```ps1
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
```

--------------------------------

### Build and Package Installer with MSBuild

Source: https://github.com/stride3d/stride/blob/master/sources/launcher/README.md

This snippet shows how to build the Stride launcher and package the installer using MSBuild. It assumes you have checked out the sources in the specified directory.

```msbuild
msbuild Stride.build /t:Build;PackageInstaller
```

--------------------------------

### Trigger Scene Example

Source: https://github.com/stride3d/stride/wiki/Community-Projects

An example project demonstrating the implementation and usage of triggers within a Stride scene.

```C#
https://github.com/profan/XenkoByteSized
```

--------------------------------

### Procedural Rendering Examples

Source: https://github.com/stride3d/stride/wiki/Community-Projects

A collection of procedural rendering techniques and implementations for the Stride engine.

```C#
https://github.com/profan/XenkoByteSized
```

--------------------------------

### Launch Game Window from Code

Source: https://github.com/stride3d/stride/wiki/Community-Projects

An example of how to launch a Stride game window programmatically from code.

```C#
https://github.com/microdee/xenko-window-from-code
```

--------------------------------

### HLSL to GLSL Conversion Example

Source: https://github.com/stride3d/stride/blob/master/sources/shaders/Stride.Core.Shaders/README.md

Demonstrates the default behavior of generating combined samplers during HLSL to GLSL conversion, and mentions an alternative mode for separate samplers.

```hlsl
Texture2D texture;
SamplerState sampler;

texture.Sample(texture, sampler);
```

--------------------------------

### Minecraft-like Voxel World Example

Source: https://github.com/stride3d/stride/wiki/Community-Projects

An example project demonstrating a Minecraft-style voxel brick world implementation in Stride.

```C#
https://github.com/jason-wilmans/XenkoVoxelExample
```

--------------------------------

### Asynchronous NetworkScript Example

Source: https://github.com/stride3d/stride/wiki/Community-Projects

An example of an asynchronous NetworkScript for client-server communication in Stride.

```C#
https://github.com/manio143/Stride.Networking.Simple
```

--------------------------------

### Entity Component System Example

Source: https://github.com/stride3d/stride/wiki/Community-Projects

Demonstrates a custom Entity Component and Processor within the Stride engine. This project showcases how to extend the core entity-component system for custom game logic.

```C#
https://github.com/Basewq/XenkoProofOfConcepts/tree/master/EntityProcessorExample
```

--------------------------------

### Vehicle Scene Example

Source: https://github.com/stride3d/stride/wiki/Community-Projects

Demonstrates a vehicle scene, likely focusing on physics and simulation within the Stride engine.

```C#
https://github.com/profan/XenkoByteSized
```

--------------------------------

### Check .NET SDK Version

Source: https://github.com/stride3d/stride/blob/master/README.md

A command to verify the installed .NET SDK versions on your system. This is useful for ensuring you meet the project's .NET 8.0 SDK prerequisite.

```powershell
dotnet --info
```

--------------------------------

### Object Info Render Target Example

Source: https://github.com/stride3d/stride/wiki/Community-Projects

Renders object-specific information onto a render target, useful for debugging or custom rendering passes.

```C#
https://github.com/Basewq/XenkoProofOfConcepts/tree/master/ObjectInfoRenderTargetExample
```

--------------------------------

### Shader Stream Definition (ParticleColorStream.sdsl)

Source: https://github.com/stride3d/stride/blob/master/sources/engine/Stride.Particles/Docs/VertexAttributes.txt

This snippet, referenced in the main text, likely defines how the `streams.Color` gets its value from the COLOR semantic, which is added in Step 2. It's a conceptual example of shader stream binding.

```sdsl
// Conceptual example from ParticleColorStream.sdsl
// streams.Color gets its value from the COLOR semantic.
```

--------------------------------

### FFmpeg Build Configuration

Source: https://github.com/stride3d/stride/blob/master/deps/FFmpeg/dotnet/notes.txt

Lists the configuration options used for building FFmpeg on Windows. This includes toolchain, architecture, enabled features, and disabled components.

```shell
--toolchain=msvc
--arch=x86_64
--enable-version3
--enable-yasm 
--enable-asm
--enable-shared
--enable-w32threads
--enable-avresample
--disable-ffserver 
--disable-programs
--disable-doc
--disable-static
--target-os=win64
```

```shell
--toolchain=msvc
--arch=x86
--enable-version3
--enable-yasm
--enable-asm
--enable-shared
--enable-w32threads
--enable-avresample
--disable-ffserver
--disable-programs
--disable-doc
--disable-static
```

--------------------------------

### Stride Build Task Commands

Source: https://github.com/stride3d/stride/blob/master/sources/core/Readme.md

Provides helper executables for build tasks. Includes commands for locating Visual Studio development environments and packaging assets.

```bash
Stride.Core.Tasks.dll command [options]*

=== Commands ===

 locate-devenv <MSBuildPath>: returns devenv path
 pack-assets <csprojFile> <intermediatePackagePath>: copy and adjust assets for nupkg packaging
```

--------------------------------

### Initialize and Configure CppNet Preprocessor

Source: https://github.com/stride3d/stride/blob/master/deps/CppNet/README.md

This C# code demonstrates how to initialize the CppNet preprocessor, add Clang-specific features and warnings, set up include and framework paths, define macros, and add input sources for preprocessing.

```C#
var pp = new Preprocessor();
pp.addFeature(Feature.DIGRAPHS);
pp.addFeature(Feature.TRIGRAPHS);
pp.addFeature(Feature.OBJCSYNTAX);
pp.addWarning(Warning.IMPORT);
pp.addFeature(Feature.INCLUDENEXT);
pp.setListener(new PreprocessorListener());

pp.getSystemIncludePath().Add(@"C:\XcodeDefault.xctoolchain\usr\include");
pp.getSystemIncludePath().Add(@"C:\XcodeDefault.xctoolchain\usr\lib\clang\6.0\include");
pp.getFrameworksPath().Add(@"C:\iPhoneOS8.0.sdk\System\Library\Frameworks");
pp.getSystemIncludePath().Add(@"C:\iPhoneOS8.0.sdk\usr\include");

pp.addMacro("__AARCH64_SIMD__");
pp.addMacro("__ARM64_ARCH_8__");
pp.addMacro("__ARM_NEON__");
pp.addMacro("__LITTLE_ENDIAN__");
pp.addMacro("__REGISTER_PREFIX__", "");
pp.addMacro("__arm64", "1");
pp.addMacro("__arm64__", "1");
pp.addMacro("__APPLE_CC__", "6000");
pp.addMacro("__APPLE__");
pp.addMacro("__GNUC__", "4");
pp.addMacro("OBJC_NEW_PROPERTIES");
pp.addMacro("__STDC_HOSTED__", "1");
pp.addMacro("__MACH__");
Version version = new Version("8.0.0.0");
pp.addMacro("__ENVIRONMENT_IPHONE_OS_VERSION_MIN_REQUIRED__", string.Format("{0:0}{1:00}{2:00}", version.Major, version.Minor, version.Revision));
pp.addMacro("__STATIC__");

pp.addInput(new FileLexerSource("test.m"));
```

--------------------------------

### CMake Configuration for DxtWrapper

Source: https://github.com/stride3d/stride/blob/master/sources/tools/Stride.TextureConverter.Wrappers/DxtWrapper/CMakeLists.txt

This snippet outlines the CMake configuration for the DxtWrapper project. It sets the project name, minimum CMake version, finds source files, specifies the library output directory, finds the DirectXTex package, and defines the library with its dependencies.

```cmake
project(DxtWrapper)
cmake_minimum_required(VERSION 3.10)
file(GLOB SRCS *.cpp *.h)

set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ../../../../../deps/TextureWrappers/Release/linux-x64)

find_package(directxtex CONFIG REQUIRED)

add_library(${PROJECT_NAME} SHARED ${SRCS} )
set_target_properties(${PROJECT_NAME} PROPERTIES PREFIX "")

target_link_libraries(${PROJECT_NAME} PRIVATE Microsoft::DirectXTex)
```

--------------------------------

### Subdivided Plane Mesh Example

Source: https://github.com/stride3d/stride/wiki/Community-Projects

Showcases the creation and use of a subdivided plane mesh, potentially for terrain or detailed surfaces in Stride.

```C#
https://github.com/profan/XenkoByteSized
```

--------------------------------

### Offering Warranties and Indemnities

Source: https://github.com/stride3d/stride/blob/master/deps/FreeImage/license.txt

Explains the conditions under which a contributor can offer additional services like warranty, support, indemnity, or liability obligations. It clarifies that these must be offered solely on the contributor's own behalf, not on behalf of the Initial Developer or any other Contributor, and requires the contributor to indemnify the Initial Developer and other Contributors for any liability incurred due to these offered terms.

```APIDOC
Warranty, Support, Indemnity, and Liability:
  - Contributors may offer warranty, support, indemnity, or liability obligations to recipients.
  - Such offers must be made solely on the contributor's own behalf, not on behalf of the Initial Developer or any Contributor.
  - It must be explicitly clear that the offer originates solely from the contributor.
  - Contributors agree to indemnify the Initial Developer and every Contributor for any liability incurred as a result of the terms offered by the contributor.
```

--------------------------------

### Stride Game Package Structure

Source: https://github.com/stride3d/stride/blob/master/samples/readme.md

Illustrates the typical directory structure for a self-contained Stride Game Package, including assets, resources, executables, and package descriptions.

```stride
Audio
  SimpleAudio
    .sdtpl : Directory containing icons/screenshots
    Assets : contains assets (.sd files)
    Resources : contains resource files (.jpg, .fbx ... files)
    SimpleAudio.Android : Android executable
    SimpleAudio.Game : Common Game code
    SimpleAudio.iOS : iOS executable
    SimpleAudio.Windows : Windows Desktop executable
    SimpleAudio.sdpkg : Package description
    SimpleAudio.sdtpl : Package Template description
```

--------------------------------

### Building Stride from Source

Source: https://github.com/stride3d/stride/blob/master/README.md

Indicates the section dedicated to instructions for building the Stride game engine from its source code.

```markdown
## 🛠️ Building from Source


```

--------------------------------

### Myra UI in Stride Tutorial

Source: https://github.com/stride3d/stride/wiki/Community-Projects

A tutorial on how to integrate and use the Myra UI library within the Stride game engine.

```C#
https://github.com/rds1983/Myra/wiki/Using-Myra-in-Stride-Engine-Tutorial
```

--------------------------------

### Defining a new VertexElement

Source: https://github.com/stride3d/stride/blob/master/sources/engine/Stride.Particles/Docs/VertexAttributes.txt

Shows how to define a new `VertexElement` for particle attributes, using a generic `Color<Color>()` example. This step is crucial for associating data with a semantic in the vertex buffer.

```cs
public static VertexElement Color = VertexElement.Color<Color>();
```

--------------------------------

### Dock Panel Suite License

Source: https://github.com/stride3d/stride/blob/master/deps/glslang/LICENSE.txt

Dock Panel Suite is distributed under the MIT license. Copyright 2007 Weifen Luo.

```MIT License
Dock Panel Suite distributed under the MIT license. Copyright 2007 Weifen Luo.
```

--------------------------------

### Gettext.NET Licensing Information

Source: https://github.com/stride3d/stride/blob/master/deps/Gettext.Net/COPYING.txt

This section details the licensing of the Gettext.NET package. It clarifies which components are distributed under the LGPL and which are under the GPL, referencing the respective license files.

```APIDOC
Project: Gettext.NET

Licensing:
  - LGPL: libintl, libasprintf, GNU.Gettext.dll, GNU.Gettext.Msgfmt.exe, GNU.Getopt.dll and satellite assemblies.
  - GPL: gettext, ngettext, envsubst programs, and documentation.

References:
  - LGPL License: COPYING.LIB-2.txt
  - GPL License: COPYING.GPL-3.txt
```

--------------------------------

### Build Stride with MSBuild

Source: https://github.com/stride3d/stride/blob/master/README.md

Commands to restore NuGet packages and compile the Stride solution using MSBuild from the command line. This is an alternative to building within Visual Studio.

```bash
msbuild /t:Restore Stride.sln
compile.bat
```

--------------------------------

### Stride.Core.IO File Abstractions

Source: https://github.com/stride3d/stride/blob/master/sources/core/Readme.md

Stride.Core.IO provides file-related abstractions and handles platform-specific nuances. It includes DirectoryWatcher, temporary file/directory helpers, and a virtual file system with providers for the OS file system, Android assets, and zip archives. It also features VirtualFileStream for multithreaded stream operations.

```C#
/*
 * Stride.Core.IO
 * File related abstractions and platform specific nuances.
 *
 * Features:
 * - DirectoryWatcher: Wrapper over System.IO.FileSystem.Watcher.
 * - Temporary directory/file helper.
 * - Virtual file system:
 *   - FileSystemProvider, DriveFileProvider (OS file system)
 *   - AndroidAssetProvider, ZipFileSystemProvider (Android, Zip archives)
 *   - Virtual directories (App data, temp, etc.)
 * - VirtualFileStream: Multithreaded wrapper over a Stream.
 */
```

--------------------------------

### Activate Stride Assembly Processor

Source: https://github.com/stride3d/stride/blob/master/sources/README.md

This XML configuration snippet enables the Stride Assembly Processor globally for a solution. It should be placed in a `.targets` file within the solution folder. This activates features like auto-generated serialization and module initializers.

```xml
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <PropertyGroup>
    <!-- Enable assembly processor -->
    <StrideAssemblyProcessorGlobal>true</StrideAssemblyProcessorGlobal>
  </PropertyGroup>
</Project>
```

--------------------------------

### Stride Documentation Landscape Overview

Source: https://github.com/stride3d/stride/blob/master/README.md

Provides a structured overview of the Stride documentation and related resources, including links to the main repository, website, official docs, and community toolkit.

```markdown
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).
```

--------------------------------

### GNU Lesser General Public License (LGPL) Terms

Source: https://github.com/stride3d/stride/blob/master/deps/Gettext.Net/COPYING.LIB-2.txt

This section details the core terms and conditions for using, copying, distributing, and modifying software licensed under the LGPL. It covers the definition of a 'library', 'work based on the Library', and 'source code', along with specific requirements for distributing modified versions.

```APIDOC
GNU LESSER GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION

0. Applicability:
   - Applies to any software library or program with an LGPL notice.
   - Licensee is addressed as "you".
   - "Library" defined as a collection of software functions/data for linking with applications.
   - "Library" below refers to any distributed under these terms.
   - "Work based on the Library" includes the Library or derivative works (verbatim or modified, including translation).
   - "Source code" is the preferred form for modifications; for libraries, it includes all modules, interface definitions, and build scripts.
   - Activities other than copying, distribution, and modification are outside the scope.
   - Running a program using the Library is not restricted; output is covered only if it constitutes a work based on the Library.

1. Verbatim Copying and Distribution:
   - You may copy and distribute verbatim copies of the Library's complete source code.
   - Conditions:
     - Conspicuously publish an appropriate copyright notice and disclaimer of warranty on each copy.
     - Keep intact all notices referring to this License and absence of warranty.
     - Distribute a copy of this License along with the Library.
   - You may charge a fee for the physical act of transferring a copy.
   - You may offer warranty protection in exchange for a fee.

2. Modification and Distribution of Modified Works:
   - You may modify your copy or copies of the Library or any portion thereof.
   - Forming a "work based on the Library" and distributing such modifications is allowed.
   - Conditions for modified works:
     a) The modified work must itself be a software library.
     b) Modified files must carry prominent notices of changes and dates.
     c) The entire work must be licensed at no charge to all third parties under this License.
     d) If a facility in the modified Library requires input from an application (other than arguments), ensure it operates meaningfully even if the application doesn't supply it (e.g., optional dependencies).
```

--------------------------------

### Stride Game Engine Overview

Source: https://github.com/stride3d/stride/blob/master/README.md

Provides an introduction to the Stride Game Engine, its features, and target audience. It highlights the engine's C# foundation, focus on realistic rendering and VR, modularity, and the accompanying Game Studio editor. It also directs users to resources for game development versus engine development.

```markdown
# 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.
```

--------------------------------

### Headless Server (Physics Only)

Source: https://github.com/stride3d/stride/wiki/Community-Projects

A client-server sample project for Stride, featuring a headless server that handles physics but omits the game tick loop.

```C#
https://github.com/Ethereal77/Stride.ClientServerSample
```

--------------------------------

### ILM's half implementation License

Source: https://github.com/stride3d/stride/blob/master/deps/glslang/LICENSE.txt

ILM's half implementation is distributed under the BSD license. Copyright 2002 Industrial Light & Magic, a division of Lucas Digital Ltd. LLC

```BSD License
ILM's half implementation distributed under BSD license. Copyright 2002 Industrial Light
& Magic, a division of Lucas Digital Ltd. LLC
```

--------------------------------

### PowerVR SDK Licence Agreement Details

Source: https://github.com/stride3d/stride/blob/master/deps/PVRTT/license.txt

This entry summarizes the key terms and conditions of the PowerVR SDK End User Licence Agreement. It covers the licence grant for development and distribution, restrictions on usage, ownership clauses, warranty disclaimers, limitations of liability, handling of third-party materials, agreement term, and governing law. It also includes specific attribution requirements for distributing the SDK as part of a product.

```APIDOC
PowerVR SDK End User Licence Agreement:

Licence Grant:
  - Development License: Non-exclusive, non-assignable licence to use the SDK for developing, profiling, or optimizing applications.
  - Production License: Licence to distribute the SDK as a component of your application, provided:
    i. Not distributed on a stand-alone basis.
    ii. Distribution under terms no less restrictive than this Agreement.
    iii. Compliance with attribution requirements (Appendix 1).
    iv. User is responsible for updates, support, and liability.
    v. No claims of certification or endorsement by Imagination.
  - Custom License: Use as expressly authorized in writing by Imagination, subject to specific payment/support terms (Appendix 2).

Restrictions:
  - No unauthorised use.
  - No modification, disassembly, decompilation, reverse engineering, revision, enhancement, or creation of derivative works.
  - No removal of proprietary or copyright notices.
  - No incorporation with open source software that subjects the SDK to open source licence obligations.

Ownership:
  - Imagination retains all ownership, copyrights, and intellectual property rights in the SDK.

Warranty Disclaimer:
  - SDK provided "AS IS".
  - Imagination disclaims all express or implied warranties (merchantability, fitness for a particular purpose, title, non-infringement).

Limitation of Liability:
  - Imagination not liable for damages, claims, or costs arising from the Agreement or SDK use, including consequential, indirect, incidental damages, lost profits, or lost savings.
  - Limitations apply to the extent permitted by applicable law.

Third Party Materials:
  - Third-party materials are the property of their respective owners.
  - Imagination makes no representations or warranties about third-party materials and disclaims liability.

Term:
  - Agreement effective until terminated.
  - Termination by Imagination: Immediate if user fails to comply with any term.
  - Termination by User: By destroying or returning all SDK copies.

Governing Law:
  - Governed by and construed in accordance with English law.
  - Parties submit to the exclusive jurisdiction of the courts of England.

Appendix 1: Attribution Requirements:
  - Source Code Release: Keep Copyright notice visible.
  - Object Code Bundling: Keep original branding. Display acknowledgement in associated documentation: "This product includes components of the PowerVR? SDK from Imagination Technologies Limited".
```

--------------------------------

### Stride Parser Construction Algorithm Details

Source: https://github.com/stride3d/stride/blob/master/sources/shaders/Irony/Parsing/Data/Construction/_about_parser_construction.txt

Details the specific implementation of DeRemer-Penello's algorithm in Stride, including on-demand computation of lookbacks and transitions, immediate propagation of Include relations, and the use of state.ShiftTerminals for DirectReads.

```APIDOC
DeRemer-Penello Algorithm Differences in Stride:

1. On-Demand Computation:
   - Computes lookbacks and transitions only when needed for reduce items in inadequate states.
   - Starts with reduce items in inadequate states and finds necessary lookbacks/transitions.
   - Propagates Include relations immediately to avoid a separate transitive closure step.

2. Immediate Include Propagation:
   - Propagates Include relations as soon as they are added.
   - Avoids redundant propagation by checking if a transition is already in the Includes set.
   - Aims for efficiency comparable to SCC-based transitive closure.

3. Reads and DirectRead Relations:
   - Replaces 'Reads' relation between transitions with 'Reads' relation between states (ParserStateData.ReadStateSet).
   - 'Reads' relation is computed on-demand and propagated transitively.
   - 'DirectReads' for a transition uses the target state's ShiftTerminals set.
```

--------------------------------

### Stride Project License Terms

Source: https://github.com/stride3d/stride/blob/master/deps/Gettext.Net/COPYING.LIB-2.txt

This section details the legal terms and conditions governing the distribution and use of the Stride project's software library. It covers aspects like compatibility with other licenses, geographical restrictions, and the process for updating the license.

```APIDOC
License Conditions:
  - Compatibility: Conditions imposed must not contradict the License; if they do, distribution is prohibited.
  - Patent/Copyright Restrictions: Original copyright holder may add explicit geographical distribution limitations.
  - License Versions: Free Software Foundation may publish revised versions; users can choose between specified or any later version.
  - Incorporation into Other Programs: Permission required from the author for incorporating parts into programs with incompatible distribution conditions.

Warranty Disclaimer:
  - "AS IS" Basis: The library is provided without warranty, either expressed or implied, including merchantability and fitness for a particular purpose.
  - Risk Assumption: The entire risk as to the quality and performance of the library is with the user.
  - Liability Limitation: Copyright holders are not liable for damages, including special, incidental, or consequential damages, arising from the use or inability to use the library.

Applying Terms to New Libraries:
  - Recommendation: To maximize public use, make new libraries free software under these terms or the ordinary General Public License.
  - Permission for Exceptions: For software copyrighted by the Free Software Foundation, contact them for potential exceptions.
```

--------------------------------

### Fugue Icons Licensing

Source: https://github.com/stride3d/stride/blob/master/THIRD PARTY.md

Details the licensing terms for the Fugue Icons set, including attribution requirements and options for royalty-free licenses. It also lists specific icon projects and their associated licenses.

```APIDOC
Fugue Icons:
  License: Creative Commons Attribution 3.0 License (http://creativecommons.org/licenses/by/3.0/)
  Royalty-Free License Option: http://p.yusukekamiyamane.com/
  Contact: p@yusukekamiyamane.com

Sub-Icons:
  geotag:
    License: Creative Commons Attribution-Share Alike 3.0 License or LGPL (http://creativecommons.org/licenses/by-sa/3.0/, http://opensource.org/licenses/lgpl-license.php)
  language:
    License: Creative Commons Attribution-Share Alike 3.0 License (http://creativecommons.org/licenses/by-sa/3.0/)
  open-share:
    License: Creative Commons Attribution-Share Alike 3.0 License (http://creativecommons.org/licenses/by-sa/3.0/)
  opml:
    License: Creative Commons Attribution-Share Alike 2.5 License (http://creativecommons.org/licenses/by-sa/2.5/)
  share:
    License: GPL or LGPL or BSD or Creative Commons Attribution 2.5 License (http://opensource.org/licenses/gpl-license.php, http://opensource.org/licenses/lgpl-license.php, http://opensource.org/licenses/bsd-license.php, http://creativecommons.org/licenses/by/2.5/)
  xfn:
    License: Creative Commons Attribution-Share Alike 2.5 License (http://creativecommons.org/licenses/by-sa/2.5/)
```

--------------------------------

### Required Notices and Distribution

Source: https://github.com/stride3d/stride/blob/master/deps/FreeImage/license.txt

Details the requirements for including notices within source code files and documentation, specifically the notice in Exhibit A and the license itself. It also covers the conditions under which Executable versions can be distributed, including the requirement to state the availability of the Source Code version and how obligations have been met.

```APIDOC
Notices and Distribution:
  - Required Notices:
    - Duplicate the notice in Exhibit A in each Source Code file.
    - Include the License in any documentation for the Source Code describing recipient rights.
    - Contributors may add their name to the Exhibit A notice for their Modifications.
    - If a notice cannot be placed in a file due to structure, include it in a likely location (e.g., a directory file).
  - Distribution of Executable Versions:
    - Executable form distribution is allowed only if Sections 3.1-3.5 requirements are met.
    - Include a notice stating the Source Code version is available under the license terms.
    - The notice must describe how and where Section 3.2 obligations were fulfilled.
    - The notice must be conspicuously included in the Executable version, related documentation, or collateral.
    - Executable versions may be distributed under a different license of the distributor's choice, potentially with different terms.
```

--------------------------------

### Code-Only Project Sample

Source: https://github.com/stride3d/stride/wiki/Community-Projects

A sample project demonstrating how to develop entirely in code without using the Stride Game Studio editor.

```C#
https://github.com/xen2/Xenko.CodeOnlySample
```

--------------------------------

### Bullet Physics C++ Library

Source: https://github.com/stride3d/stride/blob/master/deps/BulletPhysics/README.md

Contains the core Bullet C++ physics library files. Specific compiled versions are required for each platform and architecture.

```cpp
// libbulletc.* files are the compiled C++ Bullet library.
// One compiled version is needed for each platform and architecture.
```

--------------------------------

### Stride Project License Terms

Source: https://github.com/stride3d/stride/blob/master/deps/FreeImage/license.txt

This section outlines the core licensing terms for the Stride project, including how modifications are governed, the conditions for distributing source code, and restrictions on altering the license terms. It also details the requirement to include a copy of the license with distributed source code.

```APIDOC
License Terms:
  - Modifications are governed by the license terms, including Section 2.2.
  - Source Code distribution requires adherence to the license or a future version under Section 6.1.
  - A copy of the License must accompany every Source Code distribution.
  - No additional terms can be imposed that alter or restrict the applicable license or recipient rights.
  - Additional rights described in Section 3.5 may be offered via an additional document.
```

--------------------------------

### Stride.Core Key Features

Source: https://github.com/stride3d/stride/blob/master/sources/core/Readme.md

Stride.Core is a fundamental assembly referenced by all other Stride projects. It provides base abstractions for engine systems, including serialization attributes, data annotations, property collections, a service registry, threading utilities, hashing mechanisms, app settings, assembly and object factory registries, reference counting, native code compilation, collection helpers, logging, and profiling.

```C#
/*
 * Stride.Core
 * Base abstractions for the Stride engine.
 *
 * Key Features:
 * - Serialization attributes ([DataContract])
 * - Data annotation attributes
 * - Strongly typed property collections (PropertyKey, PropertyContainer)
 * - Lightweight service registry (IServiceRegistry)
 * - ThreadThrottler
 * - Custom ThreadPool and Dispatcher
 * - Custom hashing mechanism (ObjectId)
 * - AppSettings abstraction
 * - AssemblyRegistry
 * - ObjectFactoryRegistry
 * - Reference counting system (IReferencable, ReferenceBase, DisposeBase)
 * - Native code compilation system (NativeLibraryHelper)
 * - Collection helpers
 * - Custom logging system
 * - Profiler
 */
```

--------------------------------

### MIT License

Source: https://github.com/stride3d/stride/blob/master/deps/glslang/LICENSE.txt

The MIT License is a permissive free software license originating at the Massachusetts Institute of Technology in the late 1980s. It is a short and simple license with no conditions, making it very popular.

```MIT License
The MIT License (MIT)
Copyright (c) 2015-2016 Baldur Karlsson
Copyright (c) 2014 Crytek
Permission is hereby granted, free of charge, to any person obtaining a copy of this
software and associated documentation files (the "Software"), to deal in the Software
without restriction, including without limitation the rights to use, copy, modify, merge,
publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
```

--------------------------------

### Screen Space Decal Root Renderer

Source: https://github.com/stride3d/stride/wiki/Community-Projects

An implementation of a screen-space projected decal system utilizing Stride's RootRenderFeature.

```C#
https://github.com/Basewq/XenkoProofOfConcepts/tree/master/ScreenSpaceDecalRootRendererExample
```

--------------------------------

### Clean UI without Post FX

Source: https://github.com/stride3d/stride/wiki/Community-Projects

A project demonstrating how to achieve a clean UI appearance in Stride without relying on post-processing effects.

```C#
https://github.com/herocrab/StrideCleanUI
```

--------------------------------

### mhook License

Source: https://github.com/stride3d/stride/blob/master/deps/glslang/LICENSE.txt

mhook is distributed under the MIT license. Copyright Marton Anka 2007-2012, portions Copyright 2007 Matt Conover.

```MIT License
mhook distributed under the MIT license. Copyright Marton Anka 2007-2012,
portions Copyright 2007 Matt Conover.
```

--------------------------------

### Description of Modifications

Source: https://github.com/stride3d/stride/blob/master/deps/FreeImage/license.txt

Specifies the requirements for documenting changes made to Covered Code. Contributors must include a file detailing the changes and dates, and prominently state that the Modification is derived from Original Code provided by the Initial Developer, including the Initial Developer's name in the Source Code and related documentation.

```APIDOC
Modification Documentation:
  - All Covered Code contributions must include a file documenting changes made and the date of any change.
  - A prominent statement must indicate that the Modification is derived from Original Code provided by the Initial Developer.
  - The Initial Developer's name must be included in the Source Code and in any notice describing the origin or ownership of the Covered Code.
```

--------------------------------

### Android NDK Standalone Toolchain Modification

Source: https://github.com/stride3d/stride/blob/master/deps/FFmpeg/dotnet/notes.txt

A modification required for the Android NDK standalone toolchain script to support MSYS environments, enabling proper host tag detection.

```python
import platform

# ... inside get_host_tag_or_die method ...
		elif (platform.system() == 'MSYS_NT-10.0' or
          platform.system() == 'MINGW64_NT-10.0'):
        host_tag = 'windows-x86_64'
```

--------------------------------

### Qt License

Source: https://github.com/stride3d/stride/blob/master/deps/glslang/LICENSE.txt

Qt is distributed under the GNU Lesser General Public License (LGPL) version 2.1. Copyright 2015 The Qt Company Ltd.

```GNU Lesser General Public License (LGPL) version 2.1
Qt distributed under the GNU Lesser General Public License (LGPL) version 2.1. Copyright
2015 The Qt Company Ltd.
```

--------------------------------

### Screen Space Decal System

Source: https://github.com/stride3d/stride/wiki/Community-Projects

A system for projecting decals onto surfaces using screen-space techniques.

```C#
https://github.com/Basewq/XenkoProofOfConcepts/tree/master/ScreenSpaceDecalExample
```

--------------------------------

### Source Code Availability Requirements

Source: https://github.com/stride3d/stride/blob/master/deps/FreeImage/license.txt

Details the requirements for making modifications available in Source Code form. It specifies that Source Code must be available on the same media as an Executable version or via an Electronic Distribution Mechanism, and must remain available for a specified period. Responsibility for ensuring availability, even through third-party mechanisms, is also covered.

```APIDOC
Source Code Availability:
  - Modifications must be made available in Source Code form under the license terms.
  - Availability must be on the same media as an Executable version or via an accepted Electronic Distribution Mechanism.
  - Source Code must remain available for at least twelve (12) months after initial availability, or six (6) months after a subsequent version is made available.
  - Responsibility lies with the contributor to ensure Source Code availability, even if maintained by a third party.
```

--------------------------------

### Contributing to Stride

Source: https://github.com/stride3d/stride/blob/master/README.md

Details on how to contribute to the Stride game engine, including channels for discussion (Discord, GitHub Discussions), bug reporting and feature proposals (GitHub Issues), and guidance for code contributions, particularly for issues tagged 'good first issue'. It also mentions opportunities for earning money by contributing and the localization process.

```markdown
## 🤝 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).
```

--------------------------------

### Computing ExpectedTerminals Set for Parser States

Source: https://github.com/stride3d/stride/blob/master/sources/shaders/Irony/Parsing/Data/Construction/_about_parser_construction.txt

Explains how the ExpectedTerminals set is computed for different types of parser states, including handling of single-reduce states and the scanner-parser link.

```APIDOC
ExpectedTerminals Set Computation:

- Property of ParserState, used by Scanner for token recognition.

State Types and ExpectedSet Computation:

1. Shift Items Only:
   - ExpectedSet = Union of 'current' terms of all shift items.
   - Stored in State.BuilderData.ShiftTerms.

2. Shift AND Reduce Items (Inadequate State):
   - ExpectedSet = Union of 'current' terms of shift items + lookaheads of reduce items.
   - Reduce items have computed lookaheads.

3. 2+ Reduce Items (Inadequate State):
   - ExpectedSet = Union of lookaheads of all reduce items.

4. Single Reduce Item (Troubled Case):
   - State is not inadequate; no lookaheads computed for the single reduce item.
   - ExpectedSet is not computed for such states.
   - Scanner-parser link is deactivated by not reading the next token (DefaultReduceAction is not null).
   - CoreParser.ExecuteAction handles this by not reading a new token.
```

--------------------------------

### IronPython License

Source: https://github.com/stride3d/stride/blob/master/deps/glslang/LICENSE.txt

IronPython is distributed under the Apache 2.0 License. Copyright IronPython Team.

```Apache 2.0 License
IronPython distributed under the Apache 2.0 License. Copyright IronPython Team.
```

--------------------------------

### Stride Roadmap

Source: https://github.com/stride3d/stride/blob/master/README.md

Provides information on the Stride engine's development roadmap, linking to a detailed document that outlines upcoming changes and planned features.

```markdown
## 🗺️ Roadmap

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

--------------------------------

### Stride Toolkit Extensions

Source: https://github.com/stride3d/stride/wiki/Community-Projects

A NuGet package providing various useful extensions and utilities for the Stride game engine, aimed at simplifying development tasks.

```C#
https://github.com/dfkeenan/StrideToolkit
```

--------------------------------

### Source Code Pro License

Source: https://github.com/stride3d/stride/blob/master/deps/glslang/LICENSE.txt

Source Code Pro is distributed under the SIL Open Font License 1.1. Copyright 2010, 2012 Adobe Systems Incorporated.

```SIL Open Font License 1.1
distributed under the SIL Open Font License 1.1. Copyright 2010, 2012 Adobe Systems
Incorporated.
```

--------------------------------

### miniz License

Source: https://github.com/stride3d/stride/blob/master/deps/glslang/LICENSE.txt

miniz is released to the Public Domain by Rich Geldreich.

```Public Domain
miniz released to the Public Domain by Rich Geldreich.
```

--------------------------------

### Custom SPIRV-Cross Integration

Source: https://github.com/stride3d/stride/blob/master/deps/MoltenVK/version.txt

Details the integration of a custom version of SPIRV-Cross, referencing a specific commit hash and a GitHub pull request for further information.

```plaintext
Custom SPIRV-Cross: 522c4eea978ef9a820f16146b7c8bcfd5ecbf86d + https://github.com/KhronosGroup/SPIRV-Cross/pull/831
```

--------------------------------

### Intellectual Property Matters

Source: https://github.com/stride3d/stride/blob/master/deps/FreeImage/license.txt

Covers intellectual property considerations, including how to handle third-party claims regarding intellectual property rights in functionality or code. It mandates the inclusion of a 'LEGAL' file detailing such claims and the responsible party. It also addresses patent information for API modifications.

```APIDOC
Intellectual Property:
  - Third Party Claims:
    - If aware of intellectual property claims, include a 'LEGAL' text file with the source code distribution.
    - The 'LEGAL' file must describe the claim and claimant in sufficient detail for contact.
    - If knowledge is obtained after making a Modification available, promptly update the 'LEGAL' file and notify recipients.
  - Contributor APIs:
    - If a Modification is an API and patents are necessary for its implementation, this information must be included in the 'LEGAL' file.
```

--------------------------------

### Stride Camera Controller

Source: https://github.com/stride3d/stride/wiki/Community-Projects

A camera controller system for Stride, featuring swapping cameras and a Resident Evil-style control scheme.

```C#
https://github.com/herocrab/StrideCameraController
```

--------------------------------

### Shader Explorer for Stride

Source: https://github.com/stride3d/stride/wiki/Community-Projects

A tool to explore Stride's source shader implementations, allowing developers to understand and modify rendering effects.

```GLSL
https://github.com/tebjan/Stride.ShaderExplorer/releases
```

--------------------------------

### Clone Stride Repository

Source: https://github.com/stride3d/stride/blob/master/README.md

Clones the Stride game engine repository using Git, ensuring Large File Support (LFS) is utilized. This is the initial step for obtaining the project's source code.

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

--------------------------------

### ModernUIIcons.com Licensing and Attribution

Source: https://github.com/stride3d/stride/blob/master/THIRD PARTY.md

Details the licensing for ModernUIIcons.com, emphasizing the 'No Attribution and No Derived Works' license. It outlines requirements for open-source projects and commercial use, including specific attribution needs for certain icons.

```APIDOC
ModernUIIcons.com:
  License: Creative Commons Attribution-NoDerivs 3.0 License (http://creativecommons.org/licenses/by-nd/3.0/)
  Download Source: https://github.com/Templarian/WindowsIcons
  Creator: Austin Andrews (@templarian)
  Contributor:
    - Jay Zawrotny (@JayZawrotny)
    - Oren Nachman
  Derived Works:
    - Alex Peattie (Social: http://www.alexpeattie.com/projects/justvector_icons/)
  Attribution Required:
    - Kris Vandermotten (@kvandermotten): appbar.medical.pulse
    - Constantin Kichinsky (@kichinsky): appbar.currency.rubles, appbar.currency.grivna
    - Massimo Savazzi (@msavazzi): List of missing exported icons
    - Proletkult Graphik, The Noun Project: appbar.draw.pen (inspired)
    - Olivier Guin, The Noun Project: appbar.draw.marker
    - Gibran Bisio, The Noun Project: appbar.draw.bucket
    - Andrew Forrester, The Noun Project: appbar.fingerprint
  Contact:
    - http://templarian.com/
    - admin[@]templarian[.]com
  Note: Copyrighted logos (Skype, Facebook, Twitter, etc.) do not apply to the 'No Attribution' clause.
```

--------------------------------

### BulletSharp C# Wrapper

Source: https://github.com/stride3d/stride/blob/master/deps/BulletPhysics/README.md

The BulletSharp.NetStandard.dll is a C# wrapper for the Bullet C++ library. A specific DLL is provided for iOS due to platform-specific requirements.

```csharp
// BulletSharp.NetStandard.dll is the C# wrapper for the Bullet C++ library.
// A specific DLL is required for iOS due to platform-specific reasons.
```

--------------------------------

### ImGui Debug Integration

Source: https://github.com/stride3d/stride/wiki/Community-Projects

Integration of the ImGui library for debugging purposes within the Stride game engine.

```C#
https://github.com/Eideren/XenkoCommunity.ImGuiDebug
```

--------------------------------

### Platform-Specific Test Inclusion

Source: https://github.com/stride3d/stride/blob/master/sources/engine/Stride.Graphics.Tests/README.md

Demonstrates how to include platform-specific test files in the Stride.Graphics.Tests project. Files marked with the 'Stride.DoNotSync' label are intended for specific platforms and should not be synchronized across all builds.

```csharp
<Compile Label="Stride.DoNotSync" Include="MyPlatformSpecificType.cs" />
```
Tokens:
Raw