Merge pull request #258 from stride3d/master

Initiating deployment of latest docs updates to staging
stride3d · Feb 18, 2024 · 7c7b14a · 7c7b14a
2 parents 320c9ba + 6def8b9
commit 7c7b14a
Show file tree

Hide file tree

Showing 15 changed files with 119 additions and 121 deletions.
diff --git a/Stride.Docs.csproj b/Stride.Docs.csproj
@@ -6,8 +6,4 @@
         <ImplicitUsings>enable</ImplicitUsings>
     </PropertyGroup>
 
-    <ItemGroup>
-      <Folder Include="en\community-resources\media\" />
-    </ItemGroup>
-
 </Project>
diff --git a/en/community-resources/coding.md b/en/community-resources/coding.md
@@ -1,4 +1,4 @@
-#Coding
+#Coding
 
 ## Code Only
 - [CodeOnlySample](https://github.com/xen2/Xenko.CodeOnlySample) - Sample project with code only
@@ -14,7 +14,7 @@
 - [MUD framework for Stride](https://github.com/JoseJohnen/MUD_SKELETON/tree/main)
 - [Running Stride headless client/server](https://github.com/Ethereal77/Stride.ClientServerSample)
 
-## Entiy Component System
+## 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)

diff --git a/en/community-resources/embedded-stride.md b/en/community-resources/embedded-stride.md
@@ -1,11 +1,11 @@
 #Embedded Stride
 
 * project examples
-	* [Stride in Ultralight Blazor](https://github.com/lionfire/LionFire.Stride.Ultralight)
-	* [Stride in Winforms](https://github.com/windperson/-StrideGameNet5WinFormsDemo)
+    * [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)
+    * [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)
+    * [3D rendering documentation](https://thegraybook.vvvv.org/reference/libraries/graphics-3d.html)
+    * [Stride integration source code on GitHub](https://github.com/vvvv/VL.StandardLibs)
diff --git a/en/community-resources/engine.md b/en/community-resources/engine.md
@@ -1,9 +1,9 @@
-  # Engine Documentation
+  # Engine Documentation
 
-* [Custom Root Renderer](https://github.com/tebjan/Stride.CustomRootRenderFeature)
-* [Compiling Stride for Linux](https://www.youtube.com/watch?v=BoHEASoQvu8)
-* [Experimental mini Stride.Editor in Avalonia](https://github.com/manio143/StrideComponentsEditorAvalonia)
-* [Stride Editor current design document](https://gist.github.com/manio143/b6666eedb1403deb5525961697d0c25d)
-* [Stride docs shader stages](https://github.com/stride3d/stride*docs/blob/master/en/manual/graphics/effects*and*shaders/shading*language/shader*stages.md/)
-* [Strideui discussion](https://gist.github.com/manio143/8706b4bad5f7db5402d3b81acbb6276e)
-* [Stride Game Engine Extension for code only approach](https://github.com/VaclavElias/stride*code*only)
+- [Custom Root Renderer](https://github.com/tebjan/Stride.CustomRootRenderFeature)
+- [Compiling Stride for Linux](https://www.youtube.com/watch?v=BoHEASoQvu8)
+- [Experimental mini Stride.Editor in Avalonia](https://github.com/manio143/StrideComponentsEditorAvalonia)
+- [Stride Editor current design document](https://gist.github.com/manio143/b6666eedb1403deb5525961697d0c25d)
+- [Stride docs shader stages](https://github.com/stride3d/stride-docs/blob/master/en/manual/graphics/effects-and-shaders/shading-language/shader-stages.md/)
+- [Strideui discussion](https://gist.github.com/manio143/8706b4bad5f7db5402d3b81acbb6276e)
+- [Stride Game Engine Extension for code only approach](https://github.com/VaclavElias/stride-code-only)
diff --git a/en/community-resources/example-projects.md b/en/community-resources/example-projects.md
@@ -1,9 +1,9 @@
 # Example projects
 
 ## Input
-* [Control * Input Manager](https://github.com/rsptim1/Ctrl)
+* [Control - Input Manager](https://github.com/rsptim1/Ctrl)
 * [Easier input binding configuration](https://github.com/lparkermg/LPSoft.Stride.InputExtensions)
-* [Demos with a focus on Code*Only approach](https://github.com/najak3d/Stride3D_Demos)
+* [Demos with a focus on Code-Only approach](https://github.com/najak3d/Stride3D_Demos)
 
 ## Editor
 * [Custom Editor Gizmos](https://github.com/gearsin/Stride.Demo.Gizmo/tree/master)
@@ -38,15 +38,15 @@
 * [StrideVoxelScape](https://github.com/Jarb2104/StrideVoxelScape_v0.1)
 * [Stride3D examples in .NET 5 using C# 9.0 or .NET 6 using C# 10](https://github.com/VaclavElias/Stride3DTutorials)
 * [Tweening library](https://github.com/JoshFlash/ZenTween)
-* [Tessellation](https://github.com/johang88/Stride*Tessellation)
+* [Tessellation](https://github.com/johang88/Stride-Tessellation)
 * [Workshop creating a game with Stride](https://github.com/manio143/StrideIntroWorkshopNode20/tree/main)
-* [Xenko/Stride byte*sized project examples](https://github.com/profan/XenkoByteSized)
+* [Xenko/Stride byte-sized project examples](https://github.com/profan/XenkoByteSized)
 
 
 ### Old projects
 These are projects that definitely will not work with Stride 4.x without massive rewrites but were made with the old versions of Stride FKA Xenko or Paradox game engine.
 
-* [A Minecraft*style game](https://github.com/NckHmml/ParadoxCraft)
+* [A Minecraft-style game](https://github.com/NckHmml/ParadoxCraft)
 * [Xenko Voxel Scape](https://github.com/Doprez/stride-voxelscape)
 * [Stride Voxel Scape](https://github.com/Jarb2104/StrideVoxelScape_v0.1)
     * [Video demo](https://www.youtube.com/watch?v=whJOtux2DrQ)

diff --git a/en/community-resources/games-and-demos.md b/en/community-resources/games-and-demos.md
@@ -1,45 +1,45 @@
 # Games and demos
 
 ## Games
-* [Distant Worlds 2](https://store.steampowered.com/app/1531540/Distant_Worlds_2) - Vast, pausable real*time 4X space strategy game
-* [Starbreach](https://github.com/xenko3d/Starbreach) - First/Third Person Shooter
-* [Rollerghoaster](https://aggror.com/blog/video*rollerghoaster*0.0.2*demo) - Race against online and local ghosts on procedural tracks
-* [FPS Infinite](https://store.steampowered.com/app/1256380/FPS_Infinite/) - Procedural FPS with VR support
-* [Once Upon A Lan](https://jarmo.itch.io/once*upon*a*lan) - Multiplayer isometric arena brawler over LAN
-* [BallsOfSteel](https://github.com/Kryptos*FR/BallsOfSteel)
-* [XenkoSpaceShooter](https://github.com/jayrulez/XenkoSpaceShooter)
-* [XenkoAsteroids](https://github.com/LanceJZ/Xenko_Asteroids)
-* [TurnBasedBattleSim](https://github.com/jayrulez/TurnBasedBattleSim)
-* [Harrowing Flight](https://forums.xenko.com/t/harrowing*flight*student*game*project/1823) - Student Game Project
-* [Glasses](https://globalgamejam.org/2019/games/glasses) - Global Game Jam Entry
-* [vvvv Showcase](https://visualprogramming.net/#Showcase) - Many large*scale interactive media projects made with vvvv
-* [Astroids](https://github.com/LanceJZ/Stride-Asteroids)
-* [Basic Platformer WIP](https://github.com/Doprez/stride-platformer)
-* [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 &amp; 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)
-* Vimeo
-    * [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/)
-  * [Snaaker Friends](https://store.steampowered.com/app/1443760/Snaaker__Friends/)
-  * [VVVVarkle with vvvv rendered using Stride](https://github.com/BenTec3d/VVVVarkle/releases/tag/v1.0)
-  * [Virtual Desktop](https://www.vrdesktop.net/)
-    * [Flappy Bird With Source Code](https://nedreid.itch.io/flappy*bird*stride)
-  * [Large*scale interactive projects made with VVVV](https://visualprogramming.net/#Showcase)
-* Game Jams
-  * [Step up Made by Marian Dziubiak and Youness Kafia](https://manio143.itch.io/project*step*up)
-  * [Stopping the Rogue by manio](https://manio143.itch.io/stopping*the*rogue)
-  * [Once Upon a LAN by Jarmo](https://jarmo.itch.io/once*upon*a*lan)
-  * [Dozer Dash](https://ldjam.com/events/ludum*dare/54/$374737) * made with a code only approach [plus repo](https://github.com/Schossi/LD54/tree/main)
-* Projects
-  * [Astroids](https://github.com/mmujic2/StrideAsteroids)  
+- [Distant Worlds 2](https://store.steampowered.com/app/1531540/Distant_Worlds_2) - Vast, pausable real-time 4X space strategy game
+- [Starbreach](https://github.com/xenko3d/Starbreach) - First/Third Person Shooter
+- [Rollerghoaster](https://aggror.com/blog/video-rollerghoaster-0.0.2-demo) - Race against online and local ghosts on procedural tracks
+- [FPS Infinite](https://store.steampowered.com/app/1256380/FPS_Infinite/) - Procedural FPS with VR support
+- [Once Upon A Lan](https://jarmo.itch.io/once-upon-a-lan) - Multiplayer isometric arena brawler over LAN
+- [BallsOfSteel](https://github.com/Kryptos-FR/BallsOfSteel)
+- [XenkoSpaceShooter](https://github.com/jayrulez/XenkoSpaceShooter)
+- [XenkoAsteroids](https://github.com/LanceJZ/Xenko_Asteroids)
+- [TurnBasedBattleSim](https://github.com/jayrulez/TurnBasedBattleSim)
+- [Harrowing Flight](https://forums.stride3d.net/t/harrowing-flight-student-game-project/1823) - Student Game Project
+- [Glasses](https://globalgamejam.org/2019/games/glasses) - Global Game Jam Entry
+- [vvvv Showcase](https://visualprogramming.net/#Showcase) - Many large-scale interactive media projects made with vvvv
+- [Astroids](https://github.com/LanceJZ/Stride-Asteroids)
+- [Basic Platformer WIP](https://github.com/Doprez/stride-platformer)
+- [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 &amp; 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)
+- Vimeo
+    - [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/)
+  - [Snaaker Friends](https://store.steampowered.com/app/1443760/Snaaker__Friends/)
+  - [VVVVarkle with vvvv rendered using Stride](https://github.com/BenTec3d/VVVVarkle/releases/tag/v1.0)
+  - [Virtual Desktop](https://www.vrdesktop.net/)
+    - [Flappy Bird With Source Code](https://nedreid.itch.io/flappy-bird-stride)
+  - [Large-scale interactive projects made with VVVV](https://visualprogramming.net/#Showcase)
+- Game Jams
+  - [Step up Made by Marian Dziubiak and Youness Kafia](https://manio143.itch.io/project-step-up)
+  - [Stopping the Rogue by manio](https://manio143.itch.io/stopping-the-rogue)
+  - [Once Upon a LAN by Jarmo](https://jarmo.itch.io/once-upon-a-lan)
+  - [Dozer Dash](https://ldjam.com/events/ludum-dare/54/$374737) - made with a code only approach [plus repo](https://github.com/Schossi/LD54/tree/main)
+- Projects
+  - [Astroids](https://github.com/mmujic2/StrideAsteroids)  
diff --git a/en/community-resources/models-and-animations.md b/en/community-resources/models-and-animations.md
@@ -10,7 +10,7 @@
 * [Stride IK implementation](https://github.com/flipdp/Stride.IK/tree/master)
 * [Stride Instancing Example](https://github.com/tebjan/StrideTransformationInstancing)
 * [Super Character Controller](https://github.com/corthax/SuperCharacterController)
-* [Multi*Mesh Shader](https://github.com/profan/XenkoByteSized/blob/master/XenkoByteSized/ProceduralMesh/CombinedMeshes.cs)
+* [Multi-Mesh Shader](https://github.com/profan/XenkoByteSized/blob/master/XenkoByteSized/ProceduralMesh/CombinedMeshes.cs)
 
 ## Animation
 * [Animation Trigger script](https://gist.github.com/Doprez/3ff7463fc48bd8e69178fde388dd1df4)
diff --git a/en/community-resources/physics.md b/en/community-resources/physics.md
@@ -1,6 +1,6 @@
 # Physics
 * [Physics constraints demo](https://github.com/manio143/StrideConstraintsDemo)
 * [Bepu physics integration](https://github.com/Nicogo1705/BepuPhysicIntegrationTest/tree/master)
-* [Trigger Example](https://github.com/profan/XenkoByteSized#xenkobytesizedtriggerscene***doorscript)
-* [Vehicle Script](https://github.com/profan/XenkoByteSized#xenkobytesizedvehiclescene***vehiclescript)
-* [XenkoRotatingSun](https://github.com/SuavePirate/Xenko.RotatingSun) * Rotating Sun
+* [Trigger Example](https://github.com/profan/XenkoByteSized#xenkobytesizedtriggerscene---doorscript)
+* [Vehicle Script](https://github.com/profan/XenkoByteSized#xenkobytesizedvehiclescene---vehiclescript)
+* [XenkoRotatingSun](https://github.com/SuavePirate/Xenko.RotatingSun) - Rotating Sun
diff --git a/en/community-resources/rendering-and-camera.md b/en/community-resources/rendering-and-camera.md
@@ -1,34 +1,34 @@
 # Rendering and Camera
 
 ## Rendering
-* [Debug shape render](https://github.com/Doprez/Stride.DebugShapes)
-  * [Old: Debug shape render](https://github.com/profan/XenkoDebugRendering/tree/master/DebugRendering)
-* [Fog Of War](https://github.com/herocrab/StrideFogOfWarPlus)
-* [Stride Outline Renderer](https://github.com/SoulRider/StrideOutlineRenderer)
-* [XenkoByteSized](https://github.com/profan/XenkoByteSized) * Various Procedural Renderings
-* [ShaderExplorerForStride](https://github.com/tebjan/Stride.ShaderExplorer/releases) * Explore Stride source shader implementations
-* [FlowingWater](https://github.com/TomGroner/XenkoFlowingWater) * Flowing water shader implementation
-* [VoxelGIPrototype](https://github.com/WhyPenguins/XenkoVoxelGI) * VXGI inspired Global Illumination shaders (merged as of Stride v4beta2)
-* [XenkoVoxelExample](https://github.com/jason*wilmans/XenkoVoxelExample) * minecraft like voxel brick world
-* [CustomRootRenderer](https://github.com/tebjan/Xenko.CustomRootRenderFeature) * Render custom shaders correctly into a scene
-* [StrideFogOfWarPlus](https://github.com/herocrab/StrideFogOfWarPlus) * Moba/Platformer/RTS FogOfWar System (no LoS)
-* [StrideTriplanarShader](https://github.com/herocrab/StrideTriplanarShader) * Triplanar Shader for Stride
-* [StrideMeshOutlineRenderFeature](https://github.com/herocrab/StrideMeshOutlineRenderFeature) * Mesh Outline Render Feature
-* [Object Info Render Target Example](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/ObjectInfoRenderTargetExample) * Renders object information onto a render target
-* [Screen Space Decal Example](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/ScreenSpaceDecalExample) * Screen space projected decal system
-* [Screen Space Decal Root Renderer Example](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/ScreenSpaceDecalRootRendererExample) * Screen space projected decal system using RootRenderFeature
-* [TR.Stride](https://github.com/johang88/TR.Stride)
-    * TR.Stride.Atmosphere * Implementation of UE4 atmosphere rendering
-    * TR.Stride.Ocean * Ocean Water rendering
-    * TR.Stride.Terrain* Height Map Terrain
-    * TR.Stride.Gameplay * Manage savegames
-* [UnrealMotion](https://github.com/ykafia/UnrealMotion) * Unreal engine motion blur for Stride
+- [Debug shape render](https://github.com/Doprez/Stride.DebugShapes)
+  - [Old: Debug shape render](https://github.com/profan/XenkoDebugRendering/tree/master/DebugRendering)
+- [Fog Of War](https://github.com/herocrab/StrideFogOfWarPlus)
+- [Stride Outline Renderer](https://github.com/SoulRider/StrideOutlineRenderer)
+- [XenkoByteSized](https://github.com/profan/XenkoByteSized) - Various Procedural Renderings
+- [ShaderExplorerForStride](https://github.com/tebjan/Stride.ShaderExplorer/releases) - Explore Stride source shader implementations
+- [FlowingWater](https://github.com/TomGroner/XenkoFlowingWater) - Flowing water shader implementation
+- [VoxelGIPrototype](https://github.com/WhyPenguins/XenkoVoxelGI) - VXGI inspired Global Illumination shaders (merged as of Stride v4beta2)
+- [XenkoVoxelExample](https://github.com/jason-wilmans/XenkoVoxelExample) - minecraft like voxel brick world
+- [CustomRootRenderer](https://github.com/tebjan/Xenko.CustomRootRenderFeature) - Render custom shaders correctly into a scene
+- [StrideFogOfWarPlus](https://github.com/herocrab/StrideFogOfWarPlus) - Moba/Platformer/RTS FogOfWar System (no LoS)
+- [StrideTriplanarShader](https://github.com/herocrab/StrideTriplanarShader) - Triplanar Shader for Stride
+- [StrideMeshOutlineRenderFeature](https://github.com/herocrab/StrideMeshOutlineRenderFeature) - Mesh Outline Render Feature
+- [Object Info Render Target Example](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/ObjectInfoRenderTargetExample) - Renders object information onto a render target
+- [Screen Space Decal Example](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/ScreenSpaceDecalExample) - Screen space projected decal system
+- [Screen Space Decal Root Renderer Example](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/ScreenSpaceDecalRootRendererExample) - Screen space projected decal system using RootRenderFeature
+- [TR.Stride](https://github.com/johang88/TR.Stride)
+    - TR.Stride.Atmosphere - Implementation of UE4 atmosphere rendering
+    - TR.Stride.Ocean - Ocean Water rendering
+    - TR.Stride.Terrain- Height Map Terrain
+    - TR.Stride.Gameplay - Manage save games
+- [UnrealMotion](https://github.com/ykafia/UnrealMotion) - Unreal engine motion blur for Stride
 
 ## Camera
-* [Camera controller](https://github.com/herocrab/StrideCameraController)
-* [XenkoByteSized](https://github.com/profan/XenkoByteSized) * Split Screen
-* [Stride3dSplitScreen](https://github.com/spasarto/Stride3dSplitScreen) * Another Split Screen
-* [StrideCameraController](https://github.com/herocrab/StrideCameraController) * Swapping Cameras/Resident Evil Style
-* [CameraFollow.cs](https://gist.github.com/ykafia/371b310de1ba7bb8ab3d2feffce2a190)
-* [SplitScreen](https://github.com/profan/XenkoByteSized#xenkobytesizedsplitscreen)
+- [Camera controller](https://github.com/herocrab/StrideCameraController)
+- [XenkoByteSized](https://github.com/profan/XenkoByteSized) - Split Screen
+- [Stride3dSplitScreen](https://github.com/spasarto/Stride3dSplitScreen) - Another Split Screen
+- [StrideCameraController](https://github.com/herocrab/StrideCameraController) - Swapping Cameras/Resident Evil Style
+- [CameraFollow.cs](https://gist.github.com/ykafia/371b310de1ba7bb8ab3d2feffce2a190)
+- [SplitScreen](https://github.com/profan/XenkoByteSized#xenkobytesizedsplitscreen)