Merge pull request #399 from stride3d/master

VaclavElias · web-flow · commit 03e21dd8481e · 2025-04-10T22:29:38.000+01:00
Deploy latest documentation updates to staging
diff --git a/en/contributors/documentation/major-release-workflow.md b/en/contributors/documentation/major-release-workflow.md
@@ -34,3 +34,5 @@ The `BuildDocs.ps1` script will manage the deployment to the `4.2` folder while
    - Update SDK version references
 1. Modify `manual\troubleshooting\stride-doesnt-run.md`
    - Update SDK version references
+1. Modify `manual\files-and-folders\distribute-a-game.md`
+   - Update SDK version references
diff --git a/en/manual/animation/additive-animation.md b/en/manual/animation/additive-animation.md
@@ -137,4 +137,4 @@ You can use additive animations with animations that use the same skeleton and s
 * [Animation scripts](animation-scripts.md)
 * [Procedural animation](procedural-animation.md)
 * [Custom blend trees](custom-blend-trees.md)
-* [custom attributes](custom-attributes.md)
+* [Custom attributes](custom-attributes.md)
diff --git a/en/manual/animation/animation-scripts.md b/en/manual/animation/animation-scripts.md
@@ -110,4 +110,4 @@ You can also override the animation blend tree and do all animation blending in
 * [Procedural animation](procedural-animation.md)
 * [Custom blend trees](custom-blend-trees.md)
 * [Model node links](model-node-links.md)
-* [custom attributes](custom-attributes.md)
+* [Custom attributes](custom-attributes.md)
diff --git a/en/manual/animation/custom-blend-trees.md b/en/manual/animation/custom-blend-trees.md
@@ -108,4 +108,4 @@ public class AnimationBlendTree : SyncScript, IBlendTreeBuilder
 * [Additive animation](additive-animation.md)
 * [Procedural animation](procedural-animation.md)
 * [Model node links](model-node-links.md)
-* [custom attributes](custom-attributes.md)
+* [Custom attributes](custom-attributes.md)
diff --git a/en/manual/animation/import-animations.md b/en/manual/animation/import-animations.md
@@ -63,4 +63,4 @@ To use an animation asset, add an [AnimationComponent](xref:Stride.Engine.Animat
 * [Procedural animation](procedural-animation.md)
 * [Custom blend trees](custom-blend-trees.md)
 * [Model node links](model-node-links.md)
-* [custom attributes](custom-attributes.md)
+* [Custom attributes](custom-attributes.md)
diff --git a/en/manual/animation/index.md b/en/manual/animation/index.md
@@ -53,4 +53,4 @@ The templates **First-person shooter**, **Third-person platformer** and **Top-do
 * [Procedural animation](procedural-animation.md)
 * [Custom blend trees](custom-blend-trees.md)
 * [Model node links](model-node-links.md)
-* [custom attributes](custom-attributes.md)
+* [Custom attributes](custom-attributes.md)
diff --git a/en/manual/animation/model-node-links.md b/en/manual/animation/model-node-links.md
@@ -10,16 +10,15 @@ The **model node link** component attaches an entity to a node of a skeleton on
 
 For example, imagine you have two models: a knight, and a sword. The character has a sword swinging animation. You can use a model link node to place the sword in the knight's hand and attach it to the correct node in the knight skeleton, so the sword swings with the knight animation.
 
-<p>
+<div class="ratio ratio-16x9 mb-3">
 <video autoplay loop class="responsive-video" poster="../particles/tutorials/media/sword-slash-1.jpg">
    <source src="../particles/tutorials/media/sword-slash-1.mp4" type="video/mp4">
 </video>
-</p>
+</div>
 
 ## Set up a model node link component
 
 1. In the **Scene Editor**, select the entity you want to link to a node in another entity.
-
 2. In the **Property Grid**, click **Add component** and select **Model node link**.
 
     ![Add component](../particles/tutorials/media/add-model-node-link.png)
@@ -38,11 +37,11 @@ For example, imagine you have two models: a knight, and a sword. The character h
 
 4. Select the model you want to link the entity to and click **OK**.
 
-    >[!Note]
-    >The entity you link to must have a model with a skeleton, even if the model isn't visible at runtime.
+    > [!Note]
+    > The entity you link to must have a model with a skeleton, even if the model isn't visible at runtime.
 
-    >[!Tip]
-    >If you don't specify a model, Stride links the entity to the model on the parent entity.
+    > [!Tip]
+    > If you don't specify a model, Stride links the entity to the model on the parent entity.
 
 5. In **Node name**, select the node in the model you want to attach this entity to.
 
@@ -58,8 +57,43 @@ To add an offset to the linked entity, use the entity's [TransformComponent](xre
 
 ![Transform](media/transform-component.png)
 
->[!Note]
->If you don't want to add an offset, make sure the values are all set to `0,0,0`.
+> [!Note]
+> If you don't want to add an offset, make sure the values are all set to `0,0,0`.
+
+## Example script
+
+This script demonstrates how to link one entity (such as a `SwordModel`) to a specific bone (`weapon_bone_R`) in another entity's skeleton hierarchy (in this case, the `mannequinModel`) using Stride's `ModelNodeLinkComponent`.
+
+```csharp
+public class BoneLink : StartupScript
+{
+    // This example assumes you've created a project with the default Stride models
+    // "mannequinModel" and "SwordModel." Add them from the "Assets/Models" folder to your scene,
+    // and then attach this script to the "SwordModel" entity
+
+    ModelNodeLinkComponent boneLink;
+
+    public override void Start()
+    {
+        // Initialize the script
+        // Here we locate the entity named "mannequinModel" by searching the root scene's entities
+        Entity owner = SceneSystem.SceneInstance.RootScene.Entities.Where(e => e.Name == "mannequinModel").Single();
+
+        boneLink = new ModelNodeLinkComponent
+        {
+             // This is the ModelComponent on the target entity (mannequinModel)
+            Target = owner.Get<ModelComponent>(),
+
+            // We set a "hard link" to Nodes[70], which corresponds to "weapon_bone_R"
+            // in the target's skeleton hierarchy
+            NodeName = owner.Get<ModelComponent>().Model.Skeleton.Nodes[70].Name
+        };
+
+        // Finally, add this link component to our current (SwordModel) entity
+        base.Entity.Components.Add(boneLink);
+    }
+}
+```
 
 ## See also
 
@@ -71,7 +105,7 @@ To add an offset to the linked entity, use the entity's [TransformComponent](xre
 * [Additive animation](additive-animation.md)
 * [Procedural animation](procedural-animation.md)
 * [Custom blend trees](custom-blend-trees.md)
-* [custom attributes](custom-attributes.md)
+* [Custom attributes](custom-attributes.md)
 
 For examples of how model node links are used, see:
 
diff --git a/en/manual/animation/preview-animations.md b/en/manual/animation/preview-animations.md
@@ -48,4 +48,4 @@ The animation preview uses the model selected in the **preview model** in the **
 * [Procedural animation](procedural-animation.md)
 * [Custom blend trees](custom-blend-trees.md)
 * [Model node links](model-node-links.md)
-* [custom attributes](custom-attributes.md)
+* [Custom attributes](custom-attributes.md)
diff --git a/en/manual/animation/procedural-animation.md b/en/manual/animation/procedural-animation.md
@@ -139,4 +139,4 @@ public class AnimationLight : StartupScript
 * [Additive animation](additive-animation.md)
 * [Custom blend trees](custom-blend-trees.md)
 * [Model node links](model-node-links.md)
-* [custom attributes](custom-attributes.md)
+* [Custom attributes](custom-attributes.md)
diff --git a/en/manual/animation/set-up-animations.md b/en/manual/animation/set-up-animations.md
@@ -55,13 +55,13 @@ After you add animations to an entity, you need to play them with a [script](../
 ### Example script
 
 ```cs
-    public class SimpleAnimationScript : StartupScript
+public class SimpleAnimationScript : StartupScript
+{
+    public override void Start()
     {
-        public override void Start()
-        {
-            Entity.Get<AnimationComponent>().Play("Walk");
-        }
+        Entity.Get<AnimationComponent>().Play("Walk");
     }
+}
 ```
 
 This script looks for an animation with the name *Walk* under the animation component on the entity.
@@ -93,4 +93,4 @@ Game Studio adds the script as a component. You can adjust [public variables you
 * [Procedural animation](procedural-animation.md)
 * [Custom blend trees](custom-blend-trees.md)
 * [Model node links](model-node-links.md)
-* [custom attributes](custom-attributes.md)
+* [Custom attributes](custom-attributes.md)
diff --git a/en/manual/files-and-folders/distribute-a-game.md b/en/manual/files-and-folders/distribute-a-game.md
@@ -14,49 +14,76 @@ When you're ready to publish your game, create a release build from Visual Studi
 
     Your project opens in Visual Studio.
 
-4. In Visual Studio, from the **Solution Configurations** drop-down menu, select **Release**.
+4. In Visual Studio, from the **Solution Explorer** right click your Windows project and select **Publish**
 
-    ![Select release](media/select-release.png)
+    ![Select Publish](media\publish-project-dropdown.png)
 
-5. From the **Solution platforms** drop-down menu, select the platform you want to create a build for.
+5. Select the **Target** **Folder** in the publish window.
 
-    ![Select platform](media/select-platform.png)
+6. Select the **Specified target** **Folder** again.
 
-    >[!Note]
+7. Confirm the output folder and Click **Finish**.
+
+8. You should now see the **Publish** view where you can manage the project export settings.
+
+    ![Publish View](media\publish-view.png)
+
+9. Finally you can click publish and see your project in the output folder you selected at **step 6**
+
+    Optionally you can also include the .NET runtime in your exported game to reduce a dependancy on the user.
+
+    Select **Show all settings** -> **Deployment mode** -> **Self-contained** -> **Save**
+
+    ![Publish Self Contained](media\publish-self-contained.png)
+
+    > [!Note]
     >
-    >You can only build for platforms you've added to your Stride project. For instructions about how to do this, see [Add or remove a platform](../platforms/add-or-remove-a-platform.md).
+    > You can only build for platforms you've added to your Stride project. For instructions about how to do this, see [Add or remove a platform](../platforms/add-or-remove-a-platform.md).
     >
-    >To build for Android or iOS, you need Xamarin, which is included with Visual Studio licenses. For instructions about how to install Xamarin with Visual Studio 2017, see [this MSDN page](https://docs.microsoft.com/en-us/visualstudio/cross-platform/setup-and-install).
+    > To build for Android or iOS, you need Xamarin, which is included with Visual Studio licenses. For instructions about how to install Xamarin with Visual Studio 2017, see [this MSDN page](https://docs.microsoft.com/en-us/visualstudio/cross-platform/setup-and-install).
 
-6. Under **Build**, select **Build solution**.
+10. Under **Build**, select **Publish Selection** and click the **Publish** button.
 
-    ![Build solution](media/build-solution.png)
+    ![Publish Solution](media/publish-project.png)
 
-    Visual Studio creates a release build in your project bin folder (eg *MyGame/Bin/MyPlatform/Release*).
+    Visual Studio creates a release build in your selected output folder.
 
 > [!Tip]
 > You might want to rename the **Release** folder to something more descriptive (such as the title of your game).
 
 ### To build using terminal instead of Visual Studio
 
- 1. You would need to install Visual Studio to get **Developer Command Prompt for Visual Studio (Version)**
- 2. In Developer Command Prompt for Visual Studio
- 3. ```console
-    C:\User> msbuild PathToSln\NameOfProject.sln /p:Configuration=Release /p:OutputPath=YourPreferredPath
+ 1. Ensure the relevant .NET SDK is installed (Stride 4.2 is on .NET 8)
+ 2. Open the folder of your project where the `*.Windows.csproj` file sits.
+
+    ![Project Folder](media/project-folder.png)
+
+ 3. Type `cmd` in the search bar to open the folder easily in terminal.
+    
+    ![Open terminal](media/open-terminal.png)
+
+ 4. Finally publish with the command 
+ 
+    ```
+    dotnet publish
     ```
 
+    or the below to include the .NET runtime with your game
+
+    ```
+    dotnet publish -r win-x64 --self-contained  true --  framework net8.0-windows
+    ```
+ 
+    You can also append `--output <YOUR_EXPORT_FOLDER>` to specify where to export to.
+
 ## 2. Delete unnecessary files
 
 In the release folder in your project bin folder (eg *MyGame/Bin/MyPlatform/Release*), you can delete the following unnecessary files:
 
 * `.pdb` files (debug information)
-
 * `.xml` files (API documentation)
-
 * files that contain `vshost` in their filenames (eg `MyGame5.vshost.exe` and `MyGame5.vshost.exe.manifest`) 
-
 * folders other than the `x64`, `x86`, or `data` folders
-
 * other unnecessary files, such as custom configuration files (ie files not created with Stride)
 
 ## 3. Distribute your game
@@ -65,14 +92,13 @@ After you create a release build, how you distribute it is up to you.
 
 To run games made with Stride on Windows, users need:
 
-* .NET 8 SDK
-
+* .NET 8 Runtime (Unless you published with **self-contained**)
 * DirectX11 (included with Windows 10 and later), OpenGL, or Vulkan
-
 * Visual C++ 2015 runtimes (x86 and/or x64, depending on what you set in your project properties in Visual Studio)
 
 ## See also
 
 * [Add or remove a platform](../platforms/add-or-remove-a-platform.md)
 * [Version control](version-control.md)
 * [Project structure](project-structure.md)
+* [Microsoft documentation](https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-publish)
diff --git a/en/manual/files-and-folders/media/open-terminal.png b/en/manual/files-and-folders/media/open-terminal.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:f158992cde6c16fb30b63c1da1e92eba78366a668c2efe6c088ae51c84a2c69e
+size 33230
diff --git a/en/manual/files-and-folders/media/project-folder.png b/en/manual/files-and-folders/media/project-folder.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6ce8e4c330378468774745bfd56ca93f7048bef01484b03784650f023ac3c08d
+size 40745
diff --git a/en/manual/files-and-folders/media/publish-project-dropdown.png b/en/manual/files-and-folders/media/publish-project-dropdown.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:135be0d052d1f6c9a904c67baf7c994286e99eb25f306d1f4f9ec2724d90c812
+size 22583
diff --git a/en/manual/files-and-folders/media/publish-project.png b/en/manual/files-and-folders/media/publish-project.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:de68e02cb3e24c4d9d701552ef55d5dd01d7af0faa2f7e151f185803e1cb74a5
+size 33082
diff --git a/en/manual/files-and-folders/media/publish-self-contained.png b/en/manual/files-and-folders/media/publish-self-contained.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4d9a4dfd41bb58ac32605ca66d6f6179bc21e7b6422a59db8128530a85c2eda6
+size 35056
diff --git a/en/manual/files-and-folders/media/publish-view.png b/en/manual/files-and-folders/media/publish-view.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:45b5f3440cfcfd29c9bbb53669fcd72ab382693f23ac901ccd5b1314bdf53ed0
+size 18383
diff --git a/en/manual/game-studio/prefabs/nested-prefabs.md b/en/manual/game-studio/prefabs/nested-prefabs.md
@@ -11,11 +11,11 @@ If you modify a nested prefab, all the dependent prefabs inherit the change auto
 
 This video demonstrates an example of nested prefabs:
 
-<p>
+<div class="ratio ratio-16x9 mb-3">
 <video autoplay loop class="responsive-video" poster="media/create-nested-prefab.jpg">
    <source src="media/create-nested-prefab.mp4" type="video/mp4">
 </video>
-</p>
+</div>
 
 In the center pane, we already have a prefab named **Lamp**. In the right pane, we create a new prefab named **Boxes**, comprising several box entities positioned together. We add the Boxes prefab to the Lamp prefab. Changes made to the Boxes prefab are reflected in the Lamp prefab. These are in turn reflected in the instances of the Lamp prefab in the scene (left pane).
 
diff --git a/en/manual/game-studio/prefabs/override-prefab-properties.md b/en/manual/game-studio/prefabs/override-prefab-properties.md
@@ -12,11 +12,11 @@ In the following video, the **Lamp** prefab contains several box entities that b
 
 If we add another box to the **Boxes** parent in the prefab, it doesn't appear in the overridden instance. That's because we deleted the **Boxes** parent from that instance.
 
-<p>
+<div class="ratio ratio-16x9 mb-3">
 <video autoplay loop class="responsive-video" poster="media/delete-boxes-from-prefab-instance.jpg">
    <source src="media/delete-boxes-from-prefab-instance.mp4" type="video/mp4">
 </video>
-</p>
+</div>
 
 ## View overridden properties
 
diff --git a/en/manual/graphics/materials/materials-for-developers.md b/en/manual/graphics/materials/materials-for-developers.md
@@ -13,9 +13,28 @@ This diagram shows the Material interfaces and implementation classes:
 - The @'Stride.Rendering.Materials.MaterialDescriptor' is the editor-time description of the material before being compiled into a material shader.
 - The @'Stride.Rendering.Material' class is the runtime material shader generated from the @'Stride.Rendering.Materials.MaterialDescriptor'
 
+# Modifying parameters at runtime
+
+The file @'Stride.Rendering.Materials.MaterialKeys' contains most material keys you might need to use, have a look through it to figure out which one you might need to get to modify the parameter you are interested in.
+
+Let's say you have this fairly simple material
+![media/runtime-param-modif-ex.png](media/runtime-param-modif-ex.png)
+
+And you want to clone that material, but change its color to red at runtime.
+Searching through the different keys contained in @'Stride.Rendering.Materials.MaterialKeys' you would find `MaterialKeys.DiffuseValue` and use it as the key to set the new color value you want:
+```csharp
+var clone = SerializerExtensions.Clone(MyMaterial);
+clone.Passes[0].Parameters.Set(MaterialKeys.DiffuseValue, new Color4(1, 0, 0));
+```
+
+If you aren't too sure which parameter keys your material uses, the best way to figure it out would be to inspect the material's variables with a debugger. 
+Here's an example of that through Rider's *Threads & Variables* window:
+
+![media/runtime-param-modif-locals.png](media/runtime-param-modif-locals.png)
+
 ## See also
 
 - [Material maps](material-maps.md)
 - [Material attributes](material-attributes.md)
 - [Material layers](material-layers.md)
-* [Material slots](material-slots.md)
+- [Material slots](material-slots.md)
diff --git a/en/manual/graphics/materials/media/runtime-param-modif-ex.png b/en/manual/graphics/materials/media/runtime-param-modif-ex.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:bf507484386e59077fe3ce5158558b30f638edadf20401da2d571d7f8279346b
+size 19221
diff --git a/en/manual/graphics/materials/media/runtime-param-modif-locals.png b/en/manual/graphics/materials/media/runtime-param-modif-locals.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a92fa951002c8cceae555a212d0c167e1bad4e99720b96408588593d2064512f
+size 97890
diff --git a/en/manual/index.md b/en/manual/index.md
diff --git a/en/manual/navigation/index.md b/en/manual/navigation/index.md
diff --git a/en/manual/particles/ribbons-and-trails.md b/en/manual/particles/ribbons-and-trails.md
diff --git a/en/manual/physics/create-a-bouncing-ball.md b/en/manual/physics/create-a-bouncing-ball.md
diff --git a/en/manual/physics/script-a-trigger.md b/en/manual/physics/script-a-trigger.md
diff --git a/en/manual/scripts/best-practice.md b/en/manual/scripts/best-practice.md
diff --git a/en/manual/scripts/create-a-model-from-code.md b/en/manual/scripts/create-a-model-from-code.md
diff --git a/en/manual/sprites/use-sprites.md b/en/manual/sprites/use-sprites.md
