Ver Fonte

Merge pull request #235 from stride3d/master

Initiating deployment of latest docs updates to staging
Vaclav Elias há 1 ano atrás
pai
commit
9f3524cb78

+ 51 - 5
en/ReleaseNotes/ReleaseNotes.md

@@ -1,18 +1,18 @@
 # Stride 4.2 Release Notes
 # Stride 4.2 Release Notes
 
 
-January 5th, 2024
+January 10th, 2024
 
 
 Stride contributors are thrilled to announce the release of Stride 4.2, now fully compatible with .NET 8 and leveraging the latest enhancements in C# 12. This release brings significant improvements in performance, stability, and developer experience.
 Stride contributors are thrilled to announce the release of Stride 4.2, now fully compatible with .NET 8 and leveraging the latest enhancements in C# 12. This release brings significant improvements in performance, stability, and developer experience.
 
 
-A massive thank you to the open-source Stride community for your dedicated contributions. This release saw X contributions from over Y amazing contributors, each playing a crucial role in making Stride 4.2 a reality.
+A massive thank you to the open-source Stride community for your dedicated contributions. This release saw over 75 contributions from more than 22 amazing contributors, each playing a crucial role in making Stride 4.2 a reality.
 
 
 ## What's new in Stride 4.2
 ## What's new in Stride 4.2
 Stride 4.2 includes numerous enhancements and improvements.
 Stride 4.2 includes numerous enhancements and improvements.
 
 
-- **[.NET 8 Integration](https://devblogs.microsoft.com/dotnet/announcing-dotnet-8/)**: Experience the power and efficiency of the latest .NET version in your game development. 
+- [.NET 8 Integration](https://devblogs.microsoft.com/dotnet/announcing-dotnet-8/): Experience the power and efficiency of the latest .NET version in your game development. 
   - Full compatibility with .NET 8, taking advantage of [improved runtime performance](https://devblogs.microsoft.com/dotnet/performance-improvements-in-net-8/)
   - Full compatibility with .NET 8, taking advantage of [improved runtime performance](https://devblogs.microsoft.com/dotnet/performance-improvements-in-net-8/)
-  - **[C# 12 features](https://devblogs.microsoft.com/dotnet/announcing-csharp-12/)**: Utilize cutting-edge language features to write more concise and maintainable code, enhancing coding efficiency and reducing boilerplate code
-- **[Changed Assimp binding to Silk.Net.Assimp](https://github.com/stride3d/stride/pull/1158)**
+  - [C# 12 features](https://devblogs.microsoft.com/dotnet/announcing-csharp-12/): Utilize cutting-edge language features to write more concise and maintainable code, enhancing coding efficiency and reducing boilerplate code
+- [Changed Assimp binding to Silk.Net.Assimp](https://github.com/stride3d/stride/pull/1158)
   - This change allows us to remove much of the C++/CLR code used by the asset compiler and brings us one step closer to running the asset compiler on non-windows systems.
   - This change allows us to remove much of the C++/CLR code used by the asset compiler and brings us one step closer to running the asset compiler on non-windows systems.
 - [Migration NET6+ and more gettextnet#2](https://github.com/stride3d/gettextnet/pull/2)
 - [Migration NET6+ and more gettextnet#2](https://github.com/stride3d/gettextnet/pull/2)
   - Updated all of gettext.NET to the latest stable version of NET
   - Updated all of gettext.NET to the latest stable version of NET
@@ -99,8 +99,54 @@ Stride 4.2 includes numerous enhancements and improvements.
 * Let the user pick which animation stack to import in an fbx by @adrsch in https://github.com/stride3d/stride/pull/1977
 * Let the user pick which animation stack to import in an fbx by @adrsch in https://github.com/stride3d/stride/pull/1977
 * Fixes OpenGL by @MaximilianEmel in https://github.com/stride3d/stride/pull/2023
 * Fixes OpenGL by @MaximilianEmel in https://github.com/stride3d/stride/pull/2023
 * Update dotnet 8 by @Doprez in https://github.com/stride3d/stride/pull/1616
 * Update dotnet 8 by @Doprez in https://github.com/stride3d/stride/pull/1616
+* [Native] - Implement IsXInputDevice method in C# by @Jklawreszuk in https://github.com/stride3d/stride/pull/1926
+* Rollback changes to Stride.Native.targets and add StrideNative.cpp by @Kryptos-FR in https://github.com/stride3d/stride/pull/2047
+* Use central package management by @Kryptos-FR in https://github.com/stride3d/stride/pull/2045
+* [Build] Use central package management  - missed a couple of projects by @Kryptos-FR in https://github.com/stride3d/stride/pull/2052
+* [Profiling] Fix performance regression in FastTextRenderer by @Eideren in https://github.com/stride3d/stride/pull/2058
+* [Project] GitIgnore Rider cache/user config by @Eideren in https://github.com/stride3d/stride/pull/2062
+* [Build] Fix build following changes from #2045 by @Eideren in https://github.com/stride3d/stride/pull/2061
+* Replace net 6 leftovers by @Jklawreszuk in https://github.com/stride3d/stride/pull/2038
+* updated missed dotnet 6 reference in readme by @Doprez in https://github.com/stride3d/stride/pull/2051
+* [Math] Relax constraints on arguments passed as ref across math types by @Eideren in https://github.com/stride3d/stride/pull/2044
+* fix(fbx import): Prevent zero-length tangents/normals (partial fix for #325) by @froce in https://github.com/stride3d/stride/pull/2066
+* [Editor] Fix NuGet.Frameworks failing to load causing RoslynPad to break by @Eideren in https://github.com/stride3d/stride/pull/2075
+* [Native] Undo lightprobe-related code removal by @Jklawreszuk in https://github.com/stride3d/stride/pull/2077
+* Fix extension by @Doprez in https://github.com/stride3d/stride/pull/2064
+* [Build] Move Directory.Packages.props by @Kryptos-FR in https://github.com/stride3d/stride/pull/2055
+* Fix Typos in XML docs by @Doprez in https://github.com/stride3d/stride/pull/2091
+
+## Contributors
+
+A heartfelt thank you to all the contributors who have played a significant role in this release:
+
+- [@MeharDT](https://github.com/MeharDT)
+- [@Basewq](https://github.com/Basewq)
+- [@Doprez](https://github.com/Doprez)
+- [@IXLLEGACYIXL](https://github.com/IXLLEGACYIXL)
+- [@SVNMLR](https://github.com/SVNMLR)
+- [@VaclavElias](https://github.com/VaclavElias)
+- [@acastrodev](https://github.com/acastrodev)
+- [@Ethereal77](https://github.com/Ethereal77)
+- [@adrsch](https://github.com/adrsch)
+- [@Jklawreszuk](https://github.com/Jklawreszuk)
+- [@Eideren](https://github.com/Eideren)
+- [@Fydar](https://github.com/Fydar)
+- [@froce](https://github.com/froce)
+- [@Kryptos-FR](https://github.com/Kryptos-FR)
+- [@Schossi](https://github.com/Schossi)
+- [@MaximilianEmel](https://github.com/MaximilianEmel)
+- [@ch3mbot](https://github.com/ch3mbot)
+- [@tebjan](https://github.com/tebjan)
+- [@JeromyWalsh](https://github.com/JeromyWalsh)
+- [@azeno](https://github.com/azeno)
+- [@WojciechNagorski](https://github.com/WojciechNagorski)
+- [@manio143](https://github.com/manio143)
 
 
 ## New Contributors
 ## New Contributors
+
+We are especially excited to welcome the following new contributors to Stride with the 4.2 release. Your contributions are greatly appreciated!
+
 * @adrsch made their first contribution in https://github.com/stride3d/stride/pull/1920
 * @adrsch made their first contribution in https://github.com/stride3d/stride/pull/1920
 * @froce made their first contribution in https://github.com/stride3d/stride/pull/1788
 * @froce made their first contribution in https://github.com/stride3d/stride/pull/1788
 * @Fydar made their first contribution in https://github.com/stride3d/stride/pull/1941
 * @Fydar made their first contribution in https://github.com/stride3d/stride/pull/1941

+ 2 - 2
en/contributors/contribution-workflow.md

@@ -22,8 +22,8 @@ graph TB
     F[Sync/Merge Forked Main Branch to Branch 'X']
     F[Sync/Merge Forked Main Branch to Branch 'X']
     G[Test your updates]
     G[Test your updates]
     H["Create a Pull Request (PR)"]
     H["Create a Pull Request (PR)"]
-    I[Wait for the PR to be Merged]
-    J[Address PR Feedback]
+    I[Address PR Feedback]
+    J[Wait for the PR to be Merged]
     K[Sync/Merge Upstream to Your Forked Main Branch]
     K[Sync/Merge Upstream to Your Forked Main Branch]
     L{Do You Want to Make More Updates?}
     L{Do You Want to Make More Updates?}
     Z[End]
     Z[End]

+ 4 - 14
en/contributors/engine/architecture/index.md

@@ -1,18 +1,8 @@
-# Engine architecture
+# Engine architecture
 General explanation of Stride engine source
 General explanation of Stride engine source
 
 
-
-### [Build pipeline](build-pipeline.md)
-Explanation on the current build pipeline.
-
-### [Build details](build-details.md)
+## [Build details](build-details.md)
 Details on the building process of the Stride engine.
 Details on the building process of the Stride engine.
 
 
-### [Graphics API](graphics-api.md)
-Stride support different graphics APIs. Here you can read more about them.
-
-### [Dependency graph](dependency-graph.md)
-A graphical overview of Stride's Assemblies, NameSpaces and Core methods
-
-### [Asset introspection](asset-introspection.md)
-How and why the Stride engine uses asset introspection
+## [Dependency graph](dependency-graph.md)
+A graphical overview of Stride's Assemblies, NameSpaces and Core methods.

+ 10 - 18
en/contributors/engine/index.md

@@ -1,43 +1,35 @@
-# Contribute to Stride engine
+# Contribute to Stride engine
 Here you can find various pages describing building the source locally for different systems. You can also find information about Stride's architecture.
 Here you can find various pages describing building the source locally for different systems. You can also find information about Stride's architecture.
 
 
-### [Contribute code](contribute-code.md)
+## [Contribute code](contribute-code.md)
 Want to help out fixing bugs or making new features? Check out how you can do so.
 Want to help out fixing bugs or making new features? Check out how you can do so.
 
 
-### [Bug bounties](bug-bounties.md)
+## [Bug bounties](bug-bounties.md)
 Here you can learn about the process on our bug bounty process.
 Here you can learn about the process on our bug bounty process.
 
 
-### [Building on Windows](building-source-windows.md)
+## [Building on Windows](building-source-windows.md)
 Building and running the Stride engine locally on Windows using [Visual Studio](building-source-windows.md) or other [IDEs](building-source-windows-other-ide.md).
 Building and running the Stride engine locally on Windows using [Visual Studio](building-source-windows.md) or other [IDEs](building-source-windows-other-ide.md).
 
 
 [//]: # (### [Building on Linux](building-source-linux.md))
 [//]: # (### [Building on Linux](building-source-linux.md))
 
 
 [//]: # (Building the Stride engine locally on Linux)
 [//]: # (Building the Stride engine locally on Linux)
 
 
-### [Localization](localization.md)
+## [Localization](localization.md)
 Learn how manage translations for the engine.
 Learn how manage translations for the engine.
 
 
-### [Hot reloading shaders](hot-reloading-shaders.md)
+## [Hot reloading shaders](hot-reloading-shaders.md)
 Learn about hot reloading shaders.
 Learn about hot reloading shaders.
 
 
-### [Source debugging](source-debugging.md)
+## [Source debugging](source-debugging.md)
 Learn how to do source debugging.
 Learn how to do source debugging.
 
 
-### [Visual studio plugin](visual-studio-plugin.md)
+## [Visual studio plugin](visual-studio-plugin.md)
 Learn about the Visual studio plugin for shader development.
 Learn about the Visual studio plugin for shader development.
 
 
-# Architecture 🧬
-### [Build pipeline](architecture/build-pipeline.md)
-Explanation on the current build pipeline.
+## Architecture 🧬
 
 
 ### [Build details](architecture/build-details.md)
 ### [Build details](architecture/build-details.md)
 Details on the building process of the Stride engine.
 Details on the building process of the Stride engine.
 
 
-### [Graphics API](architecture/graphics-api.md)
-Stride support different graphics APIs. Here you can read more about them.
-
 ### [Dependency graph](architecture/dependency-graph.md)
 ### [Dependency graph](architecture/dependency-graph.md)
-A graphical overview of Stride's Assemblies, NameSpaces and Core methods.
-
-### [Asset introspection](architecture/asset-introspection.md)
-How and why the Stride engine uses asset introspection.
+A graphical overview of Stride's Assemblies, NameSpaces and Core methods.

+ 2 - 2
en/contributors/index.md

@@ -1,4 +1,4 @@
-# Ways to contribute
+# Ways to contribute
 
 
 Stride is a non-profit, community-driven, free and open source project.
 Stride is a non-profit, community-driven, free and open source project.
 There are no full-time developers dedicated solely to Stride's advancement; instead, the engine progresses through the voluntary contributions of both the core team and the broader community.
 There are no full-time developers dedicated solely to Stride's advancement; instead, the engine progresses through the voluntary contributions of both the core team and the broader community.
@@ -28,4 +28,4 @@ Have a look at the GitHub issues label [Good first issue](https://github.com/str
 Enhance the official documentation and tutorials by expanding the manual or creating textual/video guides. Your contributions will greatly improve accessibility and understanding for users.
 Enhance the official documentation and tutorials by expanding the manual or creating textual/video guides. Your contributions will greatly improve accessibility and understanding for users.
 
 
 ### [Contribute to Website](website/index.md) 🌐
 ### [Contribute to Website](website/index.md) 🌐
-Enhance the official Stride website. Is design more your thing, or do you have an interesting blog post? It will all help us spread the word of Stride.
+Enhance the official Stride website. Is design more your thing, or do you have an interesting blog post? It will all help us spread the word of Stride.

+ 0 - 6
en/contributors/toc.yml

@@ -30,16 +30,10 @@ items:
     expanded: true
     expanded: true
     href: engine/architecture/index.md
     href: engine/architecture/index.md
     items:
     items:
-    - name: Build pipeline
-      href: engine/architecture/build-pipeline.md
     - name: Build details
     - name: Build details
       href: engine/architecture/build-details.md
       href: engine/architecture/build-details.md
-    - name: Graphics API
-      href: engine/architecture/graphics-api.md
     - name: Dependency graph
     - name: Dependency graph
       href: engine/architecture/dependency-graph.md
       href: engine/architecture/dependency-graph.md
-    - name: Asset introspection
-      href: engine/architecture/asset-introspection.md
 - name: 📖 Contribute to the documentation
 - name: 📖 Contribute to the documentation
   expanded: false
   expanded: false
   href: documentation/index.md
   href: documentation/index.md

+ 0 - 0
en/contributors/engine/architecture/asset-introspection.md → en/manual/engine/asset-introspection.md


+ 0 - 0
en/contributors/engine/architecture/build-pipeline.md → en/manual/engine/build-pipeline.md


+ 3 - 1
en/manual/engine/index.md

@@ -6,8 +6,10 @@
 - [Asset](assets/index.md)
 - [Asset](assets/index.md)
 - [Entity-component system](entity-component-system/index.md)
 - [Entity-component system](entity-component-system/index.md)
 - [File system](file-system.md)
 - [File system](file-system.md)
+- [Build pipeline](build-pipeline.md)
+- [Asset introspection](asset-introspection.md)
 
 
 # See also
 # See also
 
 
 - [Introduction to assets](../game-studio/assets.md)
 - [Introduction to assets](../game-studio/assets.md)
-- [Scripts](../scripts/index.md)
+- [Scripts](../scripts/index.md)

+ 5 - 5
en/manual/get-started/install-stride.md

@@ -16,7 +16,7 @@
 
 
     > [!Note]
     > [!Note]
     > Alternatively, you can [download the .NET Framework from the Microsoft Download Center](https://dotnet.microsoft.com/download/dotnet-framework/thank-you/net472-web-installer) and restart the Stride installer.
     > Alternatively, you can [download the .NET Framework from the Microsoft Download Center](https://dotnet.microsoft.com/download/dotnet-framework/thank-you/net472-web-installer) and restart the Stride installer.
-	
+    
 4. The **Stride Setup Wizard** opens.
 4. The **Stride Setup Wizard** opens.
 
 
      ![Stride Setup Wizard](media/install-stride-setup-wizard.png)
      ![Stride Setup Wizard](media/install-stride-setup-wizard.png)
@@ -28,11 +28,11 @@
     ![Stride license agreement window](media/install-stride-license-agreement.png)
     ![Stride license agreement window](media/install-stride-license-agreement.png)
 
 
     Click **Accept**.
     Click **Accept**.
-	
+    
 5. The **Stride installation type** window opens.
 5. The **Stride installation type** window opens.
 
 
     ![Stride installation type window](media/install-stride-installation-type.png)
     ![Stride installation type window](media/install-stride-installation-type.png)
-	
+    
     Select an installation type and click **Next**. 
     Select an installation type and click **Next**. 
 
 
 6.  The **Select installation folder** window opens.
 6.  The **Select installation folder** window opens.
@@ -40,13 +40,13 @@
     ![Select installation folder window](media/install-stride-select-installation-folder.png)
     ![Select installation folder window](media/install-stride-select-installation-folder.png)
 
 
     Select a folder to install Stride to and click **Next**.
     Select a folder to install Stride to and click **Next**.
-	
+    
 7. The **Create application shortcuts** window opens.
 7. The **Create application shortcuts** window opens.
     
     
     ![Create application shortcuts window](media/install-stride-create-application-shortcuts.png)
     ![Create application shortcuts window](media/install-stride-create-application-shortcuts.png)
 
 
     Choose which shortcuts you want Stride to create, and click **Next**.
     Choose which shortcuts you want Stride to create, and click **Next**.
-	
+    
 8. The **Ready to Install** window opens.
 8. The **Ready to Install** window opens.
     
     
     ![Ready to install window](media/install-stride-ready-to-install.png)
     ![Ready to install window](media/install-stride-ready-to-install.png)

+ 3 - 0
en/manual/get-started/media/update-stride-packages.webp

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a4456a4f6046a789e60773701a460cf35ba5ae12c9d73ace72d4dfc65f1c9e8b
+size 13822

+ 3 - 0
en/manual/get-started/media/update-stride-save-project.webp

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a7a1e872307cf4ffd39c62714a6ee9c7a97899e049cc87afca5e5fd0eae55c21
+size 9252

+ 25 - 0
en/manual/get-started/update-stride.md

@@ -0,0 +1,25 @@
+# Update Stride
+
+<span class="badge text-bg-primary">Beginner</span>
+
+Updating Stride is a straightforward process, but it's important to follow the steps carefully to ensure a seamless transition. Below are the guidelines for updating both the Stride engine and your existing projects.
+
+> [!NOTE]
+> The instructions provided here can be used as a general guide for updating to any new version of Stride.
+
+## Updating Stride
+
+1. **Update Visual Studio 2022:** Ensure that you have the latest version of Visual Studio 2022. This is crucial for compatibility with the latest Stride version. After updating Visual Studio, restart your computer to apply the changes fully.
+1. **Stride Launcher Instructions:** Open the Stride Launcher. Follow the instructions provided to update or install the Visual Studio plugin for Stride. This step is essential for integrating the latest version of Stride with your development environment.
+1. **Restart Again:** After completing the installation or update of the Visual Studio plugin, restart your computer once more. This helps to ensure that all components are correctly loaded and ready for use.
+
+## Updating Your Project
+
+1. **Version Control:** Before proceeding with the update, confirm that your project is under version control with all current changes committed. This provides a safety net, allowing you to revert to the previous state if needed. If you're not using version control, ensure you have a backup of your project.
+1. **Opening the Project:** When you open a project created with an older version of Stride, a dialogue will appear, prompting you to update the project. Make sure to check the option to apply the update to all packages in the solution. Additionally, you can verify later whether all packages have been updated by checking your project files, specifically the `.csproj` files.
+  ![New Project dialog](media/update-stride-packages.webp) *Dialog prompting for project update in Stride.*
+1. **Saving the Project:** After Stride updates the project, it's crucial to save it immediately. This step prevents the project from being in an undefined state and solidifies the changes made during the update.
+  ![New Project dialog](media/update-stride-save-project.webp)
+1. **Rebuild and Reload:** Finally, rebuild the project and reload assemblies. This ensures that all components are up-to-date and properly synchronized with the new version of Stride.
+
+By following these steps, you can smoothly transition to the latest version of Stride, taking full advantage of the new features and improvements it offers. Remember, these procedures are designed to provide a hassle-free update experience and safeguard your project against potential issues.

+ 0 - 0
en/contributors/engine/architecture/graphics-api.md → en/manual/graphics/graphics-api.md


+ 2 - 1
en/manual/graphics/index.md

@@ -30,4 +30,5 @@ The graphics module provides a set of methods to display the game. Although Stri
 * [Low-level API](low-level-api/index.md)
 * [Low-level API](low-level-api/index.md)
 * [Rendering pipeline](rendering-pipeline/index.md)
 * [Rendering pipeline](rendering-pipeline/index.md)
 * [Sprite fonts](sprite-fonts.md)
 * [Sprite fonts](sprite-fonts.md)
-* [Voxel Cone Tracing GI](lights-and-shadows/voxel-cone-tracing-gi.md)
+* [Voxel Cone Tracing GI](lights-and-shadows/voxel-cone-tracing-gi.md)
+* [Graphics API](graphics-api.md)

+ 8 - 0
en/manual/toc.yml

@@ -19,6 +19,8 @@ items:
         href: get-started/install-stride.md
         href: get-started/install-stride.md
       - name: Visual Studio extension
       - name: Visual Studio extension
         href: get-started/visual-studio-extension.md
         href: get-started/visual-studio-extension.md
+      - name: Update Stride
+        href: get-started/update-stride.md
       - name: Launch Stride
       - name: Launch Stride
         href: get-started/launch-stride.md
         href: get-started/launch-stride.md
       - name: Create a project
       - name: Create a project
@@ -118,6 +120,10 @@ items:
             href: engine/entity-component-system/managing-entities.md
             href: engine/entity-component-system/managing-entities.md
       - name: File system
       - name: File system
         href: engine/file-system.md
         href: engine/file-system.md
+      - name: Build pipeline
+        href: engine/build-pipeline.md
+      - name: Asset introspection
+        href: engine/asset-introspection.md
 
 
   - name: Files and folders
   - name: Files and folders
     href: files-and-folders/index.md
     href: files-and-folders/index.md
@@ -341,6 +347,8 @@ items:
             href: graphics/rendering-pipeline/render-stages.md
             href: graphics/rendering-pipeline/render-stages.md
       - name: Sprite fonts
       - name: Sprite fonts
         href: graphics/sprite-fonts.md
         href: graphics/sprite-fonts.md
+      - name: Graphics API
+        href: graphics/graphics-api.md
 
 
   - name: Input
   - name: Input
     href: input/index.md
     href: input/index.md