Skip to content

Commit

Permalink
Merge pull request #351 from stride3d/master
Browse files Browse the repository at this point in the history
Initiating deployment of latest docs updates to staging
  • Loading branch information
VaclavElias authored Nov 9, 2024
2 parents f6c4938 + 87d3d9d commit 7cd708e
Show file tree
Hide file tree
Showing 84 changed files with 272 additions and 214 deletions.
52 changes: 32 additions & 20 deletions en/contributors/engine/building-source-windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,38 +2,50 @@

## Prerequisites

1. **Latest** [Git](https://git-scm.com/downloads) **with Large File Support** selected in the setup on the components dialog and for convenience a git UI client like [GitExtensions](https://gitextensions.github.io/).
2. [.NET 8.0 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
- Run `dotnet --info` in a console or powershell window to see which versions you have installed
3. [Visual Studio 2022](https://www.visualstudio.com/downloads/) with the following workloads:
- `.NET desktop development` with `.NET Framework 4.7.2 targeting pack` (should be enabled by default)
- `Desktop development with C++` with
- `Windows 10 SDK (10.0.18362.0)` or later version (should be enabled by default)
- `MSVC v143 - VS2022 C++ x64/x86 build tools (Latest)` (should be enabled by default)
- `C++/CLI support for v143 build tools (Latest)` **(not enabled by default)**
- Optional (to target iOS/Android): `.NET Multi-paltform App UI development` and `Android SDK setup` individual component (enabled by default), then in Visual Studio go to `Tools > Android > Android SDK Manager` and install `NDK` (version 20.1+) from `Tools` tab.
- Optional (to build VSIX package): `Visual Studio extension development`
1. **Latest [Git](https://git-scm.com/downloads)** with **Large File Support** selected during setup. For convenience, you might also use a Git UI client like [GitExtensions](https://gitextensions.github.io/).
2. **[.NET 8.0 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)**
- Run `dotnet --info` in a console or PowerShell window to see which versions you have installed.
3. **[Visual Studio 2022](https://visualstudio.microsoft.com/downloads/)** (the Community edition is free) with the following workloads:
- **.NET desktop development** with **.NET Framework 4.7.2 targeting pack** (should be enabled by default)
- **Desktop development with C++** with:
- **Windows 11 SDK (10.0.22621.0)** or a later version (should be enabled by default)
- **MSVC v143 - VS2022 C++ x64/x86 build tools (Latest)** (should be enabled by default)
- **C++/CLI support for v143 build tools (Latest)** *(not enabled by default)*
- *Optional* (to target iOS/Android): **.NET Multi-platform App UI development** and the **Android SDK setup** individual component (enabled by default). Then, in Visual Studio, go to `Tools > Android > Android SDK Manager` and install **NDK** (version 20.1+) from the `Tools` tab.
- *Optional* (to build the VSIX package): **Visual Studio extension development**

> [!NOTE]
> The installation of Visual Studio with the required components may require up to **14 GB of disk space**, depending on your system and selected components.
> [!WARNING]
> If this is your first time installing the .NET SDK, you might need to restart your system after the installation so that the system can recognize the new environment variables.
## Build Stride with Visual Studio 2022
Here are the steps to build Stride with Visual Studio. If you do not have or want to use Visual Studio, see [building with other IDEs](building-source-windows-other-ide.md)

1. Open a command prompt, point it to a directory and clone Stride to it: `git clone https://github.com/stride3d/stride.git`
- Note that when you use GitHub -> Code -> Download ZIP, this doesn't support Large File Support ```lfs```, make sure you use the command above or that your git client does it for you
2. Open `<StrideDir>\build\Stride.sln` with Visual Studio 2022 and build `Stride.GameStudio` in the 60-Editor solution folder (it should be the default startup project) or run it from VS's toolbar.
- Optionally, open and build `Stride.Android.sln`, `Stride.iOS.sln`, etc.
1. **Clone the repository** using a Git UI client or from the command line:
```bash
git lfs clone https://github.com/stride3d/stride.git
```
2. **Open the solution:**
- Open `<StrideDir>\build\Stride.sln` with Visual Studio 2022.
- Build the `Stride.GameStudio` project in the `60-Editor` solution folder (it should be the default startup project) or run it directly from Visual Studio's toolbar.
- _Optionally_, open and build `Stride.Android.sln`, `Stride.iOS.sln`, etc.

> [!WARNING]
> **Do NOT use GitHub -> Code -> Download ZIP** option, as this won't include the LFS files.
### If building failed
* If you skipped one of the `Prerequisites` thinking that you already have the latest version, update to the latest anyway just to be sure.
* Visual Studio might have issues properly building if an anterior version is present alongside 2022. If you want to keep those version make sure that they are up to date and that you are building Stride through VS 2022.
* Your system's *PATH* should not contain older versions of MSBuild (ex: `...\Microsoft Visual Studio\2019\BuildTools\MSBuild\Current\Bin` should be removed)
* Some changes might require a system reboot, try that if you haven't yet.
* Some changes might require a system reboot. Try that if you haven't yet, for example, if you see these errors:
* `Could not find a compatible version of MSBuild.`
* `Path to dotnet executable is not set.`
* Make sure that Git, Git LFS and Visual Studio can access the internet.
* Close VS, clear the nuget cache (in your cmd `dotnet nuget locals all --clear`), delete the hidden `.vs` folder inside `\build` and the files inside `bin\packages`, kill any msbuild and other vs processes, build the whole solution then build and run GameStudio.

Do note that test solutions might fail but it should not prevent you from building `Stride.GameStudio`.

## Other IDEs
You are not required to use Visual Studio to build the Stride engine with Visual Studio. You can also build entirely from command line or other IDE's such as [Rider or Visual Studio Code](building-source-windows-other-ide.md).



You are not required to use Visual Studio to build the Stride engine with Visual Studio. You can also build entirely from command line or other IDE's such as [Rider or Visual Studio Code](building-source-windows-other-ide.md).
11 changes: 6 additions & 5 deletions en/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,13 @@
},
"fileMetadata": {
"_appTitle": {
"tutorials/**/*.md": "Stride Tutorials",
"manual/**/*.md": "Stride Manual",
"ReleaseNotes/**/*.md": "Stride Release notes",
"tutorials/**/*.md": "Stride tutorials",
"manual/**/*.md": "Stride manual",
"ReleaseNotes/**/*.md": "Stride release notes",
"api/**/*.md": "Stride API",
"diagnostics/**/*.md": "Stride Diagnostics",
"contributors/**/*.md": "Stride Contributors",
"api/**/*.yml": "Stride API",
"diagnostics/**/*.md": "Stride diagnostics",
"contributors/**/*.md": "Stride contributors",
"community-resources/**/*.md": "Stride Community resources"
}
},
Expand Down
12 changes: 6 additions & 6 deletions en/manual/game-studio/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@ Game Studio is also integrated with your Visual Studio projects, so you can seam

## Interface

![Game Studio](../get-started/media/game-studio-main-interface.png)
![Game Studio](../get-started/media/game-studio-main-interface.webp)

The **asset editor** (A) is used to edit assets and scenes. Some asset types, such as [scenes](create-a-scene.md), have dedicated editors where you can make complex changes to the asset. To open a dedicated editor (when available), double-click the asset or right-click it and select **Edit asset**.
The **asset editor** (1) is used to edit assets and scenes. Some asset types, such as [scenes](create-a-scene.md), have dedicated editors where you can make complex changes to the asset. To open a dedicated editor (when available), double-click the asset or right-click it and select **Edit asset**.

The **Property Grid** (B) displays the properties of the asset or entity you select. You can edit the properties here.
The **Property Grid** (2) displays the properties of the asset or entity you select. You can edit the properties here.

The **Solution Explorer** (C) displays the hierarchy of the elements of your project, such as assets, code files, packages and dependencies. You can create folders and objects, rename them, and move them.
The **Solution Explorer** (3) displays the hierarchy of the elements of your project, such as assets, code files, packages and dependencies. You can create folders and objects, rename them, and move them.

The **Asset View** (D) displays the project assets. You can create new assets using the **New Asset** button or by dragging and dropping resource files into the Asset View. You can also drag and drop assets from the Asset View to the different editors or the Property Grid to Create an instance of the asset or add a reference to it. By default, the Asset View is in the bottom center.
The **Asset View** (4) displays the project assets. You can create new assets using the **New Asset** button or by dragging and dropping resource files into the Asset View. You can also drag and drop assets from the Asset View to the different editors or the Property Grid to Create an instance of the asset or add a reference to it. By default, the Asset View is in the bottom center.

The **Asset Preview** tab (E) displays a preview of the selected asset. The preview changes based on the type of the asset you have selected. For example, you can play animations and sounds. This is a quick way to check changes to an asset when editing it in the Property Grid. By default, the Asset Preview is in the bottom right.
The **Asset Preview** tab (5) displays a preview of the selected asset. The preview changes based on the type of the asset you have selected. For example, you can play animations and sounds. This is a quick way to check changes to an asset when editing it in the Property Grid. By default, the Asset Preview is in the bottom right.

You can show and hide different parts of the Game Studio in the View menu. You can also resize and move parts of the UI.

Expand Down
15 changes: 7 additions & 8 deletions en/manual/get-started/create-a-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To create an empty project:

The **New/open project** dialog opens.

![New Project dialog](media/create-project-new-open-project-window.png)
![New Project dialog](media/create-project-new-open-project-window.webp)

You can also open a new project in Game Studio from **File > New**.

Expand All @@ -33,16 +33,15 @@ To create an empty project:

The **Create a new game** dialog opens.

![Create a new game dialog](media/create-project-create-new-game.png)
![Create a new game dialog](media/create-project-create-new-game.webp)

5. In the **Namespace** field, specify the namespace you want to use. If you don't know what your namespace should be, leave it as default.

6. Under **Platforms**, select the platforms you want your game to support.

> [!Note]
   > To support iOS and Android, you need to install <a href="https://www.xamarin.com/studio" target="_blank">Xamarin</a> (free if you have Visual Studio).

If your development system is missing prerequisites for any of the platforms you select, Stride displays a warning.
>[!Note]
>To support iOS and Android, you need to install <a href="https://www.xamarin.com/studio" target="_blank">Xamarin</a> (free if you have Visual Studio).
>If your development system is missing prerequisites for any of the platforms you select, Stride displays a warning.
7. Under **Asset Packs**, you can select additional assets to include in your project. These include assets such as animations and materials. The asset packs are fun to play with when you're learning how to use Stride, but they're not necessary.

Expand Down Expand Up @@ -73,13 +72,13 @@ To create a project from a sample or template:

3. **Select the sample** you want to create a project from.

![New Project window — samples](media/create-project-new-open-project-samples.png)
![New Project window — samples](media/create-project-new-open-project-samples.webp)

4. Click **Select**.

The **Select Platforms** window opens.

![Select Platforms window](media/create-project-select-platform.png)
![Select Platforms window](media/create-project-select-platform.webp)

5. Select the platforms you want your game to support and click **OK**.

Expand Down
4 changes: 2 additions & 2 deletions en/manual/get-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ Welcome to Stride! This chapter provides everything you need to start creating g

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](https://doc.stride3d.net/latest/en/tutorials/index.html).
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.jpg)
![Game Studio](media/get-started.webp)

## In this section

Expand Down
18 changes: 9 additions & 9 deletions en/manual/get-started/launch-a-game.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,30 +9,30 @@ This page explains how to launch your game using Game Studio or Visual Studio.
> [!Note]
> Game Studio can't launch games for the Windows Store or UWP (Universal Windows Platform) platforms. To launch a game for those platforms, use Visual Studio (see below).
1. In the **toolbar**, select your target platform.
1. In the **Solution Explorer**, right-click in your target platform, then choice **Set as current project**.

![Platform selection](media/launch-your-game-game-studio-profiles.png)
![Platform selection](media/launch-your-game-game-studio-profiles.webp)

> [!Note]
> You can only select platforms you selected in the **Create a new game** dialog when you created the project. To add additional platforms to the project, see [Add or remove a platform](../platforms/add-or-remove-a-platform.md).
2. To run the game, click ![Play icon](media/launch-your-game-play-icon.png) in the toolbar or press **F5**.
2. To run the game, click ![Play icon](media/launch-your-game-play-icon.webp) in the toolbar or press **F5**.

![Game Studio play button](media/game-studio-toolbar-build-button.png)
![Game Studio play button](media/game-studio-toolbar-build-button.webp)

The **Output window** shows the build progress.

![Output window](media/output-window.png)
![Output window](media/output-window.webp)

When the build is complete, your game starts on the selected platform.

## Launch a game from Visual Studio

1. In Game Studio, in the toolbar, click ![Open in IDE](media/launch-your-game-ide-icon.png) (**Open in IDE**) to launch Visual Studio.
1. In Game Studio, in the toolbar, click ![Open in IDE](media/launch-your-game-ide-icon.webp) (**Open in IDE**) to launch Visual Studio.

2. In the Visual Studio toolbar, set the appropriate project as the startup project.

![Select build profile in Visual Studio](media/launch-your-game-visual-studio-profiles.png)
![Select build profile in Visual Studio](media/launch-your-game-visual-studio-profiles.webp)

The startup project configuration is updated automatically.

Expand All @@ -45,15 +45,15 @@ 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.png)
![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.jpg) | ![Without borders](media/without-borders.jpg)
| ![With borders](media/with-borders.webp) | ![Without borders](media/without-borders.webp)

To run the game without borders, use:

Expand Down
6 changes: 3 additions & 3 deletions en/manual/get-started/launch-stride.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

With the **Stride launcher**, you can install, manage and run different versions of Stride.

![Stride launcher](media/stride-launcher-interface.png)
![Stride launcher](media/stride-launcher-interface.webp)

## Install the latest version of Stride

Expand All @@ -22,7 +22,7 @@ The Stride Visual Studio extension lets you you [edit shaders directly from Visu

You can install multiple versions of Stride and launch them from the Stride Launcher.

![Manage versions of Stride](media/stride-launcher-various-versions.png)
![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.

Expand All @@ -44,7 +44,7 @@ Now you've installed Stride, it's time to start Game Studio and build a project.

The version number is updated on the **Start** button.

![Start button](media/stride-launcher-start-button.png)
![Start button](../stride-launcher/media/stride-launcher-start-button.webp)

2. Click **Start** to launch Game Studio.

Expand Down

This file was deleted.

Git LFS file not shown

This file was deleted.

Git LFS file not shown

This file was deleted.

This file was deleted.

Git LFS file not shown

This file was deleted.

This file was deleted.

Git LFS file not shown
3 changes: 0 additions & 3 deletions en/manual/get-started/media/game-studio-main-interface.jpg

This file was deleted.

3 changes: 0 additions & 3 deletions en/manual/get-started/media/game-studio-main-interface.png

This file was deleted.

3 changes: 0 additions & 3 deletions en/manual/get-started/media/game-studio-main-interface.psd

This file was deleted.

3 changes: 3 additions & 0 deletions en/manual/get-started/media/game-studio-main-interface.webp
Git LFS file not shown

This file was deleted.

Git LFS file not shown
3 changes: 0 additions & 3 deletions en/manual/get-started/media/get-started.jpg

This file was deleted.

3 changes: 0 additions & 3 deletions en/manual/get-started/media/get-started.png

This file was deleted.

3 changes: 3 additions & 0 deletions en/manual/get-started/media/get-started.webp
Git LFS file not shown
3 changes: 0 additions & 3 deletions en/manual/get-started/media/launch-your-game-IDE-icon.png

This file was deleted.

3 changes: 3 additions & 0 deletions en/manual/get-started/media/launch-your-game-IDE-icon.webp
Git LFS file not shown

This file was deleted.

Loading

0 comments on commit 7cd708e

Please sign in to comment.