diff --git a/README.md b/README.md index d79ae4a22..38de86eed 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. diff --git a/en/community-resources/coding.md b/en/community-resources/coding.md index 34c78da2d..fe418992f 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 5ac4b44e7..7d63c4e39 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 e15f7e7f1..9a5d5790f 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 955e09590..0015489bc 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.
Tutorials and articles
+Tutorials and articles.
From procedural mesh to animation controllers
+From procedural mesh to animation controllers.
Enter the magical world of shaders.
+Groundbreaking stuff and H2O related topics.
Groundbreaking stuff and H2O related topics
+Physics, colliders, triggers.
Rendering, Camera's, render groups and more
+Enter the magical world of shaders.
Physics, colliders, triggers
+Rendering, Camera's, render groups and more.
Interfaces, interactions and 3rd party tools
+Interfaces, interactions and 3rd party tools.
Visual programming, VVVV
+Visual programming, VVVV.
General tools, Asset handling and importer tools
Get your hands dirty with code, scripts, and more.
+Plug Stride into other apps and make magic happen.
+