Skip to content

Commit e811483

Browse files
VaclavEliasVaclavElias
authored
Merge pull request #474 from stride3d/master
Deploy latest documentation updates to staging
2 parents 4329966 + 5243d1b commit e811483

30 files changed

Lines changed: 476 additions & 344 deletions

‎.github/workflows/stride-docs-github.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,12 +80,12 @@ jobs:
8080
#run: dotnet tool update -g docfx --version 2.78.3
8181

8282
- name: Build documentation
83-
run: ./build-all.bat
83+
run: ./build-all-skip-pdf.bat
8484
working-directory: ${{ env.DOCS_PATH }}
8585

8686
- name: Deploy
8787
uses: peaceiris/actions-gh-pages@v4
8888
with:
8989
github_token: ${{ secrets.GITHUB_TOKEN }}
9090
publish_dir: ${{ env.DOCS_PATH }}/_site
91-
publish_branch: gh-pages
91+
publish_branch: gh-pages

‎build-all-skip-pdf.bat‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
PowerShell.exe -NoProfile -ExecutionPolicy Bypass -Command "& './BuildDocs.ps1' -BuildAll -SkipPdfBuilding; exit $LastExitCode"
2+
if %errorlevel% neq 0 exit /b %errorlevel%

‎en/community-resources/ai-and-pathfinding.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# 🤖 AI and Pathfinding
2+
3+
## Libraries
4+
5+
- [Doprez.Stride.AI](https://github.com/Doprez/Doprez.Stride.AI) - FSM and GOAP AI library built for the Stride engine
6+
- [Bepu Navigation](https://github.com/Nicogo1705/Stride.BepuPhysics/tree/master/Stride.BepuPhysics.Navigation) - Pathfinding for Bepu physics using [DotRecast](https://github.com/ikpil/DotRecast), a .NET port of Recast/Detour
7+
8+
## Examples
9+
10+
- [Stride-npc](https://github.com/Doprez/stride-npc) - Basic finite state machine example for NPC behaviour using entity processors
11+
- [Stride-goap](https://github.com/Doprez/stride-goap) - Simple goal-oriented action planning (GOAP) for agents, powered by MountainGoap
12+
- [Pathfinding With Entity Processors](https://github.com/Doprez/stride-pathfinding-demo) - Pathfinding demo wiring navigation logic through Stride's entity processor system

‎en/community-resources/audio.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# 🔊 Audio
2+
3+
## Libraries and Integrations
4+
5+
- [XenkoByteSized - Audio Examples](https://github.com/profan/XenkoByteSized) - Byte-sized example projects including FMOD-style audio integration patterns
6+
- [BeatDetection](https://github.com/manio143/BeatDetection) - Analyses live audio input to detect beats and rhythm for gameplay synchronisation
7+
8+
## Examples and Snippets
9+
10+
- [Playing audio from code](https://doc.stride3d.net/latest/en/manual/audio/non-spatialized-audio.html) - Official Stride docs covering how to play sounds and music at runtime

‎en/community-resources/coding.md‎

Lines changed: 15 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,27 @@
22

33
## Code Only
44

5-
- [CodeOnlySample](https://github.com/xen2/Xenko.CodeOnlySample) - Sample project with code only
6-
- [XenkoWindowFromCode](https://github.com/microdee/xenko-window-from-code) - Launch a game window from code only
5+
- [CodeOnlySample](https://github.com/xen2/Xenko.CodeOnlySample) - Minimal Stride project demonstrating a fully code-driven setup with no editor assets
6+
- [XenkoWindowFromCode](https://github.com/microdee/xenko-window-from-code) - Creates and launches a Stride game window entirely from code without the editor
77

8-
## Networking
8+
## Entity Component System
99

10-
- [ClientServerSample](https://github.com/Ethereal77/Stride.ClientServerSample) - Headless server (Physics only, no game tick loop)
11-
- [Stride.Networking.Simple](https://github.com/manio143/Stride.Networking.Simple) - Asynchronous NetworkScript example for client-server communication
12-
- [ET-Stride: A networking framework based on Stride and ET](https://github.com/ly3027929699/ET-Stride)
13-
- [GalaxyCore: Network Solution for Unity, Stride, Xenko, Unigine](https://github.com/defraswiew/GalaxyCore)
14-
- [Regulus.Remote: A simple C# network library.](https://github.com/jiowchern/Regulus.Remote)
15-
- [Lite Entity System](https://github.com/RevenantX/LiteEntitySystem)
16-
- [MUD framework for Stride](https://github.com/JoseJohnen/MUD_SKELETON/tree/main)
17-
- [Running Stride headless client/server](https://github.com/Ethereal77/Stride.ClientServerSample)
10+
- [Entity Processor Example](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/EntityProcessorExample) - Shows how to create a custom entity component paired with a matching processor
11+
- [Stride-npc](https://github.com/Doprez/stride-npc) - Basic finite state machine example for NPC behaviour using entity processors
12+
- [Stride-goap](https://github.com/Doprez/stride-goap) - Simple goal-oriented action planning (GOAP) for agents using MountainGoap
13+
- [Svelto ECS Mini Examples](https://github.com/sebas77/Svelto.MiniExamples) - Collection of small projects showing Svelto ECS patterns including a Stride demo
14+
- [Using Entity Processors for Scene Editor Plugins](https://github.com/Doprez/lod-example) - Demonstrates LOD and how entity processors integrate with the scene editor
15+
- [Pathfinding With Entity Processors](https://github.com/Doprez/stride-pathfinding-demo) - Pathfinding demo wiring navigation logic through Stride's entity processor system
16+
- [Arch ECS Integrated into Stride](https://github.com/Doprez/stride-arch-ecs#add-arch-components-in-strides-editor) - Integrates the high-performance Arch ECS library with the Stride editor workflow
1817

19-
## Entity Component System
18+
## ECS Articles
2019

21-
- [Entity Processor Example](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/EntityProcessorExample) - Custom Entity Component + Processor
22-
- Libraries
23-
- [Doprez.Stride.AI: FSM and GOAP library for Stride](https://github.com/Doprez/Doprez.Stride.AI)
24-
- [Bepu Navigation](https://github.com/Nicogo1705/Stride.BepuPhysics/tree/master/Stride.BepuPhysics.Navigation) using [DotRecast](https://github.com/ikpil/DotRecast)
25-
- Articles
26-
- [Svelto Abstraction from OOP](https://www.sebaslab.com/ecs-abstraction-layers-and-modules-encapsulation/)
27-
- [Svelto Doofuses example](https://www.sebaslab.com/svelto-ecs-3-3-and-the-new-filters-api/#:~:text=shiny%20new%20Doofuses%20Stride%20example.)
28-
- [Svelto Turret example](https://www.sebaslab.com/svelto-miniexample-7-stride-engine-demo/)
29-
- Repositories
30-
- [Stride-npc: A basic example of a Finite State Machine](https://github.com/Doprez/stride-npc)
31-
- [Stride-goap: a very simple implementation of GOAP using MountainGoap](https://github.com/Doprez/stride-goap)
32-
- [Svelto ECS mini examples](https://github.com/sebas77/Svelto.MiniExamples)
33-
- [Using Entity Processors for Scene Editor Plugins](https://github.com/Doprez/lod-example)
34-
- [Pathfinding With Entity Processors](https://github.com/Doprez/stride-pathfinding-demo)
35-
- [Arch ECS integrated into Stride](https://github.com/Doprez/stride-arch-ecs#add-arch-components-in-strides-editor)
20+
- [Svelto Abstraction from OOP](https://www.sebaslab.com/ecs-abstraction-layers-and-modules-encapsulation/) - Article on ECS abstraction layers, modules, and encapsulation patterns
21+
- [Svelto Doofuses Stride Example](https://www.sebaslab.com/svelto-ecs-3-3-and-the-new-filters-api/#:~:text=shiny%20new%20Doofuses%20Stride%20example.) - Demonstrates Svelto ECS 3.3 filters API with a Stride-based Doofuses sample
22+
- [Svelto Turret Stride Demo](https://www.sebaslab.com/svelto-miniexample-7-stride-engine-demo/) - Mini ECS example building a turret game mechanic in Stride using Svelto
3623

3724
## Development Tools
25+
3826
- [HS-Stride-Dev-Console](https://github.com/Keepsie/HS-Stride-Dev-Console) - In-game developer console for runtime commands, scripts, and debugging
3927
- [HS-Stride-Live-Dev-Editor](https://github.com/Keepsie/HS-Stride-Live-Dev-Editor) - Runtime entity editing with transform manipulation and scene browser
4028
- [HS-Stride-Engine-Core](https://github.com/Keepsie/HS-Stride-Engine-Core) - Unity-style foundation library with familiar lifecycle methods and helpers

‎en/community-resources/embedded-stride.md‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,16 @@
11
# 🔌 Embedding and Integration
22

3-
- Project examples
4-
- [Stride in Ultralight Blazor](https://github.com/lionfire/LionFire.Stride.Ultralight)
5-
- [Stride in WinForms](https://github.com/windperson/-StrideGameNet5WinFormsDemo)
6-
- Code blobs
7-
- [Stride in WPF Control](https://gist.github.com/EricEzaM/5797be1f4b28f15e9be53287a02d3d67)
8-
- [Stride in Avalonia Control](https://gist.github.com/westonsoftware/a3fa982397fe1817ece4a27d3cbc5a89)
9-
- VVVV integration
10-
- [3D rendering documentation](https://thegraybook.vvvv.org/reference/libraries/graphics-3d.html)
11-
- [Stride integration source code on GitHub](https://github.com/vvvv/VL.StandardLibs)
3+
## Project Examples
4+
5+
- [Stride in Ultralight Blazor](https://github.com/lionfire/LionFire.Stride.Ultralight) - Embeds Stride rendering inside an Ultralight-powered Blazor desktop app
6+
- [Stride in WinForms](https://github.com/windpiper/-StrideGameNet5WinFormsDemo) - Demo project running a Stride game inside a .NET 5 WinForms window
7+
8+
## Code Snippets
9+
10+
- [Stride in WPF Control](https://gist.github.com/EricEzaM/5797be1f4b28f15e9be53287a02d3d67) - Gist showing how to host a Stride viewport inside a WPF user control
11+
- [Stride in Avalonia Control](https://gist.github.com/westonsoftware/a3fa982397fe1817ece4a27d3cbc5a89) - Gist embedding Stride rendering into an Avalonia UI control
12+
13+
## VVVV Integration
14+
15+
- [VVVV 3D Rendering Documentation](https://thegraybook.vvvv.org/reference/libraries/graphics-3d.html) - Official vvvv documentation covering 3D rendering via the Stride backend
16+
- [VL.StandardLibs - Stride Integration Source](https://github.com/vvvv/VL.StandardLibs) - Source code for vvvv's standard library including the full Stride rendering integration

‎en/community-resources/engine.md‎

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
1-
# Engine Documentation
2-
3-
- [Custom Root Renderer](https://github.com/tebjan/Stride.CustomRootRenderFeature)
4-
- [Compiling Stride for Linux](https://www.youtube.com/watch?v=BoHEASoQvu8)
5-
- [Experimental mini Stride.Editor in Avalonia](https://github.com/manio143/StrideComponentsEditorAvalonia)
6-
- [Stride Editor current design document](https://gist.github.com/manio143/b6666eedb1403deb5525961697d0c25d)
7-
- [Stride docs shader stages](https://github.com/stride3d/stride-docs/blob/master/en/manual/graphics/effects-and-shaders/shading-language/shader-stages.md/)
8-
- [Strideui discussion](https://gist.github.com/manio143/8706b4bad5f7db5402d3b81acbb6276e)
9-
- [Stride Game Engine Extension for code only approach](https://github.com/VaclavElias/stride-code-only)
1+
# 🔧 Engine
2+
3+
## Editor Extensions and Tooling
4+
5+
- [StrideComponentsEditorAvalonia](https://github.com/manio143/StrideComponentsEditorAvalonia) - Experimental prototype of a Stride editor built with Avalonia UI
6+
- [Stride Editor Design Document](https://gist.github.com/manio143/b6666eedb1403deb5525961697d0c25d) - Community design notes outlining the architecture for a future Stride editor
7+
- [Stride UI Discussion](https://gist.github.com/manio143/8706b4bad5f7db5402d3b81acbb6276e) - Community discussion thread exploring StrideUI design and layout approaches
8+
- [stride-code-only](https://github.com/VaclavElias/stride-code-only) - Extension library for building Stride games entirely in code, without the editor
9+
10+
## Rendering Internals
11+
12+
- [Stride.CustomRootRenderFeature](https://github.com/tebjan/Stride.CustomRootRenderFeature) - Example showing how to implement a custom root render feature for advanced rendering pipelines
13+
14+
## Source References
15+
16+
- [Stride Shader Stages Documentation](https://github.com/stride3d/stride-docs/blob/master/en/manual/graphics/effects-and-shaders/shading-language/shader-stages.md/) - Official reference for vertex, pixel, geometry, and compute shader stages in Stride
17+
18+
## Building and Compiling
19+
20+
- [Compiling Stride for Linux](https://www.youtube.com/watch?v=BoHEASoQvu8) - Video walkthrough of building Stride from source with Vulkan support on Linux

‎en/community-resources/example-projects.md‎

Lines changed: 51 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,55 @@
1-
# Example projects
2-
3-
## Input
4-
* [Control - Input Manager](https://github.com/rsptim1/Ctrl)
5-
* [Easier input binding configuration](https://github.com/lparkermg/LPSoft.Stride.InputExtensions)
6-
* [Demos with a focus on Code-Only approach](https://github.com/najak3d/Stride3D_Demos)
1+
# ⚙️ Example Projects
72

83
## Editor
9-
* [Custom Editor Gizmos](https://github.com/gearsin/Stride.Demo.Gizmo/tree/master)
4+
5+
- [Stride.Demo.Gizmo](https://github.com/gearsin/Stride.Demo.Gizmo/tree/master) - Example project demonstrating custom editor gizmos in the Stride GameStudio
106

117
## Scene
12-
* [Load Scenes in parallel](https://github.com/julyfortoday/StrideParallelScenes)
13-
* [Export/save a scene or a group of entities within a running stride game](https://gist.github.com/Eideren/0aa59644eb7c5b029d04b7fa5a285e62)
14-
15-
## Code blobs
16-
* [Stride C# gists search](https://gist.github.com/search?l=c%23&q=stride)
17-
* [Look at script](https://gist.github.com/ykafia/9579569c26e2724f1a35afab0449b72a)
18-
* [Smooth follow](https://gist.github.com/Doprez/e146f8d30b7e9cea05de138d4e3a30f0)
19-
* [Smooth Rotation](https://gist.github.com/Doprez/5bd571341b075c5cf257d7265c374807)
20-
* [Stride 3rd person controller](https://pastebin.com/4nFbabkZ)
21-
* [Quake 3 movement for Stride3D](https://github.com/Redhacker1/Q3MovementStride)
22-
23-
24-
## Other
25-
* [Proof of Concepts](https://github.com/Basewq/XenkoProofOfConcepts)
26-
* [Cutscene Timeline](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/CutsceneTimelineExample)
27-
* [Text Control](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/DialogueTextControlExample)
28-
* [Entity Processor](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/EntityProcessorExample)
29-
* [Game Screen Manager](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/GameScreenManagerExample)
30-
* [Level Editor Extensions](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/LevelEditorExtensionExample)
31-
* [Multiplayer](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/MultiplayerExample)
32-
* [Object Info Renderer](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/ObjectInfoRenderTargetExample)
33-
* [Screen Space Decals](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/ScreenSpaceDecalExample)
34-
* [Screen Space Decals With Root Renderer](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/ScreenSpaceDecalRootRendererExample)
35-
* [Source generation](https://github.com/johang88/StrideSourceGeneratorTest)
36-
* [Stride config example](https://github.com/johang88/StrideConfigurationReference)
37-
* [Sound detection in Stride](https://github.com/manio143/BeatDetection)
38-
* [StrideVoxelScape](https://github.com/Jarb2104/StrideVoxelScape_v0.1)
39-
* [Stride3D examples in .NET 5 using C# 9.0 or .NET 6 using C# 10](https://github.com/VaclavElias/Stride3DTutorials)
40-
* [Tweening library](https://github.com/JoshFlash/ZenTween)
41-
* [Tessellation](https://github.com/johang88/Stride-Tessellation)
42-
* [Workshop creating a game with Stride](https://github.com/manio143/StrideIntroWorkshopNode20/tree/main)
43-
* [Xenko/Stride byte-sized project examples](https://github.com/profan/XenkoByteSized)
44-
45-
46-
### Old projects
47-
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.
48-
49-
* [A Minecraft-style game](https://github.com/NckHmml/ParadoxCraft)
50-
* [Xenko Voxel Scape](https://github.com/Doprez/stride-voxelscape)
51-
* [Stride Voxel Scape](https://github.com/Jarb2104/StrideVoxelScape_v0.1)
52-
* [Video demo](https://www.youtube.com/watch?v=whJOtux2DrQ)
53-
* [Xenko Live Editor](https://github.com/treplogle/XenkoLiveEditor)
54-
* [New Stride version](https://github.com/tebjan/StrideLiveEditor)
55-
* [Voxel GI example](https://github.com/WhyPenguins/XenkoVoxelGI)
8+
9+
- [StrideParallelScenes](https://github.com/julyfortoday/StrideParallelScenes) - Demonstrates how to load multiple Stride scenes in parallel at runtime
10+
- [Export/Save Entities at Runtime](https://gist.github.com/Eideren/0aa59644eb7c5b029d04b7fa5a285e62) - Gist showing how to export or save a scene or entity group from a running game
11+
12+
## Code Snippets
13+
14+
- [Stride C# Gists Search](https://gist.github.com/search?l=c%23&q=stride) - Browse all community C# gists tagged with Stride on GitHub
15+
- [Look At Script](https://gist.github.com/ykafia/9579569c26e2724f1a35afab0449b72a) - Simple gist making an entity rotate to always face a target
16+
- [Smooth Follow](https://gist.github.com/Doprez/e146f8d30b7e9cea05de138d4e3a30f0) - Gist for smoothly interpolating an entity's position toward a target
17+
- [Smooth Rotation](https://gist.github.com/Doprez/5bd571341b075c5cf257d7265c374807) - Gist for smooth rotational interpolation between two orientations
18+
- [Third Person Controller](https://pastebin.com/4nFbabkZ) - Pastebin snippet for a basic Stride third-person character controller
19+
- [Quake 3 Movement for Stride3D](https://github.com/Redhacker1/Q3MovementStride) - Quake 3 style air-strafing and movement physics implemented in Stride
20+
21+
## Proof of Concepts
22+
23+
- [XenkoProofOfConcepts](https://github.com/Basewq/XenkoProofOfConcepts) - Large collection of focused proof-of-concept projects covering many Stride subsystems
24+
- [Cutscene Timeline](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/CutsceneTimelineExample) - Timeline-driven cutscene playback system
25+
- [Text Control](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/DialogueTextControlExample) - Custom dialogue text control with typewriter effect
26+
- [Entity Processor](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/EntityProcessorExample) - Custom entity component and processor pair
27+
- [Game Screen Manager](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/GameScreenManagerExample) - Screen/state manager for menus and game screens
28+
- [Level Editor Extensions](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/LevelEditorExtensionExample) - Custom property editors and tools inside the GameStudio
29+
- [Multiplayer](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/MultiplayerExample) - Basic multiplayer networking example
30+
- [Object Info Renderer](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/ObjectInfoRenderTargetExample) - Renders per-object data to a dedicated render target
31+
- [Screen Space Decals](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/ScreenSpaceDecalExample) - Screen-space projected decal system
32+
- [Screen Space Decals With Root Renderer](https://github.com/Basewq/XenkoProofOfConcepts/tree/master/ScreenSpaceDecalRootRendererExample) - Screen-space decals using a custom `RootRenderFeature`
33+
34+
## Other Examples
35+
36+
- [StrideSourceGeneratorTest](https://github.com/johang88/StrideSourceGeneratorTest) - Experiment integrating C# source generators into a Stride project
37+
- [StrideConfigurationReference](https://github.com/johang88/StrideConfigurationReference) - Example showing how to use Stride's built-in configuration system
38+
- [BeatDetection](https://github.com/manio143/BeatDetection) - Analyses live audio input to detect beats, usable for rhythm-based gameplay
39+
- [StrideVoxelScape](https://github.com/Jarb2104/StrideVoxelScape_v0.1) - Voxel landscape rendering and generation demo built in Stride
40+
- [Stride3DTutorials](https://github.com/VaclavElias/Stride3DTutorials) - Stride 3D example projects targeting .NET 5/6 with C# 9/10
41+
- [ZenTween](https://github.com/JoshFlash/ZenTween) - Lightweight tweening library for animating values and transforms in Stride
42+
- [Stride-Tessellation](https://github.com/johang88/Stride-Tessellation) - Example demonstrating GPU tessellation shaders in Stride
43+
- [StrideIntroWorkshopNode20](https://github.com/manio143/StrideIntroWorkshopNode20/tree/main) - Workshop project for learning Stride by building a small game from scratch
44+
- [XenkoByteSized](https://github.com/profan/XenkoByteSized) - Collection of bite-sized Stride/Xenko example scenes covering many common patterns
45+
46+
## Old Projects
47+
48+
> [!NOTE]
49+
> These projects were built for older versions of Stride (formerly Xenko or Paradox) and will require significant rework to run on Stride 4.x.
50+
51+
- [ParadoxCraft](https://github.com/NckHmml/ParadoxCraft) - Minecraft-style voxel game built with the Paradox engine
52+
- [Xenko Voxel Scape](https://github.com/Doprez/stride-voxelscape) - Voxel landscape prototype from the Xenko era
53+
- [Stride Voxel Scape](https://github.com/Jarb2104/StrideVoxelScape_v0.1) - Updated voxel scape project — [video demo](https://www.youtube.com/watch?v=whJOtux2DrQ)
54+
- [XenkoLiveEditor](https://github.com/treplogle/XenkoLiveEditor) - Original Xenko live editor — [updated Stride version](https://github.com/tebjan/StrideLiveEditor) by tebjan
55+
- [XenkoVoxelGI](https://github.com/WhyPenguins/XenkoVoxelGI) - Voxel global illumination prototype from the Xenko era

0 commit comments

Comments
 (0)