From e28cbc4fd9d68bb1c1c82864388de3319dd32a75 Mon Sep 17 00:00:00 2001 From: Ferafiks Date: Mon, 8 Dec 2025 15:45:49 +0100 Subject: [PATCH 1/7] Initial work on rewriting the "get started" section --- en/manual/get-started/assets.md | 18 +++ en/manual/get-started/game-studio.md | 45 +++++++ en/manual/get-started/index.md | 14 +-- en/manual/get-started/install-stride.md | 115 ------------------ en/manual/get-started/key-concepts.md | 62 ++++++++++ en/manual/get-started/launch-a-game.md | 32 ----- en/manual/get-started/launch-stride.md | 57 --------- en/manual/get-started/next-steps.md | 5 + .../get-started/visual-studio-extension.md | 21 ---- en/manual/install-and-update/index.md | 13 ++ .../install-and-update/install-stride.md | 66 ++++++++++ .../media/install-VS-plug-in-prompt.webp | 0 ...r-first-time-after-installation-error.webp | 0 ...auncher-install-latest-version-prompt.webp | 0 .../media/stride-launcher-ready.webp | 0 .../media/stride-launcher.webp | 0 .../media/update-stride-packages.webp | 0 .../media/update-stride-save-project.webp | 0 .../requirements.md} | 4 +- .../update-stride.md | 0 en/manual/requirements/media/requirements.png | 3 - 21 files changed, 215 insertions(+), 240 deletions(-) create mode 100644 en/manual/get-started/assets.md create mode 100644 en/manual/get-started/game-studio.md delete mode 100644 en/manual/get-started/install-stride.md create mode 100644 en/manual/get-started/key-concepts.md delete mode 100644 en/manual/get-started/launch-stride.md create mode 100644 en/manual/get-started/next-steps.md delete mode 100644 en/manual/get-started/visual-studio-extension.md create mode 100644 en/manual/install-and-update/index.md create mode 100644 en/manual/install-and-update/install-stride.md rename en/manual/{get-started => install-and-update}/media/install-VS-plug-in-prompt.webp (100%) rename en/manual/{get-started => install-and-update}/media/stride-launcher-first-time-after-installation-error.webp (100%) rename en/manual/{get-started => install-and-update}/media/stride-launcher-install-latest-version-prompt.webp (100%) rename en/manual/{get-started => install-and-update}/media/stride-launcher-ready.webp (100%) rename en/manual/{get-started => install-and-update}/media/stride-launcher.webp (100%) rename en/manual/{get-started => install-and-update}/media/update-stride-packages.webp (100%) rename en/manual/{get-started => install-and-update}/media/update-stride-save-project.webp (100%) rename en/manual/{requirements/index.md => install-and-update/requirements.md} (95%) rename en/manual/{get-started => install-and-update}/update-stride.md (100%) delete mode 100644 en/manual/requirements/media/requirements.png diff --git a/en/manual/get-started/assets.md b/en/manual/get-started/assets.md new file mode 100644 index 000000000..628fe7e4b --- /dev/null +++ b/en/manual/get-started/assets.md @@ -0,0 +1,18 @@ +# Assets + +Beginner + +## Green, blue and gray dots + +[IMAGE OF 3 DIFFERENT ASSETS WITH 3 DIFFERENT COLORED DOTS HERE] + +Every asset has a little dot in the top left corner of their icon. This dot signifies if an asset is going to be included when building the project: +* Green - the asset will be included in the build, because a different asset needs it. +* Blue - the asset will be included in the build no matter if it's needed or not. +* Gray - the asset will not be included in the build. + +Stride doesn't include assets which aren't used anywhere, meaning that **the cannot be accessed when running the game**. + +In order to ensure, that an asset will be included in the build no matter what, right click on it and select **Mark as root asset** (TODO: change this text to whatever it says in Game Studio). + +[IMAGE OF THE CONTEXT MENU HERE] diff --git a/en/manual/get-started/game-studio.md b/en/manual/get-started/game-studio.md new file mode 100644 index 000000000..c627b1cb7 --- /dev/null +++ b/en/manual/get-started/game-studio.md @@ -0,0 +1,45 @@ +# Game Studio + +Beginner + +**Game Studio** is an essential tool, used for editing assets, arranging scenes and much more. It's important to familiarize yourself with it's layout. + +[IMAGE HERE] + +## Asset Editor + +[IMAGE HERE] + +The **asset editor** is a dedicated editor for certain assets. It's most commonly used for editing scenes and their entities. + +## Property Grid + +[IMAGE HERE] + +The **property grid** displays a list of properties of selected assets and entities. + +This is where you can assign [Components](key-concepts#components) to entities and edit their properties. + +## Solution Explorer + +[IMAGE HERE] + +The **solution explorer** displays the hierarchy of elements in the C# solution associated with the Project. These elements contain assets and code. + +In a new project, there are 2 or more items under the solution: `NameOfMyProject` and `NameOfMyProject.NameOfPlatform` (there could be one or more of these). +* `NameOfProject` contains files for the game. +* `NameOfProject.NameOfPlatform` contains files specific to that platform (mostly, the Program.cs file from which the game starts and the window icon). + +Under each of those elements, there are 2 folders: **Assets** and **Code**. +* **Assets** contains all assets of that element. +* **Code** contains all code of that element. + +[IMAGE HERE] + +## Asset View + +The **asset view** displays contents of a selected folder in the **[solution explorer](#solution-explorer)**. + +Items from the **asset view** can be dragged into other editors (for example: dragging a prefab into the scene in the **[Asset Editor](#asset-editor)**). + +To create a new asset, click the **Add asset** button in the top left corner. diff --git a/en/manual/get-started/index.md b/en/manual/get-started/index.md index 81a83de66..738928471 100644 --- a/en/manual/get-started/index.md +++ b/en/manual/get-started/index.md @@ -5,23 +5,17 @@ uid: ../toc.md Beginner -Welcome to Stride! This chapter provides everything you need to start creating games using the Stride game engine. If you're new to Stride, we recommend starting with the [Install Stride](install-stride.md) guide, which will help you set up the engine and get you ready for development. +Welcome to Stride! This chapter provides everything you need to start creating games using the Stride game engine. If you haven't already, you can learn how to install the engine with the [Install Stride](../install-and-update/install-stride.md) guide. Stride is designed for game developers who want a powerful, flexible, and open-source engine for their projects. Whether you're an experienced developer or just starting out, these guides will walk you through the basics and help you get up and running quickly. For video tutorials, have a look at the [Tutorials](../../tutorials/index.md). -If you're interested in building the Stride engine from source or contributing to its development, please refer to the instructions on our [GitHub repository](https://github.com/stride3d/stride). - ![Game Studio](media/get-started.webp) ## In this section -* [Install Stride](install-stride.md) -* [Launch Stride](launch-Stride.md) -* [Visual Studio extension](visual-studio-extension.md) * [Create a project](create-a-project.md) -* [Game Studio](../game-studio/index.md) -* [Assets](../game-studio/assets.md) -* [Introduction to scenes](../game-studio/scenes.md) -* [Launch your game](launch-a-game.md) \ No newline at end of file +* [Key Concepts](key-concepts.md) +* [Launch your game](launch-a-game.md) +* [Next steps](next-steps.md) diff --git a/en/manual/get-started/install-stride.md b/en/manual/get-started/install-stride.md deleted file mode 100644 index 9ba661b56..000000000 --- a/en/manual/get-started/install-stride.md +++ /dev/null @@ -1,115 +0,0 @@ -# Install Stride - -Beginner - -## Introduction - -If you want to **create games using Stride**, this guide provides the installation steps you'll need to follow. You'll need to install the Stride installer and launcher. The Stride installer is approximately **55 MB** and is downloaded directly from our main GitHub repository. - -The installer will automatically download and install the prerequisites if they are not detected, including the [Stride Launcher](launch-stride.md), which is essential for downloading and installing the latest version of Stride for game development. - -If you're interested in **building the Stride engine from source** or **contributing to its development**, please visit the [Stride GitHub repository](https://github.com/stride3d/stride) for instructions on how to build from source and contribute to the project. - -**Prerequisites (automatically installed if not present):** - -- Latest **.NET SDK** supported by Stride -- Microsoft Visual C++ Redistributable - -The **Stride Launcher** will download and install the latest version of Stride. - -## Installation Steps - -1. Download the Stride installer (**StrideSetup.exe**) from the [Stride website](http://stride3d.net/download/). - -2. Run the installer by double-clicking the **StrideSetup.exe** file. - -3. The **Stride Setup Wizard** opens. - - ![Stride Setup Wizard](media/install-stride-setup-wizard.webp) - - Click **Next**. - -4. The **Stride installation type** window opens. - - ![Stride installation type window](media/install-stride-installation-type.webp) - - Select an installation type and click **Next**. - -5. The **Select installation folder** window opens. - - ![Select installation folder window](media/install-stride-select-installation-folder.webp) - - Choose a folder where you want to install Stride, then click **Next**. - -6. The **Create application shortcuts** window opens. - - ![Create application shortcuts window](media/install-stride-create-application-shortcuts.webp) - - Choose which shortcuts you want Stride to create, then click **Next**. - -7. The **Ready to Install** window opens. - - ![Ready to install window](media/install-stride-ready-to-install.webp) - - Click **Install** to begin the installation. - -8. Installation begins. - - ![Installation status](media/install-stride-installation-status.webp) - - The installer will proceed with the installation. After it completes, Stride creates shortcuts in the locations you selected, and the **Stride Launcher** starts automatically. - -9. The first time you run the Stride Launcher, you will be asked to accept the privacy policy. - - ![Stride privacy policy](media/stride-privacy-policy-prompt.webp) - - Check *I agree to the Privacy Policy*, then click **I Accept**. - -10. The **Stride Launcher** window opens. - - ![Stride Launcher](media/stride-launcher.webp) - - The Stride Launcher prompts you to install the latest version of Stride. - - ![No version installed](media/stride-launcher-install-latest-version-prompt.webp) - - Click **Yes** to install the latest version. - -11. Installation of the latest version of Stride begins. - - ![Installation of Stride](media/stride-launcher-install-latest-version.webp) - - While the installation is in progress, the release notes are displayed. - - > [!Warning] - > If the .NET SDK has never been installed on your machine, the .NET SDK installation window might appear below the Stride installation window. Please check step 12 for details and be prepared to manually continue the .NET SDK installation. - -12. During the installation, you might be asked to install the .NET SDK if it's not already on your machine. - - ![Installation of .NET SDK](media/install-dotnet-SDK.webp) - - Click **Install**. - -13. The Stride Launcher asks if you want to install the Visual Studio integration. This allows you to edit shaders directly from Visual Studio, providing syntax highlighting, live code analysis with validation, error-checking, and navigation. Installing the integration isn't mandatory, but we recommend it. - - ![Install Visual Studio integration](media/install-VS-plug-in-prompt.webp) - - Click **Yes** to install the integration, or **No** to skip. - -14. Stride is now installed and ready to use. - - ![Stride ready to use](media/stride-launcher-ready.webp) - -> [!Note] -> **Stride Launcher:** If you click **Start** and see an error message such as `Could not find a compatible version of MSBuild.` or `Path to dotnet executable is not set.`, close the Stride Launcher and restart it. This issue is caused by the Stride Launcher not detecting the .NET SDK installation. Restarting the Stride Launcher should resolve the issue. Alternatively, restart your computer. -> -> Example error: ![First launch error](media/stride-launcher-first-time-after-installation-error.webp) - -> [!Note] -> If you don't install the prerequisites, Stride won't run. In this case, you can download and install the prerequisites separately. For instructions, see [Troubleshooting — Stride doesn't run](../troubleshooting/stride-doesnt-run.md). -> -> Alternatively, uninstall Stride, restart the Stride installer, and install the prerequisites when prompted. - -## What's next? - -* [Launch Stride](launch-stride.md) diff --git a/en/manual/get-started/key-concepts.md b/en/manual/get-started/key-concepts.md new file mode 100644 index 000000000..14d95f3bc --- /dev/null +++ b/en/manual/get-started/key-concepts.md @@ -0,0 +1,62 @@ +# Key concepts + +Beginner + +This article highlights most important concepts that are used in the engine. + +## Scenes + +A scene is a collection of entities that can be loaded and unloaded on demand. Most often, scenes contain different levels of a game or menus. + +In Stride, Scenes can contain sub-scenes that can be loaded and unloaded on demand. + +[IMAGE HERE] + +## Entities + +Entities represent different objects in a scene, like the player, enemies, walls, etc. These entities contain components that dictate how they behave. + +## Components + +Components dictate how entities which they are attached to behave. For example: a player movement component that makes an entity move, when keyboard buttons are pressed. + +[IMAGE HERE] + +In code, a component is a class that inherits `StartupScript`, `SyncScript` or `AsyncScript`. + +```csharp +using Stride.Engine; + +namespace MyGame; + +public class MyComponent : StartupScript +{ + public override void Start() + { + // Write your code here + } +} +``` + +## Script types + +In Stride, a component can be created from one of 3 types of script: +- **Startup Script** - a script that runs only once when it's added. +- **Sync Script** - a script that runs when it's added and then every frame. +- **Async Script** - an **asynchronous** script that runs only once when it's added, but can await the next frame continuously. + +For more information, read [types of script](../scripts/types-of-script). + +## Assets and resources + +An **asset** is a representation of an element in the project (like a texture), that contains a list of it's properties in the engine (e.g. `.sdmat` `.sdprefab`). + +A **resource** is a file on the disk containing data, like an image (e.g. `.png` `.mp3`). + +Assets do not contain resource data. Instead, they reference a resource. For example: a texture asset (`.sdtex`) has a reference to an image (`.png`) that is located in the resource folder. + +## Project structure + +A Stride project is a standard [C# solution](https://learn.microsoft.com/en-us/visualstudio/ide/solutions-and-projects-in-visual-studio?view=vs-2022). Assets and resources can be separated into multiple C# projects, for example: **MyGame** contains game assets and **MyGame.Windows** contains assets specific to the windows version of the game (like the window icon). + +For more information, read [project structure](../files-and-folders/project-structure). diff --git a/en/manual/get-started/launch-a-game.md b/en/manual/get-started/launch-a-game.md index 2d0aa3cdf..fdac3ab59 100644 --- a/en/manual/get-started/launch-a-game.md +++ b/en/manual/get-started/launch-a-game.md @@ -46,35 +46,3 @@ This page explains how to launch your game using Game Studio or Visual Studio. * To start the game with debugging, click **Start** or press **F5**. ![Visual Studio Start button](media/visual-studio-start-button.webp) - -## Remove borders - -By default, the game runs with window borders. - -| With borders | Without borders -|---------------------------|----------------- -| ![With borders](media/with-borders.webp) | ![Without borders](media/without-borders.webp) - -To run the game without borders, use: - -```cs -Game.Window.IsBorderLess = true; -``` - -For example: - -```cs -using Stride.Engine; - -namespace MyGame -{ - public class MyScript : StartupScript - { - public override void Start() - { - base.Start(); - Game.Window.IsBorderLess = true; - } - } -} -``` \ No newline at end of file diff --git a/en/manual/get-started/launch-stride.md b/en/manual/get-started/launch-stride.md deleted file mode 100644 index 4c7d3eeaf..000000000 --- a/en/manual/get-started/launch-stride.md +++ /dev/null @@ -1,57 +0,0 @@ -# Launch Stride - -Beginner - -With the **Stride launcher**, you can install, manage and run different versions of Stride. - -![Stride launcher](media/stride-launcher-interface.webp) - -## Install the latest version of Stride - -If you don't have Stride installed, the Stride Launcher prompts you to install the latest version. - -![No version installed](media/stride-launcher-install-latest-version-prompt.webp) - -If you choose to install the latest version, the Stride Launcher asks if you want to install the Stride Visual Studio extension. - -![Install Visual Studio integration](media/install-VS-plug-in-prompt.webp) - -The Stride Visual Studio extension lets you you [edit shaders directly from Visual Studio](../graphics/effects-and-shaders/custom-shaders.md). You don't need to install the extension to use Stride, but we recommend it, especially for programmers. - -## Manage different versions of Stride - -You can install multiple versions of Stride and launch them from the Stride Launcher. - -![Manage versions of Stride](media/stride-launcher-various-versions.webp) - -You might need to use an older version of Stride to work with old projects. Newer versions of Stride might contain changes that require old projects to be upgraded. - -For minor versions, only the last number of the version number changes (1.9.0, 1.9.1, 1.9.2, etc). Minor versions don't contain breaking changes, so they're safe to install and use with your existing projects. - ->[!Note] ->You can't revert to earlier minor versions. For example, you can install both Stride 1.9 and 1.8 side by side, but you can't revert from Stride 1.9.2 to Stride 1.9.1. - -* To see the release notes for a particular version, click the **note icon** next to the version name. - -* To install a particular version, click the **Download and install** icon next to the -version name. - -## Start Game Studio - -Now you've installed Stride, it's time to start Game Studio and build a project. - -1. Under **Switch/update version**, select the version of Stride you want to use. - - The version number is updated on the **Start** button. - - ![Start button](../stride-launcher/media/stride-launcher-start-button.webp) - -2. Click **Start** to launch Game Studio. - -## What's next? - -* [Create your first project in Game Studio](create-a-project.md) - -## See also - -For more details about the Stride launcher, see the [Stride launcher](../stride-launcher/index.md) page. diff --git a/en/manual/get-started/next-steps.md b/en/manual/get-started/next-steps.md new file mode 100644 index 000000000..4b21edc4d --- /dev/null +++ b/en/manual/get-started/next-steps.md @@ -0,0 +1,5 @@ +# Next Steps + +Congratulations, by this point you should have everything to get yourself started with Stride! + +The best way of learning more about the engine is to **just start making something**. Alternatively, you can check out one of the [built-in examples](create-a-project.md#create-a-project-from-a-sample-or-template) or those provided [by the community](../../community-resources/example-projects.md). diff --git a/en/manual/get-started/visual-studio-extension.md b/en/manual/get-started/visual-studio-extension.md deleted file mode 100644 index 95836fd51..000000000 --- a/en/manual/get-started/visual-studio-extension.md +++ /dev/null @@ -1,21 +0,0 @@ -# Visual Studio extension - -Beginner - -The **Stride Visual Studio extension** lets you [edit shaders directly from Visual Studio](../graphics/effects-and-shaders/custom-shaders.md). - -You don't need to install the extension to use Stride, but we recommend it, especially for programmers. - -## Install the Stride Visual Studio Extension - -When you [install Stride](install-stride.md), Stride asks if you want to install the Visual Studio extension. - -![Install extension](media/install-VS-plug-in-prompt.webp) - -Alternatively, you can install or reinstall the extension at any time in the Stride Launcher under **Plug-in**. - -![Reinstall extension](../stride-launcher/media/stride-launcher-reinstall-extension.webp) - -## See also - -* [Custom shaders](../graphics/effects-and-shaders/custom-shaders.md) \ No newline at end of file diff --git a/en/manual/install-and-update/index.md b/en/manual/install-and-update/index.md new file mode 100644 index 000000000..3efaeb599 --- /dev/null +++ b/en/manual/install-and-update/index.md @@ -0,0 +1,13 @@ +# Install and Update + +Beginner + +The Stride editor is installed with a separate application, the **Stride Launcher**. This application is used for managing different versions of Stride and opening projects. + +![Screenshot of the Stride Launcher](media/stride-launcher.webp) + +## In this section: + +* [Requirements](requirements) +* [Install Stride](install-stride) +* [Update Stride](update-stride) diff --git a/en/manual/install-and-update/install-stride.md b/en/manual/install-and-update/install-stride.md new file mode 100644 index 000000000..f1e27121f --- /dev/null +++ b/en/manual/install-and-update/install-stride.md @@ -0,0 +1,66 @@ +# Install Stride + +Beginner + +## Introduction + +If you want to **create games using Stride**, this guide provides the installation steps you'll need to follow. + +The installer will automatically download and install the prerequisites if they are not detected, including the [Stride Launcher](launch-stride.md), which is essential for downloading and installing the latest version of Stride for game development. + +If you're interested in **building the Stride engine from source** or **contributing to its development**, please visit the [Stride GitHub repository](https://github.com/stride3d/stride) for instructions on how to build from source and contribute to the project. + +**Prerequisites (automatically installed if not present):** + +- Latest **.NET SDK** supported by Stride +- Microsoft Visual C++ Redistributable + +## Installation Steps + +1. Download the Stride Installer from the [Stride website](http://stride3d.net/download/). + +2. Run the installer by double-clicking the **StrideSetup.exe** file and follow the on screen instructions until the **Stride Launcher** is installed. + +3. Open the launcher. + +4. The Stride Launcher prompts you to install the latest version of Stride. + + ![No version installed](media/stride-launcher-install-latest-version-prompt.webp) + + Click **Yes** to install the latest version. + +5. (Optional) The Stride Launcher asks if you want to install the Visual Studio integration. Installing it isn't mandatory and it can be done later with the launcher. For more information, visit [this section](#visual-studio-integration). + + ![Install Visual Studio integration](media/install-VS-plug-in-prompt.webp) + + Click **Yes** to install the integration, or **No** to skip. + +6. Stride is now installed and ready to use. + + ![Stride ready to use](media/stride-launcher-ready.webp) + +> [!Note] +> If you click **Start** and see an error message such as `Could not find a compatible version of MSBuild.` or `Path to dotnet executable is not set.`, close the Stride Launcher and restart it. This issue is caused by the Stride Launcher not detecting the .NET SDK installation. Restarting the Stride Launcher should resolve the issue. Alternatively, restart your computer. +> +> Example error: ![First launch error](media/stride-launcher-first-time-after-installation-error.webp) + +# Troubleshooting + +If you don't install the prerequisites, Stride won't run. In this case, you can download and install the prerequisites separately. For instructions, see [Troubleshooting — Stride doesn't run](../troubleshooting/stride-doesnt-run.md). + +Alternatively, uninstall Stride, restart the Stride installer, and install the prerequisites when prompted. + +## Visual Studio integration + +The Visual Studio integration is an optional extension for Visual Studio. + +- **🟩 What it does**: provides syntax highlighting to shaders in Visual Studio. +- **🟥 What it doesn't do**: provide C# syntax highlighting for Stride (that works without the extension). + +The extension can be installed via the launcher, by navigating to the **Visual Studio extension** section. + +[INSERT PHOTO HERE] + +## What's next? + +* [Launch Stride](launch-stride.md) diff --git a/en/manual/get-started/media/install-VS-plug-in-prompt.webp b/en/manual/install-and-update/media/install-VS-plug-in-prompt.webp similarity index 100% rename from en/manual/get-started/media/install-VS-plug-in-prompt.webp rename to en/manual/install-and-update/media/install-VS-plug-in-prompt.webp diff --git a/en/manual/get-started/media/stride-launcher-first-time-after-installation-error.webp b/en/manual/install-and-update/media/stride-launcher-first-time-after-installation-error.webp similarity index 100% rename from en/manual/get-started/media/stride-launcher-first-time-after-installation-error.webp rename to en/manual/install-and-update/media/stride-launcher-first-time-after-installation-error.webp diff --git a/en/manual/get-started/media/stride-launcher-install-latest-version-prompt.webp b/en/manual/install-and-update/media/stride-launcher-install-latest-version-prompt.webp similarity index 100% rename from en/manual/get-started/media/stride-launcher-install-latest-version-prompt.webp rename to en/manual/install-and-update/media/stride-launcher-install-latest-version-prompt.webp diff --git a/en/manual/get-started/media/stride-launcher-ready.webp b/en/manual/install-and-update/media/stride-launcher-ready.webp similarity index 100% rename from en/manual/get-started/media/stride-launcher-ready.webp rename to en/manual/install-and-update/media/stride-launcher-ready.webp diff --git a/en/manual/get-started/media/stride-launcher.webp b/en/manual/install-and-update/media/stride-launcher.webp similarity index 100% rename from en/manual/get-started/media/stride-launcher.webp rename to en/manual/install-and-update/media/stride-launcher.webp diff --git a/en/manual/get-started/media/update-stride-packages.webp b/en/manual/install-and-update/media/update-stride-packages.webp similarity index 100% rename from en/manual/get-started/media/update-stride-packages.webp rename to en/manual/install-and-update/media/update-stride-packages.webp diff --git a/en/manual/get-started/media/update-stride-save-project.webp b/en/manual/install-and-update/media/update-stride-save-project.webp similarity index 100% rename from en/manual/get-started/media/update-stride-save-project.webp rename to en/manual/install-and-update/media/update-stride-save-project.webp diff --git a/en/manual/requirements/index.md b/en/manual/install-and-update/requirements.md similarity index 95% rename from en/manual/requirements/index.md rename to en/manual/install-and-update/requirements.md index fad0219f9..64f73b751 100644 --- a/en/manual/requirements/index.md +++ b/en/manual/install-and-update/requirements.md @@ -1,4 +1,4 @@ -# Development Requirements +# Requirements ## General requirements @@ -13,7 +13,7 @@ To develop projects with Stride, you need: | RAM | 4GB (minimum), 8GB (recommended) [see (2)] | .NET SDK | 8+ [see (3)] | -(1) Earlier versions of Windows _may_ work but are untested. +(1) Earlier versions of Windows _may_ work, but are untested. (2) RAM requirements vary depending on your project: * Developing simple 2D applications doesn't require much RAM. diff --git a/en/manual/get-started/update-stride.md b/en/manual/install-and-update/update-stride.md similarity index 100% rename from en/manual/get-started/update-stride.md rename to en/manual/install-and-update/update-stride.md diff --git a/en/manual/requirements/media/requirements.png b/en/manual/requirements/media/requirements.png deleted file mode 100644 index 468e4cdf3..000000000 --- a/en/manual/requirements/media/requirements.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:0d57d8b491c3b8dbaca46feab9b41593a48c71afce1032b274c979d52995443c -size 200362 From bddb29b980c1dc25a7102d62bf89412cf7e44acb Mon Sep 17 00:00:00 2001 From: Ferafiks Date: Fri, 19 Dec 2025 21:43:37 +0100 Subject: [PATCH 2/7] Finished most of the text on get-started and install-and-update --- en/manual/get-started/assets.md | 23 +++++++++- en/manual/get-started/game-studio.md | 2 + en/manual/get-started/key-concepts.md | 2 +- en/manual/get-started/next-steps.md | 20 ++++++++ .../install-and-update/install-stride.md | 10 +++- en/manual/toc.yml | 46 ++++++------------- 6 files changed, 68 insertions(+), 35 deletions(-) diff --git a/en/manual/get-started/assets.md b/en/manual/get-started/assets.md index 628fe7e4b..86452e012 100644 --- a/en/manual/get-started/assets.md +++ b/en/manual/get-started/assets.md @@ -2,6 +2,28 @@ Beginner +An asset is a representation of an element of your game inside Game Studio, such as texture, animation or model. + +## Create an asset + +To create an asset, click the "Add Asset" button in the **Asset View** and select the type of asset you want to create. + +![Image of the Asset View, showing ](asset-creation-create-new-asset-asset-view-tab.png) + +## Create assets from resources + +To create an asset from a resource, simply drag and drop it from a folder. + +[IMAGE HERE] + +Then, select the type of resource you want to create. + +[IMAGE HERE] + +You will be asked, if you want to **copy the dragged file to the resources folder**. Most of the time, **you want to do this**, in order to make the project easier to share and easier to use version control with. + +[IMAGE HERE] + ## Green, blue and gray dots [IMAGE OF 3 DIFFERENT ASSETS WITH 3 DIFFERENT COLORED DOTS HERE] @@ -12,7 +34,6 @@ Every asset has a little dot in the top left corner of their icon. This dot sign * Gray - the asset will not be included in the build. Stride doesn't include assets which aren't used anywhere, meaning that **the cannot be accessed when running the game**. - In order to ensure, that an asset will be included in the build no matter what, right click on it and select **Mark as root asset** (TODO: change this text to whatever it says in Game Studio). [IMAGE OF THE CONTEXT MENU HERE] diff --git a/en/manual/get-started/game-studio.md b/en/manual/get-started/game-studio.md index c627b1cb7..62428b751 100644 --- a/en/manual/get-started/game-studio.md +++ b/en/manual/get-started/game-studio.md @@ -38,6 +38,8 @@ Under each of those elements, there are 2 folders: **Assets** and **Code**. ## Asset View +[IMAGE HERE] + The **asset view** displays contents of a selected folder in the **[solution explorer](#solution-explorer)**. Items from the **asset view** can be dragged into other editors (for example: dragging a prefab into the scene in the **[Asset Editor](#asset-editor)**). diff --git a/en/manual/get-started/key-concepts.md b/en/manual/get-started/key-concepts.md index 14d95f3bc..f44a37443 100644 --- a/en/manual/get-started/key-concepts.md +++ b/en/manual/get-started/key-concepts.md @@ -51,7 +51,7 @@ For more information, read [types of script](../scripts/types-of-script). An **asset** is a representation of an element in the project (like a texture), that contains a list of it's properties in the engine (e.g. `.sdmat` `.sdprefab`). -A **resource** is a file on the disk containing data, like an image (e.g. `.png` `.mp3`). +A **resource** is a file on the disk containing data, like an image (e.g. `.png` `.mp3`), that's used in the project. Assets do not contain resource data. Instead, they reference a resource. For example: a texture asset (`.sdtex`) has a reference to an image (`.png`) that is located in the resource folder. diff --git a/en/manual/get-started/next-steps.md b/en/manual/get-started/next-steps.md index 4b21edc4d..afe22a704 100644 --- a/en/manual/get-started/next-steps.md +++ b/en/manual/get-started/next-steps.md @@ -3,3 +3,23 @@ Congratulations, by this point you should have everything to get yourself started with Stride! The best way of learning more about the engine is to **just start making something**. Alternatively, you can check out one of the [built-in examples](create-a-project.md#create-a-project-from-a-sample-or-template) or those provided [by the community](../../community-resources/example-projects.md). + +In case you **get confused by certain terminology**, you can check out the [glossary](../glossary/index.md), which contains a list of all terms used in the documentation and the engine. + +## Learn more about Game Studio + +If you want to learn more about how to use Game Studio, check out the [Game Studio section](../game-studio/index.md) of the manual. + +## Get Started with scripting + +If you want to learn more about how to write scripts for Stride, check out the [Scripts section](../scripts/index.md) of the manual. + +For API reference, refer to the [API](../../api/index.md). + +## Get Started with graphics + +For general information about how graphics work in Stride, check out the [Graphics section](../graphics/index.md) section of the manual. + +Other sections that might be useful are [Animation](../animation/index.md) and [Particles](../particles/index.md). + +For 2D, it's also a good idea to check out the [Sprites section](../sprites/index.md). diff --git a/en/manual/install-and-update/install-stride.md b/en/manual/install-and-update/install-stride.md index f1e27121f..bf2ebf2bf 100644 --- a/en/manual/install-and-update/install-stride.md +++ b/en/manual/install-and-update/install-stride.md @@ -43,8 +43,14 @@ If you're interested in **building the Stride engine from source** or **contribu > If you click **Start** and see an error message such as `Could not find a compatible version of MSBuild.` or `Path to dotnet executable is not set.`, close the Stride Launcher and restart it. This issue is caused by the Stride Launcher not detecting the .NET SDK installation. Restarting the Stride Launcher should resolve the issue. Alternatively, restart your computer. > > Example error: ![First launch error](media/stride-launcher-first-time-after-installation-error.webp) - -# Troubleshooting + +## Installation Location + +The engine and it's editor Game Studio are a [NuGet package](https://learn.microsoft.com/en-us/nuget/what-is-nuget), which is the packaging format used in C# projects. This means that **Stride's installation location is managed by the NuGet package manager** and **can't be easily changed by the user**. + +Changing the installation location is possible, but it is outside of the scope of this page. + +## Troubleshooting If you don't install the prerequisites, Stride won't run. In this case, you can download and install the prerequisites separately. For instructions, see [Troubleshooting — Stride doesn't run](../troubleshooting/stride-doesnt-run.md). diff --git a/en/manual/toc.yml b/en/manual/toc.yml index 916149a61..ad20dad79 100644 --- a/en/manual/toc.yml +++ b/en/manual/toc.yml @@ -3,50 +3,34 @@ pdfFileName: stride-manual.pdf items: - name: Manual href: index.md - - name: Requirements - href: requirements/index.md - name: Stride for Unity® developers href: stride-for-unity-developers/index.md # - name: Stride for Godot developers # href: stride-for-godot-developers/index.md - - name: Stride Launcher - href: stride-launcher/index.md - - - name: Get started - href: get-started/index.md + - name: Install and Update + href: install-and-update/index.md items: + - name: Requirements + href: install-and-update/requirements.md - name: Install Stride - href: get-started/install-stride.md - - name: Visual Studio extension - href: get-started/visual-studio-extension.md + href: install-and-update/install-stride.md - name: Update Stride - href: get-started/update-stride.md - - name: Launch Stride - href: get-started/launch-stride.md + href: install-and-update/update-stride.md + - name: Get started + href: get-started/index.md + items: - name: Create a project href: get-started/create-a-project.md + - name: Key Concepts + href: get-started/key-concepts.md - name: Game Studio - href: game-studio/index.md + href: get-started/game-studio.md - name: Assets - href: game-studio/assets.md - items: - - name: Create assets - href: game-studio/create-assets.md - - name: Use assets - href: game-studio/use-assets.md - - name: Scenes - href: game-studio/scenes.md - items: - - name: Create a scene - href: game-studio/create-a-scene.md - - name: Add entities - href: game-studio/add-entities.md - - name: Manage entities - href: game-studio/manage-entities.md - - name: Navigate in the Scene Editor - href: game-studio/navigate-in-the-scene-editor.md + href: get-started/assets.md - name: Launch a game href: get-started/launch-a-game.md + - name: Next Steps + href: get-started/next-steps.md - name: Animation href: animation/index.md From 288a069fa69b44fa2b655bbb47fe3d34bd69f9fe Mon Sep 17 00:00:00 2001 From: Ferafiks Date: Fri, 19 Dec 2025 21:48:34 +0100 Subject: [PATCH 3/7] Changed path for the requirements file on contributors major release workflow page --- en/contributors/documentation/major-release-workflow.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/en/contributors/documentation/major-release-workflow.md b/en/contributors/documentation/major-release-workflow.md index 6c82cea8e..959c5332a 100644 --- a/en/contributors/documentation/major-release-workflow.md +++ b/en/contributors/documentation/major-release-workflow.md @@ -2,7 +2,7 @@ Assuming the transition is from version `4.1` to `4.2`, and that the Stride source code has been updated to the corresponding .NET version, follow these steps. Note that some steps can be executed at a later stage if needed. -1. Update `manual\requirements\index.md` to reflect the new .NET version references +1. Update `manual\install-and-update\requirements.md` to reflect the new .NET version references 1. Duplicate `ReleaseNotes\ReleaseNotes.md` and rename the copy to `ReleaseNotes-4.1.md` 1. Update `ReleaseNotes.md`: - Change the content title to `4.2` @@ -48,4 +48,4 @@ The `BuildDocs.ps1` script will manage the deployment to the `4.2` folder while - Update Visual Studio version 1. Modify `includes\docs-prerequisites.md` - Update SDK and .NET version references - - Update Visual Studio version + - Update Visual Studio version From 4f4a4d0205ac96dded61420a1a044e5e31025c09 Mon Sep 17 00:00:00 2001 From: Ferafiks Date: Fri, 2 Jan 2026 20:01:18 +0100 Subject: [PATCH 4/7] Added images --- en/manual/get-started/assets.md | 25 ++++++++++--------- en/manual/get-started/game-studio.md | 12 ++++----- en/manual/get-started/key-concepts.md | 4 +-- en/manual/get-started/media/asset-editor.webp | 3 +++ .../media/asset-view-add-asset.png | 3 +++ .../media/asset-view-copy-resource.webp | 3 +++ .../media/asset-view-create-new.webp | 3 +++ .../media/asset-view-from-resource-type.webp | 3 +++ .../media/asset-view-include-root.webp | 3 +++ .../media/asset-view-indicators.webp | 3 +++ .../asset-view-resource-default-location.webp | 3 +++ en/manual/get-started/media/asset-view.webp | 3 +++ en/manual/get-started/media/game-studio.webp | 3 +++ .../get-started/media/property-grid.webp | 3 +++ .../get-started/media/scene-nesting.webp | 3 +++ .../get-started/media/solution-explorer.webp | 3 +++ .../install-and-update/install-stride.md | 2 +- .../media/vs-extension.webp | 3 +++ 18 files changed, 62 insertions(+), 23 deletions(-) create mode 100644 en/manual/get-started/media/asset-editor.webp create mode 100755 en/manual/get-started/media/asset-view-add-asset.png create mode 100644 en/manual/get-started/media/asset-view-copy-resource.webp create mode 100644 en/manual/get-started/media/asset-view-create-new.webp create mode 100644 en/manual/get-started/media/asset-view-from-resource-type.webp create mode 100644 en/manual/get-started/media/asset-view-include-root.webp create mode 100644 en/manual/get-started/media/asset-view-indicators.webp create mode 100644 en/manual/get-started/media/asset-view-resource-default-location.webp create mode 100644 en/manual/get-started/media/asset-view.webp create mode 100644 en/manual/get-started/media/game-studio.webp create mode 100644 en/manual/get-started/media/property-grid.webp create mode 100644 en/manual/get-started/media/scene-nesting.webp create mode 100644 en/manual/get-started/media/solution-explorer.webp create mode 100644 en/manual/install-and-update/media/vs-extension.webp diff --git a/en/manual/get-started/assets.md b/en/manual/get-started/assets.md index 86452e012..300f78adb 100644 --- a/en/manual/get-started/assets.md +++ b/en/manual/get-started/assets.md @@ -8,32 +8,33 @@ An asset is a representation of an element of your game inside Game Studio, such To create an asset, click the "Add Asset" button in the **Asset View** and select the type of asset you want to create. -![Image of the Asset View, showing ](asset-creation-create-new-asset-asset-view-tab.png) +![Image of the "Add Asset" menu in the asset view.](media/asset-view-create-new.webp) ## Create assets from resources To create an asset from a resource, simply drag and drop it from a folder. -[IMAGE HERE] - Then, select the type of resource you want to create. -[IMAGE HERE] +![Popup showing a list of assets that can be created from the dragged resource.](media/asset-view-from-resource-type.webp) You will be asked, if you want to **copy the dragged file to the resources folder**. Most of the time, **you want to do this**, in order to make the project easier to share and easier to use version control with. -[IMAGE HERE] +![A popup "Source file 'C:/Users/franc/Downloads/Grass0044K-PNG/Grass0044K-PNG_Color.png' is not inside of your project's resource folders, do you want to copy it?" with two options "yes" and "no".](media/asset-view-copy-resource.webp) + +Finally, you will be asked if you want to **move it to the default location**. Again, most of the time **you want to do this**, unless you want to have more control over where resources end up. + +![A popup "Do you want to place the resource in the default location ?" with two options "yes" and "no"](media/asset-view-resource-default-location.webp) ## Green, blue and gray dots -[IMAGE OF 3 DIFFERENT ASSETS WITH 3 DIFFERENT COLORED DOTS HERE] +![A screenshot of three items in the Asset View, all having a small circle in the top left corner of their icon with one being blue, one green and one gray.](media/asset-view-indicators.webp) Every asset has a little dot in the top left corner of their icon. This dot signifies if an asset is going to be included when building the project: -* Green - the asset will be included in the build, because a different asset needs it. -* Blue - the asset will be included in the build no matter if it's needed or not. -* Gray - the asset will not be included in the build. +* **Green** - the asset will be included in the build, because a different asset needs it. +* **Blue** - the asset will be included in the build no matter if it's needed or not. +* **Gray** - the asset will not be included in the build. -Stride doesn't include assets which aren't used anywhere, meaning that **the cannot be accessed when running the game**. -In order to ensure, that an asset will be included in the build no matter what, right click on it and select **Mark as root asset** (TODO: change this text to whatever it says in Game Studio). +Stride doesn't include assets which aren't used anywhere, meaning that **the cannot be accessed when running the game**. In order to ensure, that an asset will be included in the build no matter what, right click on it and select **Include in build as root asset**. -[IMAGE OF THE CONTEXT MENU HERE] +![A screenshot of an asset's context menu, highlighting an item "Include in build as root asset".](media/asset-view-include-root.webp) diff --git a/en/manual/get-started/game-studio.md b/en/manual/get-started/game-studio.md index 62428b751..7b52ba131 100644 --- a/en/manual/get-started/game-studio.md +++ b/en/manual/get-started/game-studio.md @@ -4,17 +4,17 @@ **Game Studio** is an essential tool, used for editing assets, arranging scenes and much more. It's important to familiarize yourself with it's layout. -[IMAGE HERE] +![An image showing the Game Studio.](media/game-studio.webp) ## Asset Editor -[IMAGE HERE] +![An image showing a scene being edited in the Asset Editor.](media/asset-editor.webp) The **asset editor** is a dedicated editor for certain assets. It's most commonly used for editing scenes and their entities. ## Property Grid -[IMAGE HERE] +![An image showing an entity names "Ground" in the property grid with a single component.](media/property-grid.webp) The **property grid** displays a list of properties of selected assets and entities. @@ -22,7 +22,7 @@ This is where you can assign [Components](key-concepts#components) to entities a ## Solution Explorer -[IMAGE HERE] +![An image of the solution explorer.](media/solution-explorer.webp) The **solution explorer** displays the hierarchy of elements in the C# solution associated with the Project. These elements contain assets and code. @@ -34,11 +34,9 @@ Under each of those elements, there are 2 folders: **Assets** and **Code**. * **Assets** contains all assets of that element. * **Code** contains all code of that element. -[IMAGE HERE] - ## Asset View -[IMAGE HERE] +![An image of the asset view.](media/asset-view.webp) The **asset view** displays contents of a selected folder in the **[solution explorer](#solution-explorer)**. diff --git a/en/manual/get-started/key-concepts.md b/en/manual/get-started/key-concepts.md index f44a37443..bb9fa32cb 100644 --- a/en/manual/get-started/key-concepts.md +++ b/en/manual/get-started/key-concepts.md @@ -10,7 +10,7 @@ A scene is a collection of entities that can be loaded and unloaded on demand. M In Stride, Scenes can contain sub-scenes that can be loaded and unloaded on demand. -[IMAGE HERE] +![An image showing a scene structure with multiple subscenes containing entities.](media/scene-nesting.webp) ## Entities @@ -20,8 +20,6 @@ Entities represent different objects in a scene, like the player, enemies, walls Components dictate how entities which they are attached to behave. For example: a player movement component that makes an entity move, when keyboard buttons are pressed. -[IMAGE HERE] - In code, a component is a class that inherits `StartupScript`, `SyncScript` or `AsyncScript`. ```csharp diff --git a/en/manual/get-started/media/asset-editor.webp b/en/manual/get-started/media/asset-editor.webp new file mode 100644 index 000000000..971045a8d --- /dev/null +++ b/en/manual/get-started/media/asset-editor.webp @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b72133c95aef4c8c4d6b5c7e3f6d8c75f0b1d79b76526ae5f19e7195701136bc +size 50884 diff --git a/en/manual/get-started/media/asset-view-add-asset.png b/en/manual/get-started/media/asset-view-add-asset.png new file mode 100755 index 000000000..e5b1df3a0 --- /dev/null +++ b/en/manual/get-started/media/asset-view-add-asset.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:29fd0354ff9a0274f5414a4b8e08c6df12961657e1c9a49815ee2d10944bcb64 +size 46465 diff --git a/en/manual/get-started/media/asset-view-copy-resource.webp b/en/manual/get-started/media/asset-view-copy-resource.webp new file mode 100644 index 000000000..578755d21 --- /dev/null +++ b/en/manual/get-started/media/asset-view-copy-resource.webp @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:11ba16dc9e522f6272ca3f7164cc53db9e3717400a9a509033a29f9eddecd131 +size 8386 diff --git a/en/manual/get-started/media/asset-view-create-new.webp b/en/manual/get-started/media/asset-view-create-new.webp new file mode 100644 index 000000000..9745c165e --- /dev/null +++ b/en/manual/get-started/media/asset-view-create-new.webp @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:bbdde6f73ec33ab52080e5212fda52e7d63c8d93c0fab120e626cd2a236b2326 +size 26134 diff --git a/en/manual/get-started/media/asset-view-from-resource-type.webp b/en/manual/get-started/media/asset-view-from-resource-type.webp new file mode 100644 index 000000000..18ccd73ff --- /dev/null +++ b/en/manual/get-started/media/asset-view-from-resource-type.webp @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:cf84a5d8a6e8a2aab3551077f8a443738d428e2cf36081f604d3caa23021d3ef +size 30768 diff --git a/en/manual/get-started/media/asset-view-include-root.webp b/en/manual/get-started/media/asset-view-include-root.webp new file mode 100644 index 000000000..144ccb081 --- /dev/null +++ b/en/manual/get-started/media/asset-view-include-root.webp @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9e6b611ebef01f109695e5b62e227772d53ca0f350a667bbc984dc9603bd21fe +size 7488 diff --git a/en/manual/get-started/media/asset-view-indicators.webp b/en/manual/get-started/media/asset-view-indicators.webp new file mode 100644 index 000000000..9e0e1646e --- /dev/null +++ b/en/manual/get-started/media/asset-view-indicators.webp @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b973a2572da45198833b371e8dac5d82384fcb0f39204e46fb83de0aad4a87a2 +size 13054 diff --git a/en/manual/get-started/media/asset-view-resource-default-location.webp b/en/manual/get-started/media/asset-view-resource-default-location.webp new file mode 100644 index 000000000..67b18c16d --- /dev/null +++ b/en/manual/get-started/media/asset-view-resource-default-location.webp @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7e1dad96e03f4059a9c012c61c51147c9c7b5ad399748f41faf965b76e470416 +size 5150 diff --git a/en/manual/get-started/media/asset-view.webp b/en/manual/get-started/media/asset-view.webp new file mode 100644 index 000000000..67bd3ab09 --- /dev/null +++ b/en/manual/get-started/media/asset-view.webp @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:62ed1402cd50cc34177846d35b1b958777b624ace6916f8541b93fd0e97dc689 +size 25040 diff --git a/en/manual/get-started/media/game-studio.webp b/en/manual/get-started/media/game-studio.webp new file mode 100644 index 000000000..aef55a96e --- /dev/null +++ b/en/manual/get-started/media/game-studio.webp @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:588276355bcbd10f282b7a442db66c2757be1729063bc2a979215e3872a227e9 +size 101650 diff --git a/en/manual/get-started/media/property-grid.webp b/en/manual/get-started/media/property-grid.webp new file mode 100644 index 000000000..aaacedc67 --- /dev/null +++ b/en/manual/get-started/media/property-grid.webp @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:949a7cb10882328dbbeb5b22bcfa1f1ee8478bb40a463a67ef231f414a693bd2 +size 17116 diff --git a/en/manual/get-started/media/scene-nesting.webp b/en/manual/get-started/media/scene-nesting.webp new file mode 100644 index 000000000..3a77547e1 --- /dev/null +++ b/en/manual/get-started/media/scene-nesting.webp @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7a74bf87634d9c2552e7431a4bce5f9e38f0a0b2e08aa116cea2bfafcac39b59 +size 10446 diff --git a/en/manual/get-started/media/solution-explorer.webp b/en/manual/get-started/media/solution-explorer.webp new file mode 100644 index 000000000..ab90541d1 --- /dev/null +++ b/en/manual/get-started/media/solution-explorer.webp @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:27a3a6b10396d3b34e05762ec20d458319d878beca2f2f9d155cac6de37ddffe +size 10268 diff --git a/en/manual/install-and-update/install-stride.md b/en/manual/install-and-update/install-stride.md index bf2ebf2bf..0df0e0071 100644 --- a/en/manual/install-and-update/install-stride.md +++ b/en/manual/install-and-update/install-stride.md @@ -65,7 +65,7 @@ The Visual Studio integration is an optional extension for Visual Studio. The extension can be installed via the launcher, by navigating to the **Visual Studio extension** section. -[INSERT PHOTO HERE] +![Image of the "Visual Studio extension" section in the Stride Launcher.](media/vs-extension.webp) ## What's next? diff --git a/en/manual/install-and-update/media/vs-extension.webp b/en/manual/install-and-update/media/vs-extension.webp new file mode 100644 index 000000000..28b415851 --- /dev/null +++ b/en/manual/install-and-update/media/vs-extension.webp @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:37caf9c0296dcc21a0ae6cb126bd4119e4e23c6b49723fa1022b4d58785be8e0 +size 5412 From 6d6c0cf0ca427f1fd72af903f921e818450b9ec8 Mon Sep 17 00:00:00 2001 From: Ferafiks Date: Fri, 2 Jan 2026 20:12:14 +0100 Subject: [PATCH 5/7] Updates links in pages --- en/manual/get-started/create-a-project.md | 6 +----- en/manual/get-started/index.md | 2 ++ en/manual/install-and-update/install-stride.md | 4 ---- en/manual/install-and-update/update-stride.md | 2 +- 4 files changed, 4 insertions(+), 10 deletions(-) diff --git a/en/manual/get-started/create-a-project.md b/en/manual/get-started/create-a-project.md index 698d774dc..5e2e8fd29 100644 --- a/en/manual/get-started/create-a-project.md +++ b/en/manual/get-started/create-a-project.md @@ -82,8 +82,4 @@ To create a project from a sample or template: 5. Select the platforms you want your game to support and click **OK**. -Stride creates the project and opens it in Game Studio. - -## What's next? - -* [Get familiar with Game Studio](../game-studio/index.md) \ No newline at end of file +Stride creates the project and opens it in Game Studio. diff --git a/en/manual/get-started/index.md b/en/manual/get-started/index.md index 738928471..34688097e 100644 --- a/en/manual/get-started/index.md +++ b/en/manual/get-started/index.md @@ -17,5 +17,7 @@ For video tutorials, have a look at the [Tutorials](../../tutorials/index.md). * [Create a project](create-a-project.md) * [Key Concepts](key-concepts.md) +* [Game Studio](game-studio.md) +* [Assets](assets.md) * [Launch your game](launch-a-game.md) * [Next steps](next-steps.md) diff --git a/en/manual/install-and-update/install-stride.md b/en/manual/install-and-update/install-stride.md index 0df0e0071..5f79bca46 100644 --- a/en/manual/install-and-update/install-stride.md +++ b/en/manual/install-and-update/install-stride.md @@ -66,7 +66,3 @@ The Visual Studio integration is an optional extension for Visual Studio. The extension can be installed via the launcher, by navigating to the **Visual Studio extension** section. ![Image of the "Visual Studio extension" section in the Stride Launcher.](media/vs-extension.webp) - -## What's next? - -* [Launch Stride](launch-stride.md) diff --git a/en/manual/install-and-update/update-stride.md b/en/manual/install-and-update/update-stride.md index a173da471..ef8009327 100644 --- a/en/manual/install-and-update/update-stride.md +++ b/en/manual/install-and-update/update-stride.md @@ -22,4 +22,4 @@ Updating Stride is a straightforward process, but it's important to follow the s ![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. \ No newline at end of file +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. From ef1d01d2ac31b18e19f4df293724f0d2afc92e2d Mon Sep 17 00:00:00 2001 From: Ferafiks Date: Fri, 2 Jan 2026 20:28:30 +0100 Subject: [PATCH 6/7] Updated install-stride troubleshooting --- .../install-and-update/install-stride.md | 30 ++++++++----------- 1 file changed, 12 insertions(+), 18 deletions(-) diff --git a/en/manual/install-and-update/install-stride.md b/en/manual/install-and-update/install-stride.md index 5f79bca46..99aa7e0bd 100644 --- a/en/manual/install-and-update/install-stride.md +++ b/en/manual/install-and-update/install-stride.md @@ -6,15 +6,8 @@ If you want to **create games using Stride**, this guide provides the installation steps you'll need to follow. -The installer will automatically download and install the prerequisites if they are not detected, including the [Stride Launcher](launch-stride.md), which is essential for downloading and installing the latest version of Stride for game development. - If you're interested in **building the Stride engine from source** or **contributing to its development**, please visit the [Stride GitHub repository](https://github.com/stride3d/stride) for instructions on how to build from source and contribute to the project. -**Prerequisites (automatically installed if not present):** - -- Latest **.NET SDK** supported by Stride -- Microsoft Visual C++ Redistributable - ## Installation Steps 1. Download the Stride Installer from the [Stride website](http://stride3d.net/download/). @@ -39,23 +32,12 @@ If you're interested in **building the Stride engine from source** or **contribu ![Stride ready to use](media/stride-launcher-ready.webp) -> [!Note] -> If you click **Start** and see an error message such as `Could not find a compatible version of MSBuild.` or `Path to dotnet executable is not set.`, close the Stride Launcher and restart it. This issue is caused by the Stride Launcher not detecting the .NET SDK installation. Restarting the Stride Launcher should resolve the issue. Alternatively, restart your computer. -> -> Example error: ![First launch error](media/stride-launcher-first-time-after-installation-error.webp) - ## Installation Location The engine and it's editor Game Studio are a [NuGet package](https://learn.microsoft.com/en-us/nuget/what-is-nuget), which is the packaging format used in C# projects. This means that **Stride's installation location is managed by the NuGet package manager** and **can't be easily changed by the user**. Changing the installation location is possible, but it is outside of the scope of this page. -## Troubleshooting - -If you don't install the prerequisites, Stride won't run. In this case, you can download and install the prerequisites separately. For instructions, see [Troubleshooting — Stride doesn't run](../troubleshooting/stride-doesnt-run.md). - -Alternatively, uninstall Stride, restart the Stride installer, and install the prerequisites when prompted. - ## Visual Studio integration The Visual Studio integration is an optional extension for Visual Studio. @@ -66,3 +48,15 @@ The Visual Studio integration is an optional extension for Visual Studio. The extension can be installed via the launcher, by navigating to the **Visual Studio extension** section. ![Image of the "Visual Studio extension" section in the Stride Launcher.](media/vs-extension.webp) + +## Troubleshooting + +### `Could not find a compatible version of MSBuild.` or `Path to dotnet executable is not set.` + +If you click **Start** and see one of the above error messages, close the Stride Launcher and restart it. This issue is caused by the Stride Launcher not detecting the .NET SDK installation. Restarting the Stride Launcher should resolve the issue. Alternatively, restart your computer. + +Example error: ![First launch error](media/stride-launcher-first-time-after-installation-error.webp) + +### Stride still refuses to open + +If you are still having issues with getting Stride to run, see [Troubleshooting — Stride doesn't run](../troubleshooting/stride-doesnt-run.md). From a2d32f9629d15f0818067e56a87dcf3c417d7fee Mon Sep 17 00:00:00 2001 From: Ferafiks Date: Sat, 3 Jan 2026 14:24:53 +0100 Subject: [PATCH 7/7] Fixes --- en/manual/get-started/assets.md | 10 +++++----- en/manual/install-and-update/install-stride.md | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/en/manual/get-started/assets.md b/en/manual/get-started/assets.md index 300f78adb..db0ccd8db 100644 --- a/en/manual/get-started/assets.md +++ b/en/manual/get-started/assets.md @@ -18,11 +18,11 @@ Then, select the type of resource you want to create. ![Popup showing a list of assets that can be created from the dragged resource.](media/asset-view-from-resource-type.webp) -You will be asked, if you want to **copy the dragged file to the resources folder**. Most of the time, **you want to do this**, in order to make the project easier to share and easier to use version control with. +You will be asked, if you want to **copy the dragged file to the resources folder**. Most of the time, **you want to do this**, in order to make the project easier to share and use version control with. ![A popup "Source file 'C:/Users/franc/Downloads/Grass0044K-PNG/Grass0044K-PNG_Color.png' is not inside of your project's resource folders, do you want to copy it?" with two options "yes" and "no".](media/asset-view-copy-resource.webp) -Finally, you will be asked if you want to **move it to the default location**. Again, most of the time **you want to do this**, unless you want to have more control over where resources end up. +Finally, you will be asked if you want to **move it to the default location**. Again, most of the time **you want to do this**, unless you need more control over where resources end up. ![A popup "Do you want to place the resource in the default location ?" with two options "yes" and "no"](media/asset-view-resource-default-location.webp) @@ -30,11 +30,11 @@ Finally, you will be asked if you want to **move it to the default location**. A ![A screenshot of three items in the Asset View, all having a small circle in the top left corner of their icon with one being blue, one green and one gray.](media/asset-view-indicators.webp) -Every asset has a little dot in the top left corner of their icon. This dot signifies if an asset is going to be included when building the project: -* **Green** - the asset will be included in the build, because a different asset needs it. +Every asset has a little dot in the top left corner of their icon. This dot indicates if an asset is going to be included when building the project: * **Blue** - the asset will be included in the build no matter if it's needed or not. +* **Green** - the asset will be included in the build, because a different asset needs it. * **Gray** - the asset will not be included in the build. -Stride doesn't include assets which aren't used anywhere, meaning that **the cannot be accessed when running the game**. In order to ensure, that an asset will be included in the build no matter what, right click on it and select **Include in build as root asset**. +Stride doesn't include assets which aren't used anywhere, meaning that **they cannot be accessed when running the game**. In order to ensure, that an asset will always be included in the build, right click on it and select **Include in build as root asset**. ![A screenshot of an asset's context menu, highlighting an item "Include in build as root asset".](media/asset-view-include-root.webp) diff --git a/en/manual/install-and-update/install-stride.md b/en/manual/install-and-update/install-stride.md index 99aa7e0bd..102503f4d 100644 --- a/en/manual/install-and-update/install-stride.md +++ b/en/manual/install-and-update/install-stride.md @@ -36,7 +36,7 @@ If you're interested in **building the Stride engine from source** or **contribu The engine and it's editor Game Studio are a [NuGet package](https://learn.microsoft.com/en-us/nuget/what-is-nuget), which is the packaging format used in C# projects. This means that **Stride's installation location is managed by the NuGet package manager** and **can't be easily changed by the user**. -Changing the installation location is possible, but it is outside of the scope of this page. +Changing the installation location is possible, but this is outside of the scope of this page. ## Visual Studio integration