From a81881fd1d3a4a248b94e59b51f8411bf89f96c4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jakub=20=C5=81awreszuk?=
<31008367+Jklawreszuk@users.noreply.github.com>
Date: Sun, 22 Sep 2024 10:01:54 +0200
Subject: [PATCH 01/15] Update core-team.md
I think it would be worth mentioning that there are Linux platform maintainers :v:
---
en/contributors/core-team.md | 2 ++
1 file changed, 2 insertions(+)
diff --git a/en/contributors/core-team.md b/en/contributors/core-team.md
index b3b4ca22..ce3305e3 100644
--- a/en/contributors/core-team.md
+++ b/en/contributors/core-team.md
@@ -141,6 +141,8 @@ The core team is composed of members who make frequent contributions to the proj
Poland |
+ - C#>
+
- Linux related stuff
- Asset compiler
- Metrics
From a3fef06ca53aba858e0a164d6faa92953c49fdd5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jakub=20=C5=81awreszuk?=
<31008367+Jklawreszuk@users.noreply.github.com>
Date: Sun, 22 Sep 2024 10:28:46 +0000
Subject: [PATCH 02/15] Update core-team.md
---
en/contributors/core-team.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/en/contributors/core-team.md b/en/contributors/core-team.md
index ce3305e3..8a9fff05 100644
--- a/en/contributors/core-team.md
+++ b/en/contributors/core-team.md
@@ -141,7 +141,7 @@ The core team is composed of members who make frequent contributions to the proj
| Poland |
- - C#>
+
- C#>
- Linux related stuff
- Asset compiler
- Metrics
From 4ff746033a9c5bab31ef5c4ea761bf43730d38f0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jakub=20=C5=81awreszuk?=
<31008367+Jklawreszuk@users.noreply.github.com>
Date: Sun, 22 Sep 2024 14:44:20 +0200
Subject: [PATCH 03/15] Update core-team.md
---
en/contributors/core-team.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/en/contributors/core-team.md b/en/contributors/core-team.md
index 8a9fff05..86a8c93e 100644
--- a/en/contributors/core-team.md
+++ b/en/contributors/core-team.md
@@ -141,7 +141,7 @@ The core team is composed of members who make frequent contributions to the proj
Poland |
- - C#>
+ - C#
- Linux related stuff
- Asset compiler
- Metrics
From 445a6dd86b4c759840a067db543c4a14b636a913 Mon Sep 17 00:00:00 2001
From: Vaclav Elias
Date: Sat, 28 Sep 2024 19:51:34 +0100
Subject: [PATCH 04/15] docs: Navigation items repositioned
---
en/contributors/toc.yml | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/en/contributors/toc.yml b/en/contributors/toc.yml
index 7289b206..a45330d3 100644
--- a/en/contributors/toc.yml
+++ b/en/contributors/toc.yml
@@ -8,6 +8,10 @@ items:
href: roadmap.md
- name: πΈ Donate
href: donate.md
+- name: π§βπ» Core Team
+ href: core-team.md
+- name: βοΈ Major Release Workflow
+ href: major-release-workflow.md
- name: π€ Contribution Workflow
expanded: false
href: contribution-workflow/index.md
@@ -16,10 +20,6 @@ items:
href: contribution-workflow/github-pull-request-guidelines.md
- name: XML Comments and Docs
href: contribution-workflow/xml-comments-and-docs.md
-- name: βοΈ Major Release Workflow
- href: major-release-workflow.md
-- name: π§βπ» Core Team
- href: core-team.md
- name: π οΈ Contribute to the engine
expanded: false
href: engine/index.md
From ce9885787ae792d3408866ffe527d989a0299c07 Mon Sep 17 00:00:00 2001
From: Vaclav Elias
Date: Sat, 28 Sep 2024 20:33:35 +0100
Subject: [PATCH 05/15] feat: Readme updated
---
README.md | 56 ++++++++++++++++++++++++++++++++++---------------------
1 file changed, 35 insertions(+), 21 deletions(-)
diff --git a/README.md b/README.md
index d79ae4a2..ad598ddd 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,13 @@
# Stride Docs Development
-Welcome to the Stride Docs repository. This repository contains all the source files for the Stride documentation https://doc.stride3d.net/.
+Welcome to the Stride Docs repository. This repository contains all the source files for the Stride documentation [Stride Docs](https://doc.stride3d.net/).
-* [Getting Started](#-getting-started)
-* [Contributing](#-contributing)
-* [Roadmap](#%EF%B8%8F-roadmap)
-* [Stride Documentation Landscape](#-stride-documentation-landscape)
-* [.NET Foundation](#-net-foundation)
-* [License](#%EF%B8%8Flicense)
+* [π Getting Started](#-getting-started)
+* [π€ Contributing](#-contributing)
+* [πΊοΈ Roadmap](#%EF%B8%8F-roadmap)
+* [π Stride Documentation Landscape](#-stride-documentation-landscape)
+* [π .NET Foundation](#-net-foundation)
+* [π‘οΈ License](#%EF%B8%8Flicense)
## π Getting Started
@@ -16,23 +16,23 @@ All the information you need to get started with Stride Docs development can be
## π€ Contributing
Use [Discord](https://discord.gg/f6aerfE) for questions and general discussions.
-Use [Issues](https://github.com/stride3d/stride-docs/issues) to report bugs and proposing features.
+Use [Issues](https://github.com/stride3d/stride-docs/issues) to report bugs and propose features.
We welcome code contributions through pull requests. Issues tagged as **[`help wanted`](https://github.com/stride3d/stride-docs/labels/help%20wanted)** are good candidates for starting to contribute code.
-### Branch and Release
+### Branching and Releases
The `master` branch is the default branch for pull requests and most other development activities.
-Releases are based on a stable `master` branch. Use of [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) is encouraged.
+Releases are based on a stable `master` branch. Use of [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) is encouraged.
-Stride Docs website is _not_ released under a regular cadence; new updates arrive when maintainers fix issues or see enough changes that warrant a new releases.
+The Stride Docs website is _not_ released on a regular cadence; new updates arrive when maintainers fix issues or see enough changes that warrant a new release.
### Staging
The staging website allows us to test new features and significant changes before their official release.
-The staging website is available at https://stride-doc-staging.azurewebsites.net/
+The staging website is available at [Stride Docs Staging](https://stride-doc-staging.azurewebsites.net/).
## πΊοΈ Roadmap
@@ -40,21 +40,35 @@ Our [Roadmap](https://doc.stride3d.net/latest/en/contributors/documentation/road
## π Stride Documentation Landscape
-The Stride documentation landscape is organized across different locations. Here's how it's structured:
-
-1. [Stride Website](https://www.stride3d.net/) - Stride's official site showcasing its free, open-source 2D and 3D game engine, alongside blog posts
- - [Stride Website - Contributing](https://doc.stride3d.net/latest/en/contributors/website/index.html) - This serves as a comprehensive guide for those looking to contribute to or develop the Stride Website
-1. [Stride Docs](https://doc.stride3d.net/) - Here you'll find Stride's documentation, including manuals, tutorials, and API references
- - [Stride Docs - Contributing](https://doc.stride3d.net/latest/en/contributors/documentation/index.html) - This is a comprehensive guide for individuals interested in contributing to or developing the Stride Docs
-1. [Stride Wiki](https://github.com/stride3d/stride/wiki) - A thorough guide for those who wish to contribute to or develop Stride game engine
+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, a free and open-source 2D and 3D game engine.
+ - [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).
This project has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/) to clarify expected behavior in our community.
-For more information see the [.NET Foundation Code of Conduct](http://www.dotnetfoundation.org/code-of-conduct).
+For more information, see the [.NET Foundation Code of Conduct](http://www.dotnetfoundation.org/code-of-conduct).
-## π‘οΈLicense
+## π‘οΈ License
This project is licensed under the [MIT](https://github.com/stride3d/stride-docs/blob/master/LICENSE.md) License.
From 309a1286794f8ad645e9f2e6b30180fcc46dd844 Mon Sep 17 00:00:00 2001
From: Vaclav Elias
Date: Sat, 28 Sep 2024 20:44:30 +0100
Subject: [PATCH 06/15] refactor: Refactor contribution guide for clarity and
structure
Improved readability and consistency by updating phrases and link texts. Adjusted section headers to better organize content. Added new headers for various contribution types and moved relevant information under them. Included links to detailed contribution guides.
---
en/contributors/index.md | 39 ++++++++++++++++++++++++---------------
1 file changed, 24 insertions(+), 15 deletions(-)
diff --git a/en/contributors/index.md b/en/contributors/index.md
index e44fe66e..281778ca 100644
--- a/en/contributors/index.md
+++ b/en/contributors/index.md
@@ -1,40 +1,49 @@
# Ways to contribute
-Stride is a non-profit, community-driven, free and open source project.
+Stride is a non-profit, community-driven, free, and open-source project.
There are no full-time developers dedicated solely to Stride's advancement; instead, the engine progresses through the voluntary contributions of both the [core team](core-team.md) and the broader community.
-In order to thrive, Stride requires the help from other community members. There are various ways you can help:
+In order to thrive, Stride requires help from other community members. There are various ways you can help:
-### [Community activity](https://discord.gg/f6aerfE)π€
+## π€ Community activity
-To make Stride better, just use it and tell others about it in your blogs, videos, and events. Get involved in discussions on [Discord](https://discord.gg/f6aerfE) and [GitHub Discussion](https://github.com/stride3d/stride/discussions). Being a user and spreading the word is vital for our engine, as we don't have a big marketing budget and rely on the community to grow.
+To make Stride better, just use it and tell others about it in your blogs, videos, and events. Get involved in discussions on [Discord](https://discord.gg/f6aerfE) and [GitHub Discussions](https://github.com/stride3d/stride/discussions). Being a user and spreading the word is vital for our engine, as we don't have a big marketing budget and rely on the community to grow.
-### [Make games](https://github.com/stride3d/stride/wiki/Community-Projects) πΉοΈ
+## πΉοΈ Make games
The best way to promote Stride is by creating a cool demo or, even better, a full game. Having people see and play an actual game made with Stride is the most effective form of advertisement.
-### [Donate](donate.md) πΈ
+You can showcase your projects on our [Community Projects](https://github.com/stride3d/stride/wiki/Community-Projects) page.
-We utilize Open Collective for fundraising. The funds collected are allocated towards bug bounties and compensating individuals contracted for paid work.
+## πΈ Donate
-### [Submit bug reports](https://github.com/stride3d/stride/issues) π
+We utilize [Open Collective](donate.md) for fundraising. The funds collected are allocated towards bug bounties and compensating individuals contracted for paid work.
-Making Stride more stable greatly improves usability and user satisfaction. So if you encounter a bug during development, please contribute by reporting it on [GitHub](https://github.com/stride3d/stride/issues).
+## π Submit bug reports
-### [PR reviews](https://github.com/stride3d/stride/pulls) π
+Making Stride more stable greatly improves usability and user satisfaction. If you encounter a bug during development, please contribute by reporting it on [GitHub](https://github.com/stride3d/stride/issues).
+
+## π PR reviews
Contributing to Pull Requests (PRs) is excellent as it enables active participation without local builds. Reviewing and offering feedback in this collaborative process enhances code quality and maintains project standards, fostering a sense of community and knowledge sharing.
-### [Contribute code](engine/index.md) π€
+You can find open PRs [here](https://github.com/stride3d/stride/pulls).
+
+## π€ Contribute code
If you're passionate about C# and want to contribute by building features or fixing bugs in Stride, dive into the source code and get involved!
-Have a look at the GitHub issues label [Good first issue](https://github.com/stride3d/stride/labels/good%20first%20issue) or funded [Open Collective projects](https://opencollective.com/stride3d/projects)
-### [Contribute to Documentation](documentation/index.md) πͺΆ
+Have a look at GitHub issues labelled [Good first issue](https://github.com/stride3d/stride/labels/good%20first%20issue) or funded [Open Collective projects](https://opencollective.com/stride3d/projects).
+
+## πͺΆ Contribute to documentation
Enhance the official documentation and tutorials by expanding the manual or creating textual/video guides. Your contributions will greatly improve accessibility and understanding for users.
-### [Contribute to Website](website/index.md) π
+Learn more about how to contribute to the docs [here](documentation/index.md).
+
+## π Contribute to the website
+
+Enhance the official Stride website. Is design more your thing, or do you have an interesting blog post? It will all help us spread the word about Stride.
-Enhance the official Stride website. Is design more your thing, or do you have an interesting blog post? It will all help us spread the word of Stride.
\ No newline at end of file
+Find out how to contribute to the website [here](website/index.md).
\ No newline at end of file
From 1f8cd6e6e0d72fed62f16a4c7b08e3b95a11895c Mon Sep 17 00:00:00 2001
From: Vaclav Elias
Date: Sat, 28 Sep 2024 21:50:58 +0100
Subject: [PATCH 07/15] feat: Content improvements
---
en/community-resources/coding.md | 20 +++----
en/community-resources/embedded-stride.md | 20 +++----
en/community-resources/games-and-demos.md | 16 +++---
en/community-resources/index.md | 57 ++++++++++++-------
en/community-resources/toc.yml | 6 +-
.../tutorials-and-articles.md | 6 +-
en/contributors/index.md | 2 +-
7 files changed, 74 insertions(+), 53 deletions(-)
diff --git a/en/community-resources/coding.md b/en/community-resources/coding.md
index 34c78da2..fe418992 100644
--- a/en/community-resources/coding.md
+++ b/en/community-resources/coding.md
@@ -1,10 +1,12 @@
-#Coding
+# π¨βπ» Programming and Scripting
## Code Only
+
- [CodeOnlySample](https://github.com/xen2/Xenko.CodeOnlySample) - Sample project with code only
- [XenkoWindowFromCode](https://github.com/microdee/xenko-window-from-code) - Launch a game window from code only
## Networking
+
- [ClientServerSample](https://github.com/Ethereal77/Stride.ClientServerSample) - Headless server (Physics only, no game tick loop)
- [Stride.Networking.Simple](https://github.com/manio143/Stride.Networking.Simple) - Asynchronous NetworkScript example for client-server communication
- [ET-Stride: A networking framework based on Stride and ET](https://github.com/ly3027929699/ET-Stride)
@@ -15,10 +17,11 @@
- [Running Stride headless client/server](https://github.com/Ethereal77/Stride.ClientServerSample)
## Entity Component System
+
- [Entity Processor Example](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/EntityProcessorExample) - Custom Entity Component + Processor
- Libraries
- - [Doprez.Stride.AI: FSM and GOAP library for Stride](https://github.com/Doprez/Doprez.Stride.AI)
- - [Bepu Navigation](https://github.com/Nicogo1705/Stride.BepuPhysics/tree/master/Stride.BepuPhysics.Navigation) using [DotRecast](https://github.com/ikpil/DotRecast)
+ - [Doprez.Stride.AI: FSM and GOAP library for Stride](https://github.com/Doprez/Doprez.Stride.AI)
+ - [Bepu Navigation](https://github.com/Nicogo1705/Stride.BepuPhysics/tree/master/Stride.BepuPhysics.Navigation) using [DotRecast](https://github.com/ikpil/DotRecast)
- Articles
- [Svelto Abstraction from OOP](https://www.sebaslab.com/ecs-abstraction-layers-and-modules-encapsulation/)
- [Svelto Doofuses example](https://www.sebaslab.com/svelto-ecs-3-3-and-the-new-filters-api/#:~:text=shiny%20new%20Doofuses%20Stride%20example.)
@@ -27,11 +30,6 @@
- [Stride-npc: A basic example of a Finite State Machine](https://github.com/Doprez/stride-npc)
- [Stride-goap: a very simple implementation of GOAP using MountainGoap](https://github.com/Doprez/stride-goap)
- [Svelto ECS mini examples](https://github.com/sebas77/Svelto.MiniExamples)
- - [Using Entity Processors for Scene Editor Plugins](https://github.com/Doprez/lod-example)
- - [Pathfinding With Entity Processors](https://github.com/Doprez/stride-pathfinding-demo)
- - [Arch ECS integrated into Stride](https://github.com/Doprez/stride-arch-ecs#add-arch-components-in-strides-editor)
-
-
-
-
-
\ No newline at end of file
+ - [Using Entity Processors for Scene Editor Plugins](https://github.com/Doprez/lod-example)
+ - [Pathfinding With Entity Processors](https://github.com/Doprez/stride-pathfinding-demo)
+ - [Arch ECS integrated into Stride](https://github.com/Doprez/stride-arch-ecs#add-arch-components-in-strides-editor)
\ No newline at end of file
diff --git a/en/community-resources/embedded-stride.md b/en/community-resources/embedded-stride.md
index 5ac4b44e..7d63c4e3 100644
--- a/en/community-resources/embedded-stride.md
+++ b/en/community-resources/embedded-stride.md
@@ -1,11 +1,11 @@
-#Embedded Stride
+# π Embedding and Integration
-* project examples
- * [Stride in Ultralight Blazor](https://github.com/lionfire/LionFire.Stride.Ultralight)
- * [Stride in Winforms](https://github.com/windperson/-StrideGameNet5WinFormsDemo)
-* code blobs
- * [Stride in WPF Control](https://gist.github.com/EricEzaM/5797be1f4b28f15e9be53287a02d3d67)
- * [Stride in avalonia Control](https://gist.github.com/westonsoftware/a3fa982397fe1817ece4a27d3cbc5a89)
-* VVVV integration
- * [3D rendering documentation](https://thegraybook.vvvv.org/reference/libraries/graphics-3d.html)
- * [Stride integration source code on GitHub](https://github.com/vvvv/VL.StandardLibs)
\ No newline at end of file
+- Project examples
+ - [Stride in Ultralight Blazor](https://github.com/lionfire/LionFire.Stride.Ultralight)
+ - [Stride in WinForms](https://github.com/windperson/-StrideGameNet5WinFormsDemo)
+- Code blobs
+ - [Stride in WPF Control](https://gist.github.com/EricEzaM/5797be1f4b28f15e9be53287a02d3d67)
+ - [Stride in Avalonia Control](https://gist.github.com/westonsoftware/a3fa982397fe1817ece4a27d3cbc5a89)
+- VVVV integration
+ - [3D rendering documentation](https://thegraybook.vvvv.org/reference/libraries/graphics-3d.html)
+ - [Stride integration source code on GitHub](https://github.com/vvvv/VL.StandardLibs)
\ No newline at end of file
diff --git a/en/community-resources/games-and-demos.md b/en/community-resources/games-and-demos.md
index e15f7e7f..9a5d5790 100644
--- a/en/community-resources/games-and-demos.md
+++ b/en/community-resources/games-and-demos.md
@@ -18,16 +18,16 @@
- [Rise of the Undeaf](https://github.com/manio143/RiseOfTheUndeaf)
- [Xenko TPS example](https://github.com/stride3d/Starbreach)
- [Zerobot](https://github.com/joaovsq/Zerobot)
-- Youtube
- - [Rescue Drone - August 2015](https://www.youtube.com/watch?v=wOZ-s7Q4qWY)
- - [Xenko Game Engine: How The Makers Of Bravely Default Want To Help Develop Better VR Games](https://www.youtube.com/watch?v=1hgh7R38yK8)
- - [Xenko Procedural Terrain Generation & Water tests](https://www.youtube.com/watch?v=ba_Tpz4ojHk)
- - [Xenko 1.8 - Cel Shading](https://www.youtube.com/watch?v=RJDrG1QR3Uo)
- - [demo of vxgi implementation in Xenko game engine](https://www.youtube.com/watch?v=AZytf15FRks&t=2s)
+- YouTube
+ - [Rescue Drone - August 2015](https://www.youtube.com/watch?v=wOZ-s7Q4qWY)
+ - [Xenko Game Engine: How The Makers Of Bravely Default Want To Help Develop Better VR Games](https://www.youtube.com/watch?v=1hgh7R38yK8)
+ - [Xenko Procedural Terrain Generation & Water tests](https://www.youtube.com/watch?v=ba_Tpz4ojHk)
+ - [Xenko 1.8 - Cel Shading](https://www.youtube.com/watch?v=RJDrG1QR3Uo)
+ - [demo of vxgi implementation in Xenko game engine](https://www.youtube.com/watch?v=AZytf15FRks&t=2s)
- Twitter
- - [Networking from Scythe of Luna](https://twitter.com/scythe_of_luna/status/1616773130495885325)
+ - [Networking from Scythe of Luna](https://twitter.com/scythe_of_luna/status/1616773130495885325)
- Vimeo
- - [Data Sculpture for Herrenknecht rendered with Stride](https://vimeo.com/797315059)
+ - [Data Sculpture for Herrenknecht rendered with Stride](https://vimeo.com/797315059)
- Releases
- [Children of the galaxy](https://www.emptykeys.com/games/children-of-the-galaxy/)
- [Distant Worlds 2](https://store.steampowered.com/app/1531540/Distant_Worlds_2/)
diff --git a/en/community-resources/index.md b/en/community-resources/index.md
index 955e0959..0015489b 100644
--- a/en/community-resources/index.md
+++ b/en/community-resources/index.md
@@ -26,7 +26,7 @@ perhaps for something that you can reuse for your project.
@@ -35,7 +35,7 @@ perhaps for something that you can reuse for your project.
β¨Ί Models and Animations
- From procedural mesh to animation controllers
+ From procedural mesh to animation controllers.
Have a look
@@ -43,68 +43,83 @@ perhaps for something that you can reuse for your project.
-
πͺ UI
- Interfaces, interactions and 3rd party tools
+ Interfaces, interactions and 3rd party tools.
We will tell you why
-
- π Visual programming
- Visual programming, VVVV
+ π Visual programming
+ Visual programming, VVVV.
Start connecting the dots
-
- π Tools and importers
+ π οΈ Tools and importers
General tools, Asset handling and importer tools
Import some knowledge
+
+
+
+ π¨βπ» Programming and Scripting
+ Get your hands dirty with code, scripts, and more.
+
+ Unleash your inner coder
+
+
+
+
+
+ π Embedding and Integration
+ Plug Stride into other apps and make magic happen.
+
+ Plug in and play
+
+
diff --git a/en/community-resources/toc.yml b/en/community-resources/toc.yml
index 2e2386fe..65694cfe 100644
--- a/en/community-resources/toc.yml
+++ b/en/community-resources/toc.yml
@@ -21,4 +21,8 @@ items:
- name: π Visual Programming
href: visual-programming.md
- name: π οΈ Tools and Importers
- href: tools-and-importers.md
\ No newline at end of file
+ href: tools-and-importers.md
+- name: π¨βπ» Programming and Scripting
+ href: coding.md
+- name: π Embedding and Integration
+ href: embedded-stride.md
\ No newline at end of file
diff --git a/en/community-resources/tutorials-and-articles.md b/en/community-resources/tutorials-and-articles.md
index 5f36bda7..e8e61c48 100644
--- a/en/community-resources/tutorials-and-articles.md
+++ b/en/community-resources/tutorials-and-articles.md
@@ -13,9 +13,13 @@
* [Emanuel-DIY Follow Along Project](https://github.com/EmanuelGF/GhostHunterGame)
* [How To setup Real Time Voxel Global Illumination](https://www.youtube.com/watch?v=NEMZ_HJzJ7w&t=1s)
* [Marian Dziubiak - YouTube](https://www.youtube.com/@manio1432/videos)
+ * [Code Generator for Stride - Day 1](https://www.youtube.com/watch?v=Am5WTe9N5vg)
+ * [Code Generator for Stride - Day 2](https://www.youtube.com/watch?v=DZkjksB3vn4)
+ * [Code Generator for Stride - Day 3](https://www.youtube.com/watch?v=VqsYrlJZTLw)
+ * [Stride Clean UI tutorial step by step](https://www.youtube.com/watch?v=cazIR97VPcg)
+ * [Compiling Stride with Vulkan to debug local changes on Linux](https://www.youtube.com/watch?v=BoHEASoQvu8)
* [Stride Ragdoll Tutorial (beta)](https://youtu.be/n8yAV8OSbes)
* [Bullet physics constraints in Stride](https://www.youtube.com/watch?v=uMZMYpMD3Wg&t=1s)
- * [Stride Clean UI tutorial step by step](https://www.youtube.com/watch?v=cazIR97VPcg)
* [How to use locally built Stride Engine to debug your game](https://www.youtube.com/watch?v=bXSC9o-EaR8)
* [How to create custom configuration in Stride](https://www.youtube.com/watch?v=QKizq1xC4vk)
* [VVVV Visual scripting with Stride](https://www.youtube.com/watch?v=7m1EzfxUtzo&list=PL2KeRstDQVRRVnzCHEambwAI4yWmpIF-p)
diff --git a/en/contributors/index.md b/en/contributors/index.md
index 281778ca..07ed1afb 100644
--- a/en/contributors/index.md
+++ b/en/contributors/index.md
@@ -14,7 +14,7 @@ To make Stride better, just use it and tell others about it in your blogs, video
The best way to promote Stride is by creating a cool demo or, even better, a full game. Having people see and play an actual game made with Stride is the most effective form of advertisement.
-You can showcase your projects on our [Community Projects](https://github.com/stride3d/stride/wiki/Community-Projects) page.
+You can showcase your projects on our [Community resources](../community-resources/index.md) page.
## πΈ Donate
From e8158b42c623a03711116e6fdf3c1082e17233f9 Mon Sep 17 00:00:00 2001
From: Vaclav Elias
Date: Sat, 28 Sep 2024 21:54:33 +0100
Subject: [PATCH 08/15] feat: Prerequisites like on GitHub
---
.../engine/building-source-windows.md | 18 +++++++++---------
1 file changed, 9 insertions(+), 9 deletions(-)
diff --git a/en/contributors/engine/building-source-windows.md b/en/contributors/engine/building-source-windows.md
index a13cb362..5ee1db57 100644
--- a/en/contributors/engine/building-source-windows.md
+++ b/en/contributors/engine/building-source-windows.md
@@ -2,17 +2,17 @@
## Prerequisites
-1. **Latest** [Git](https://git-scm.com/downloads) **with Large File Support** selected in the setup on the components dialog.
-2. [.NET SDK 8.0](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
+1. **Latest** [Git](https://git-scm.com/downloads) **with Large File Support** selected in the setup on the components dialog and for convenience 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://www.visualstudio.com/downloads/) with the following workloads:
- - `.NET desktop development` with `.NET Framework 4.7.2 targeting pack`
+ - `.NET desktop development` with `.NET Framework 4.7.2 targeting pack` (should be enabled by default)
- `Desktop development with C++` with
- - `Windows 10 SDK (10.0.18362.0)` (it's currently enabled by default but it might change)
- - `MSVC v143 - VS2022 C++ x64/x86 build tools (v14.30)` or later version (should be enabled by default)
- - `C++/CLI support for v143 build tools (v14.30)` 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.
-4. **[FBX SDK 2019.0 VS2015](https://www.autodesk.com/developer-network/platform-technologies/fbx-sdk-2019-0)**
+ - `Windows 10 SDK (10.0.18362.0)` or 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-paltform App UI development` and `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 `Tools` tab.
+ - Optional (to build VSIX package): `Visual Studio extension development`
## Build Stride with Visual Studio 2022
Here are the steps to build Stride with Visual Studio. If you do not have or want to use Visual Studio, see [building with other IDEs](building-source-windows-other-ide.md)
From 56f8766457464c499c8e156938be8dee72b8d47c Mon Sep 17 00:00:00 2001
From: Vaclav Elias
Date: Sat, 28 Sep 2024 21:58:15 +0100
Subject: [PATCH 09/15] feat: Readme updated
---
README.md | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index ad598ddd..38de86ee 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,12 @@
Welcome to the Stride Docs repository. This repository contains all the source files for the Stride documentation [Stride Docs](https://doc.stride3d.net/).
-* [π Getting Started](#-getting-started)
-* [π€ Contributing](#-contributing)
-* [πΊοΈ Roadmap](#%EF%B8%8F-roadmap)
-* [π Stride Documentation Landscape](#-stride-documentation-landscape)
-* [π .NET Foundation](#-net-foundation)
-* [π‘οΈ License](#%EF%B8%8Flicense)
+* π [Getting Started](#-getting-started)
+* π€ [Contributing](#-contributing)
+* πΊοΈ [Roadmap](#%EF%B8%8F-roadmap)
+* π [Stride Documentation Landscape](#-stride-documentation-landscape)
+* π [.NET Foundation](#-net-foundation)
+* π‘οΈ [License](#%EF%B8%8Flicense)
## π Getting Started
From beebb61e03c1973f714318eedbd584877293e29d Mon Sep 17 00:00:00 2001
From: Vaclav Elias
Date: Sat, 28 Sep 2024 22:25:50 +0100
Subject: [PATCH 10/15] Rename LICENSE to LICENSE.md
---
LICENSE => LICENSE.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
rename LICENSE => LICENSE.md (99%)
diff --git a/LICENSE b/LICENSE.md
similarity index 99%
rename from LICENSE
rename to LICENSE.md
index 434921a6..08bc3154 100644
--- a/LICENSE
+++ b/LICENSE.md
@@ -18,4 +18,4 @@ 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.
\ No newline at end of file
+SOFTWARE.
From 100cfcaaa6ad1ccc03256d999dd3c704ef4a9e6f Mon Sep 17 00:00:00 2001
From: Vaclav Elias
Date: Sun, 29 Sep 2024 23:26:35 +0100
Subject: [PATCH 11/15] feat: Install stride content improved
---
en/manual/get-started/install-stride.md | 39 ++++++++++++++++++-------
1 file changed, 29 insertions(+), 10 deletions(-)
diff --git a/en/manual/get-started/install-stride.md b/en/manual/get-started/install-stride.md
index c8a77546..7d9871f0 100644
--- a/en/manual/get-started/install-stride.md
+++ b/en/manual/get-started/install-stride.md
@@ -2,9 +2,26 @@
Beginner
+## Introduction
+
+If you want to **create games using Stride**, this guide provides the installation steps you'll need to follow. You'll need to install the Stride installer and launcher. The Stride installer is approximately **55 MB** and is downloaded directly from our main GitHub repository.
+
+The installer will automatically download and install the prerequisites if they are not detected, including the [Stride Launcher](launch-stride.md), which is essential for downloading and installing the latest version of Stride for game development.
+
+If you're interested in **building the Stride engine from source** or **contributing to its development**, please visit the [Stride GitHub repository](https://github.com/stride3d/stride) for instructions on how to build from source and contribute to the project.
+
+**Prerequisites (automatically installed if not present):**
+
+- Latest **.NET SDK** supported by Stride
+- Microsoft Visual C++ Redistributable
+
+The **Stride Launcher** will download and install the latest version of Stride.
+
+## Installation Steps
+
1. Download the Stride installer (**StrideSetup.exe**) from the [Stride website](http://stride3d.net/download/).
-2. Double-click the **StrideSetup.exe** file.
+2. Run the installer by double-clicking the **StrideSetup.exe** file.
3. The **Stride Setup Wizard** opens.
@@ -22,31 +39,31 @@
![Select installation folder window](media/install-stride-select-installation-folder.webp)
- Select a folder to install Stride to and click **Next**.
+ Choose a folder where you want to install Stride, then click **Next**.
6. The **Create application shortcuts** window opens.
![Create application shortcuts window](media/install-stride-create-application-shortcuts.webp)
- Choose which shortcuts you want Stride to create, and click **Next**.
+ Choose which shortcuts you want Stride to create, then click **Next**.
7. The **Ready to Install** window opens.
![Ready to install window](media/install-stride-ready-to-install.webp)
- Click **Install**.
+ Click **Install** to begin the installation.
8. Installation begins.
![Installation status](media/install-stride-installation-status.webp)
- After the installer closes, Stride creates shortcuts in locations you selected and the **Stride Launcher** starts.
+ The installer will proceed with the installation. After it completes, Stride creates shortcuts in the locations you selected, and the **Stride Launcher** starts automatically.
-9. The first time, you will be asked to accept the privacy policy.
+9. The first time you run the Stride Launcher, you will be asked to accept the privacy policy.
![Stride privacy policy](media/stride-privacy-policy-prompt.webp)
- Check *I agree to the Privacy Policy*, and then click **I Accept**.
+ Check *I agree to the Privacy Policy*, then click **I Accept**.
10. The **Stride Launcher** window opens.
@@ -56,7 +73,7 @@
![No version installed](media/stride-launcher-install-latest-version-prompt.webp)
- Click **Yes**.
+ Click **Yes** to install the latest version.
11. Installation of the latest version of Stride begins.
@@ -70,15 +87,17 @@
Click **Install**.
-13. The Stride Launcher asks if you want to install the Visual Studio integration. This lets you edit shaders directly from Visual Studio and provides syntax highlighting, live code analysis with validation, error-checking, and navigation. Installing the integration isn't mandatory, but we recommend it.
+13. The Stride Launcher asks if you want to install the Visual Studio integration. This allows you to edit shaders directly from Visual Studio, providing syntax highlighting, live code analysis with validation, error-checking, and navigation. Installing the integration isn't mandatory, but we recommend it.
![Install Visual Studio integration](media/install-VS-plug-in-prompt.webp)
+ Click **Yes** to install the integration, or **No** to skip.
+
14. Stride is now installed and ready to use.
![Stride ready to use](media/stride-launcher-ready.webp)
->[!Note]
+> [!Note]
> If you don't install the prerequisites, Stride won't run. In this case, you can download and install the prerequisites separately. For instructions, see [Troubleshooting β Stride doesn't run](../troubleshooting/stride-doesnt-run.md).
>
> Alternatively, uninstall Stride, restart the Stride installer, and install the prerequisites when prompted.
From 3f789f496b5d265141dcc9fc73f7abc2a657f44f Mon Sep 17 00:00:00 2001
From: Vaclav Elias
Date: Sun, 29 Sep 2024 23:33:08 +0100
Subject: [PATCH 12/15] feat: install-stride updated
---
en/manual/get-started/install-stride.md | 3 +++
1 file changed, 3 insertions(+)
diff --git a/en/manual/get-started/install-stride.md b/en/manual/get-started/install-stride.md
index 7d9871f0..b728555c 100644
--- a/en/manual/get-started/install-stride.md
+++ b/en/manual/get-started/install-stride.md
@@ -97,6 +97,9 @@ The **Stride Launcher** will download and install the latest version of Stride.
![Stride ready to use](media/stride-launcher-ready.webp)
+> [!Note]
+> **Stride Launcher:** If you click **Start** and see an error message such as `Could not find a compatible version of MSBuild.` or `Path to dotnet executable is not set.`, close the Stride Launcher and restart it. This issue is caused by the Stride Launcher not detecting the .NET SDK installation. Restarting the Stride Launcher should resolve the issue. Alternatively, restart your computer.
+
> [!Note]
> If you don't install the prerequisites, Stride won't run. In this case, you can download and install the prerequisites separately. For instructions, see [Troubleshooting β Stride doesn't run](../troubleshooting/stride-doesnt-run.md).
>
From 1626c378e109781dfeccba9f67c89a24c381c014 Mon Sep 17 00:00:00 2001
From: Vaclav Elias
Date: Sun, 29 Sep 2024 23:53:53 +0100
Subject: [PATCH 13/15] feat: Content added to the Get Started page.
---
en/manual/get-started/index.md | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/en/manual/get-started/index.md b/en/manual/get-started/index.md
index 6f041086..9914a6c5 100644
--- a/en/manual/get-started/index.md
+++ b/en/manual/get-started/index.md
@@ -5,7 +5,13 @@ uid: ../toc.md
Beginner
-This chapter explains everything you need to start using Stride from scratch. For video tutorials, have a look at the the [Tutorials](https://doc.stride3d.net/latest/en/tutorials/index.html).
+Welcome to Stride! This chapter provides everything you need to start creating games using the Stride game engine. If you're new to Stride, we recommend starting with the [Install Stride](install-stride.md) guide, which will help you set up the engine and get you ready for development.
+
+Stride is designed for game developers who want a powerful, flexible, and open-source engine for their projects. Whether you're an experienced developer or just starting out, these guides will walk you through the basics and help you get up and running quickly.
+
+For video tutorials, have a look at the [Tutorials](https://doc.stride3d.net/latest/en/tutorials/index.html).
+
+If you're interested in building the Stride engine from source or contributing to its development, please refer to the instructions on our [GitHub repository](https://github.com/stride3d/stride).
![Game Studio](media/get-started.jpg)
From e060c29f2eb9a1992170bdcfaff3087b6f105434 Mon Sep 17 00:00:00 2001
From: Vaclav Elias
Date: Mon, 30 Sep 2024 00:30:36 +0100
Subject: [PATCH 14/15] fix: Link corrected
---
en/manual/get-started/index.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/en/manual/get-started/index.md b/en/manual/get-started/index.md
index 9914a6c5..3fb91b3e 100644
--- a/en/manual/get-started/index.md
+++ b/en/manual/get-started/index.md
@@ -9,7 +9,7 @@ Welcome to Stride! This chapter provides everything you need to start creating g
Stride is designed for game developers who want a powerful, flexible, and open-source engine for their projects. Whether you're an experienced developer or just starting out, these guides will walk you through the basics and help you get up and running quickly.
-For video tutorials, have a look at the [Tutorials](https://doc.stride3d.net/latest/en/tutorials/index.html).
+For video tutorials, have a look at the [Tutorials](../../tutorials/index.md).
If you're interested in building the Stride engine from source or contributing to its development, please refer to the instructions on our [GitHub repository](https://github.com/stride3d/stride).
From e12e6034c3bfbfebeb22fdc3c62343c560f65add Mon Sep 17 00:00:00 2001
From: Vaclav Elias
Date: Mon, 30 Sep 2024 11:36:44 +0100
Subject: [PATCH 15/15] Update building-source-windows.md
---
.../engine/building-source-windows.md | 52 ++++++++++++-------
1 file changed, 32 insertions(+), 20 deletions(-)
diff --git a/en/contributors/engine/building-source-windows.md b/en/contributors/engine/building-source-windows.md
index 5ee1db57..019c7048 100644
--- a/en/contributors/engine/building-source-windows.md
+++ b/en/contributors/engine/building-source-windows.md
@@ -2,38 +2,50 @@
## Prerequisites
-1. **Latest** [Git](https://git-scm.com/downloads) **with Large File Support** selected in the setup on the components dialog and for convenience 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://www.visualstudio.com/downloads/) 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 10 SDK (10.0.18362.0)` or 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-paltform App UI development` and `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 `Tools` tab.
- - Optional (to build VSIX package): `Visual Studio extension development`
+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 with Visual Studio 2022
Here are the steps to build Stride with Visual Studio. If you do not have or want to use Visual Studio, see [building with other IDEs](building-source-windows-other-ide.md)
-1. Open a command prompt, point it to a directory and clone Stride to it: `git clone https://github.com/stride3d/stride.git`
- - Note that when you use GitHub -> Code -> Download ZIP, this doesn't support Large File Support ```lfs```, make sure you use the command above or that your git client does it for you
-2. Open `\build\Stride.sln` with Visual Studio 2022 and build `Stride.GameStudio` in the 60-Editor solution folder (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.
+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.
### 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 anterior version is present alongside 2022. If you want to keep those version make sure that they are up to date and that you are building Stride through VS 2022.
* Your system's *PATH* should not contain older versions of MSBuild (ex: `...\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.
+* 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.`
* Make sure that Git, Git LFS 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`.
## Other IDEs
-You are not required to use Visual Studio to build the Stride engine with Visual Studio. You can also build entirely from command line or other IDE's such as [Rider or Visual Studio Code](building-source-windows-other-ide.md).
-
-
-
+You are not required to use Visual Studio to build the Stride engine with Visual Studio. You can also build entirely from command line or other IDE's such as [Rider or Visual Studio Code](building-source-windows-other-ide.md).
| |