Stride Community Toolkit Documentation

Warning

The toolkit is currently in development. Documentation is incomplete and may contain errors. We published it early for your convenience, ahead of the toolkit's completion.

👋 Introduction

The Stride Community Toolkit is a set of C# helpers and extensions designed to enhance your experience with the Stride Game Engine. It simplifies and streamlines routine development tasks 🛠️, making it easier to build applications for Stride using .NET 8 🎉.

Tip

Experienced developers might prefer exploring the toolkit's source code directly. These extensions are convenience wrappers, offering a foundation for advanced users to build custom solutions.

📦 Libraries

The toolkit includes the following libraries, each designed to extend and enhance your Stride development experience:

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

🔧 Installation

The toolkit, available as a 📦 NuGet package, can be integrated into new or existing Stride Game C# projects. For more information on how to get started, please refer to the Getting Started page.

🚀 Fast-Paced Development

This toolkit serves as our preferred solution for rapid 🏃 prototyping and accelerated game development. Unlike the more stable Stride Game Engine, the Stride Community Toolkit aims for faster development momentum. As such, you should expect that breaking changes are likely to occur. This approach allows us to quickly iterate and integrate new features and improvements. We believe this pace serves the needs of developers who are looking for cutting-edge tools and are comfortable with a more dynamic environment.

🛠️ Toolkit Repository

The Stride Community Toolkit is an open-source, MIT-licensed project hosted on GitHub and supported by the community. Access the source code or contribute 🤝 to the toolkit on its GitHub Repository.

🎮 Stride Game Engine Repository

Access the source code or contribute 🤝 to the Stride Game Engine on its GitHub Repository. Explore a comprehensive guide on the Stride Docs website.

📃 Documentation & Resources

Explore a range of resources to help you get the most out of the toolkit:

• Manual: Detailed guidance and best practices for using the toolkit
• Tutorials: Step-by-step tutorials to help you learn various features of the toolkit
• Release Notes: Stay updated with the latest changes and improvements
• API Reference: In-depth API documentation for a deep dive into the toolkit's capabilities

These resources provide comprehensive information and support for developers at all levels, from beginners to advanced users.

👥 Contributors

We would like to thank our contributors for expanding the toolkit's capabilities:

• dfkeenan: Previous toolkit implementation
• DockFrankenstein: Script System Extensions
• Doprez: Extensions, docs
• DotLogix: Utility MeshBuilder, TextureCanvas and docs
• Idomeneas1970: Heightmap extensions
• IXLLEGACYIXL: Extensions
• Johan Gustafsson: Extensions
• Vaclav Elias: Code-only approach implementation, toolkit docs