🚀 Get Started

This article walks you through the initial steps to use the packages in the Stride Community Toolkit.

🛠️ Prerequisites

Ensure the following are installed. If you're on Stride 4.2+, these should already be present.

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

     dotnet --info
     

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

📦 Adding the NuGet package

The toolkit is available via several packages named Stride.CommunityToolkit and Stride.CommunityToolkit.*. The main package includes all functionality. Add it via your IDE or CLI. It works for both regular Stride game projects and code-only projects.

To add the package via the command line:

dotnet add package Stride.CommunityToolkit --prerelease

Note

When using Stride.CommunityToolkit in code-only projects, you may need to add some dependencies manually to your project file. Using Stride.CommunityToolkit.Windows handles these automatically.

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 in the left navigation or dive into the code-only section for simple examples.