Table of Contents

Stride Community Toolkit Documentation

Join the chat at https://discord.gg/f6aerfE License

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

While the toolkit's extensions are helpful for many developers, experienced game developers may prefer to examine the toolkit's source code directly. The extensions are essentially convenience wrappers, and advanced users might benefit from implementing their own solutions based on the toolkit's code.

📦 Libraries

The toolkit includes the following libraries:

  • Stride.CommunityToolkit: This is the core library. Use it for general-purpose extensions in a regular Stride project or for a code-only approach.
  • Stride.CommunityToolkit.Windows: This library contains Windows-specific dependencies required for code-only approach.
  • Stride.CommunityToolkit.Skyboxes: Enhances code-only projects by adding skybox functionality.

🔧 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:

Edit this page