stride/README.md

![Xenko](https://xenko.com/images/external/xenko-logo-side.png)
=======

Welcome to the Xenko source code repository!

Xenko 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.
Xenko comes with an editor that allows you create and manage the content of your games or applications in a visual and intuitive way.

![Xenko Editor](https://xenko.com/images/external/script-editor.png)

To learn more about Xenko, visit [xenko.com](https://xenko.com/).

## License

Xenko is covered by [MIT](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](docs/ContributorLicenseAgreement.md).

## Documentation

Find explanations and information about Xenko:
* [Xenko Manual](https://doc.xenko.com/latest/manual/index.html)
* [API Reference](https://doc.xenko.com/latest/api/index.html)
* [Release Notes](https://doc.xenko.com/latest/ReleaseNotes/index.html)

## Community

Ask for help or report issues:
* [Chat with the community on Discord](https://discord.gg/f6aerfE) [![Join the chat at https://discord.gg/f6aerfE](https://img.shields.io/discord/500285081265635328.svg?style=flat&logo=discord&label=discord)](https://discord.gg/f6aerfE)
* [Discuss topics on our forums](http://forums.xenko.com/)
* [Report engine issues](https://github.com/xenko3d/xenko/issues)
* [Donate to support the project](https://www.patreon.com/xenko)

## Building from source

### Prerequisites

1. [Git](https://git-scm.com/downloads) (recent version that includes LFS, or install [Git LFS](https://git-lfs.github.com/) separately).
2. [Visual Studio 2019](https://www.visualstudio.com/downloads/) 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.17763.0)` or later, and `VC++ 2017 version 15.9 v14.16 latest v141 tools` or later (both should be enabled by default)
  * `.NET Core cross-platform development`
  * Optional (to target UWP): `Universal Windows Platform development` with `Windows 10 SDK (10.0.17763.0)`
  * Optional (to target iOS/Android): `Mobile development with .NET` and `Android NDK R13B+` individual component
3. [FBX SDK 2019.0 VS2015](https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2019-0)

### Build Xenko

1. Clone Xenko: `git clone https://github.com/xenko3d/xenko.git`
2. Open `<XenkoDir>\build\Xenko.sln` with Visual Studio 2017, and build.
3. Open `<XenkoDir>\samples\XenkoSamples.sln` and play with the samples.
4. Optionally, open and build `Xenko.Android.sln`, `Xenko.iOS.sln`, etc...

### Contribution Guidelines

Please check our [Contributing Guidelines](docs/CONTRIBUTING.md).

### Build Status

|Branch| **master** |
|:--:|:--:|
|Windows D3D11|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_BuildWindowsD3d11&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_BuildWindowsD3d11),branch:master/statusIcon"/></a>
|Windows D3D12|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_BuildWindowsD3d12&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_BuildWindowsD3d12),branch:master/statusIcon"/></a>
|Windows Vulkan|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_BuildWindowsVulkan&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_BuildWindowsVulkan),branch:master/statusIcon"/></a>
|Windows OpenGL|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_BuildWindowsOpenGL&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_BuildWindowsOpenGL),branch:master/statusIcon"/></a>
|Windows OpenGL ES|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_BuildWindowsOpenGLES&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_BuildWindowsOpenGLES),branch:master/statusIcon"/></a>
|UWP|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_BuildWindowsUWP&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_BuildWindowsUWP),branch:master/statusIcon"/></a>
|iOS|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_BuildiOS&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_BuildiOS),branch:master/statusIcon"/></a>
|Android|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_BuildAndroid&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_BuildAndroid),branch:master/statusIcon"/></a>
|Linux Vulkan|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_BuildLinuxVulkan&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_BuildLinuxVulkan),branch:master/statusIcon"/></a>
|Linux OpenGL|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_BuildLinuxOpenGL&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_BuildLinuxOpenGL),branch:master/statusIcon"/></a>
|Tests Windows Simple| <a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_Tests_WindowsSimple&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_Tests_WindowsSimple),branch:master/statusIcon"/></a>
|Tests Windows D3D11|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_Tests_WindowsD3D11&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_Tests_WindowsD3D11),branch:master/statusIcon"/></a>
Initial commit 2018-06-19 12:06:54 +03:00			`![Xenko](https://xenko.com/images/external/xenko-logo-side.png)`
			`=======`

			`Welcome to the Xenko source code repository!`

			`Xenko 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.`
			`Xenko comes with an editor that allows you create and manage the content of your games or applications in a visual and intuitive way.`

			`![Xenko Editor](https://xenko.com/images/external/script-editor.png)`

			`To learn more about Xenko, visit [xenko.com](https://xenko.com/).`

			`## License`

			`Xenko is covered by [MIT](LICENSE.md), unless stated otherwise (i.e. for some files that are copied from other projects).`

Update URL description 2018-08-02 15:26:29 +03:00			`You can find the list of third party projects [here](THIRD%20PARTY.md).`
Initial commit 2018-06-19 12:06:54 +03:00
[GitHub] Added issue template. 2018-08-30 07:57:39 +03:00			`Contributors need to sign the following [Contribution License Agreement](docs/ContributorLicenseAgreement.md).`
Initial commit 2018-06-19 12:06:54 +03:00
			`## Documentation`

			`Find explanations and information about Xenko:`
			`* [Xenko Manual](https://doc.xenko.com/latest/manual/index.html)`
Update README.md: Open doc on index rather than `Xenko.Core.Assets` namespace Felt a bit weird to open the API on the `Xenko.Core.Assets` namespace, since it's not even part of the runtime. 2018-08-12 06:25:16 +03:00			`* [API Reference](https://doc.xenko.com/latest/api/index.html)`
Initial commit 2018-06-19 12:06:54 +03:00			`* [Release Notes](https://doc.xenko.com/latest/ReleaseNotes/index.html)`

			`## Community`

			`Ask for help or report issues:`
Change link+badge for chat from gitter to discord 2019-01-06 18:16:35 +03:00			`* [Chat with the community on Discord](https://discord.gg/f6aerfE) [![Join the chat at https://discord.gg/f6aerfE](https://img.shields.io/discord/500285081265635328.svg?style=flat&logo=discord&label=discord)](https://discord.gg/f6aerfE)`
Initial commit 2018-06-19 12:06:54 +03:00			`* [Discuss topics on our forums](http://forums.xenko.com/)`
			`* [Report engine issues](https://github.com/xenko3d/xenko/issues)`
[Build] Improve README.md 2018-08-06 09:26:05 +03:00			`* [Donate to support the project](https://www.patreon.com/xenko)`
Initial commit 2018-06-19 12:06:54 +03:00
			`## Building from source`

			`### Prerequisites`

			`1. [Git](https://git-scm.com/downloads) (recent version that includes LFS, or install [Git LFS](https://git-lfs.github.com/) separately).`
[Build] Update build instructions 2019-05-04 12:00:50 +03:00			`2. [Visual Studio 2019](https://www.visualstudio.com/downloads/) with the following workloads:`
[Build] Update requirements 2019-01-21 05:37:03 +03:00			* `.NET desktop development` with `.NET Framework 4.7.2 targeting pack`
[Build] Update build instructions 2019-05-04 12:00:50 +03:00			* `Desktop development with C++` with `Windows 10 SDK (10.0.17763.0)` or later, and `VC++ 2017 version 15.9 v14.16 latest v141 tools` or later (both should be enabled by default)
[Build] Update README.md to add Android NDK prereq for mobile 2018-09-21 05:13:43 +03:00			* `.NET Core cross-platform development`
[Build] Update build instructions 2019-05-04 12:00:50 +03:00			* Optional (to target UWP): `Universal Windows Platform development` with `Windows 10 SDK (10.0.17763.0)`
[Build] Update README.md to add Android NDK prereq for mobile 2018-09-21 05:13:43 +03:00			* Optional (to target iOS/Android): `Mobile development with .NET` and `Android NDK R13B+` individual component
Initial commit 2018-06-19 12:06:54 +03:00			`3. [FBX SDK 2019.0 VS2015](https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2019-0)`

[Build] Improve README.md 2018-08-06 09:26:05 +03:00			`### Build Xenko`

			1. Clone Xenko: `git clone https://github.com/xenko3d/xenko.git`
[Build] Removed XenkoDir environment variable 2018-11-09 06:57:05 +03:00			2. Open `<XenkoDir>\build\Xenko.sln` with Visual Studio 2017, and build.
			3. Open `<XenkoDir>\samples\XenkoSamples.sln` and play with the samples.
			4. Optionally, open and build `Xenko.Android.sln`, `Xenko.iOS.sln`, etc...
[Build] Improve README.md 2018-08-06 09:26:05 +03:00
Added contribution guidelines 2018-09-06 04:05:15 +03:00			`### Contribution Guidelines`

			`Please check our [Contributing Guidelines](docs/CONTRIBUTING.md).`

[Build] Added Teamcity badge to README.md 2018-08-06 05:31:43 +03:00			`### Build Status`

[Build] Swap rows and columns for TeamCity badges 2018-08-06 07:50:50 +03:00			`\|Branch\| master \|`
			`\|:--:\|:--:\|`
			`\|Windows D3D11\|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_BuildWindowsD3d11&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_BuildWindowsD3d11),branch:master/statusIcon"/></a>`
			`\|Windows D3D12\|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_BuildWindowsD3d12&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_BuildWindowsD3d12),branch:master/statusIcon"/></a>`
			`\|Windows Vulkan\|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_BuildWindowsVulkan&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_BuildWindowsVulkan),branch:master/statusIcon"/></a>`
			`\|Windows OpenGL\|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_BuildWindowsOpenGL&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_BuildWindowsOpenGL),branch:master/statusIcon"/></a>`
			`\|Windows OpenGL ES\|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_BuildWindowsOpenGLES&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_BuildWindowsOpenGLES),branch:master/statusIcon"/></a>`
			`\|UWP\|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_BuildWindowsUWP&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_BuildWindowsUWP),branch:master/statusIcon"/></a>`
			`\|iOS\|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_BuildiOS&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_BuildiOS),branch:master/statusIcon"/></a>`
Fix broken link to Teamcity Android build in ReadMe 2019-04-17 21:41:32 +03:00			`\|Android\|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_BuildAndroid&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_BuildAndroid),branch:master/statusIcon"/></a>`
[Build] Swap rows and columns for TeamCity badges 2018-08-06 07:50:50 +03:00			`\|Linux Vulkan\|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_BuildLinuxVulkan&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_BuildLinuxVulkan),branch:master/statusIcon"/></a>`
			`\|Linux OpenGL\|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_BuildLinuxOpenGL&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_BuildLinuxOpenGL),branch:master/statusIcon"/></a>`
			`\|Tests Windows Simple\| <a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_Tests_WindowsSimple&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_Tests_WindowsSimple),branch:master/statusIcon"/></a>`
			`\|Tests Windows D3D11\|<a href="https://teamcity.xenko.com/viewType.html?buildTypeId=Engine_Tests_WindowsD3D11&branch=master&guest=1"><img src="https://teamcity.xenko.com/app/rest/builds/buildType:(id:Engine_Tests_WindowsD3D11),branch:master/statusIcon"/></a>`