Merge pull request #389 from VaclavElias/update-29-manual-model-node-example

feat: Example snippet added - Link entity to a bone, various content and styling updates

Author: VaclavElias

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)

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)

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)

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)

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)

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:
 

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)

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)

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)

en/manual/files-and-folders/distribute-a-game.md

@@ -54,40 +54,36 @@ When you're ready to publish your game, create a release build from Visual Studi
 ### To build using terminal instead of Visual Studio
 
  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.
+ 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 
+ 4. Finally publish with the command 
 
- ```
- dotnet publish
- ```
+    ```
+    dotnet publish
+    ```
 
- or the below to include the .NET runtime with your game
+    or the below to include the .NET runtime with your game
 
- ```
- dotnet publish -r win-x64 --self-contained true --framework net8.0-windows
- ```
+    ```
+    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.
+    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
@@ -97,15 +93,12 @@ 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 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)