Skip to content

Commit

Permalink
Merge pull request #333 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 Sep 29, 2024
2 parents d7a694d + 47838a9 commit f6c4938
Show file tree
Hide file tree
Showing 3 changed files with 40 additions and 12 deletions.
2 changes: 1 addition & 1 deletion LICENSE → LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
8 changes: 7 additions & 1 deletion en/manual/get-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@ uid: ../toc.md

<span class="badge text-bg-primary">Beginner</span>

This chapter explains everything you need to start using Stride from scratch. For video tutorials, have a look at the the [Tutorials](https://doc.stride3d.net/latest/en/tutorials/index.html).
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.

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).

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)

Expand Down
42 changes: 32 additions & 10 deletions en/manual/get-started/install-stride.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,26 @@

<span class="badge text-bg-primary">Beginner</span>

## 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. Double-click the **StrideSetup.exe** file.
2. Run the installer by double-clicking the **StrideSetup.exe** file.

3. The **Stride Setup Wizard** opens.

Expand All @@ -22,31 +39,31 @@

![Select installation folder window](media/install-stride-select-installation-folder.webp)

Select a folder to install Stride to and click **Next**.
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, and click **Next**.
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**.
Click **Install** to begin the installation.

8. Installation begins.

![Installation status](media/install-stride-installation-status.webp)

After the installer closes, Stride creates shortcuts in locations you selected and the **Stride Launcher** starts.
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 will be asked to accept the privacy policy.
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*, and then click **I Accept**.
Check *I agree to the Privacy Policy*, then click **I Accept**.

10. The **Stride Launcher** window opens.

Expand All @@ -56,7 +73,7 @@

![No version installed](media/stride-launcher-install-latest-version-prompt.webp)

Click **Yes**.
Click **Yes** to install the latest version.

11. Installation of the latest version of Stride begins.

Expand All @@ -70,15 +87,20 @@

Click **Install**.

13. The Stride Launcher asks if you want to install the Visual Studio integration. This lets you edit shaders directly from Visual Studio and provides syntax highlighting, live code analysis with validation, error-checking, and navigation. Installing the integration isn't mandatory, but we recommend it.
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]
> [!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.
> [!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.
Expand Down

0 comments on commit f6c4938

Please sign in to comment.