🚀 Get Started

This article guides you through the initial steps to utilize the packages within the Stride Community Toolkit project.

🛠️ Prerequisites

Ensure the following are installed to build/run the project. If you're on Stride 4.2+ already, these should be pre-installed.

1. Microsoft Visual C++ 2015-2022 Redistributable
   • vcredist_x64.exe (25MB)
   • Note: You might be asked to restart your PC after the installation.
2. .NET 8 SDK x64: Download (200MB)
   • Verify installation with:

     dotnet --info
     

3. IDE of your choice
   • Visual Studio 2022
     • Visual Studio 2022 Community (Free)
   • Visual Studio Code (Free, 95MB)
     • Install the C# Dev Kit extension
     • Restart Visual Studio Code to ensure dotnet command functions properly
   • Rider (Free for non-commercial use)

📦 Adding the NuGet package

The toolkit is available through several packages named Stride.CommunityToolkit and Stride.CommunityToolkit.*. The main package includes all functionalities of the toolkit. You can add this package to your project using your preferred IDE or via the command line. It is designed to be compatible with both regular Stride game projects and code-only game projects.

To add the NuGet package using the command line, execute the following command:

dotnet add package Stride.CommunityToolkit --prerelease

Note

When using Stride.CommunityToolkit in a code-only project, you will need to manually add certain dependencies to your project file. However, if you are using the Stride.CommunityToolkit.Windows package, it automatically handles these dependencies for you.

Additional toolkit packages

• Stride.CommunityToolkit
  • The core library, providing general-purpose extensions for both regular Stride projects and code-only approaches.
• Stride.CommunityToolkit.Bepu
  • Adds support for BEPU Physics, a pure C# 3D real time physics simulation library.
• Stride.CommunityToolkit.Bullet
  • Adds support for Bullet Physics. Note that we no longer plan to support or expand its features as our focus shifts to Bepu Physics.
• Stride.CommunityToolkit.DebugShapes
  • Provides easy-to-use Debug shapes to be able to visualize and debug your Stride scenes
• Stride.CommunityToolkit.ImGui
  • Includes extensions for Dear ImGui, a fast, simple-to-use graphical user interface (GUI) library, accessed via the C# wrapper Hexa.NET.ImGui. Ideal for creating debugging tools, editor windows, and in-game UI elements.
• Stride.CommunityToolkit.Skyboxes
  • Enhances code-only projects by adding skybox functionality.
• Stride.CommunityToolkit.Windows
  • This library contains Windows-specific dependencies required for code-only approach (RuntimeIdentifier and package reference Stride.Core.Assets.CompilerApp).

Explore the extensions available in the left navigation or dive into the code-only section for simple examples.