Stride Community Toolkit Manual

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.

Welcome to the Stride Community Toolkit Manual. This comprehensive guide is designed to help you make the most of the toolkit for Stride, an open-source C# game engine. Whether you are new to Stride or an experienced developer, these pages offer valuable insights, tips, and detailed instructions to enhance your game development experience.

Table of Contents

• Getting Started: A guide for newcomers on how to set up and start using the toolkit.
• Code-Only Approach: Learn how to create and manage Stride projects using only C# code.
  • Create Project: A step-by-step guide on creating a new Stride project using C# console application.
  • C# Basic Examples
    • Capsule with rigid body: Shows how to create a 3D capsule entity and position it in a scene.
    • Give me a cube: Presents a variation of the above example by positioning a 3D cube in a scene.
    • Mesh line: Shows how to create a mesh line.
    • Stride UI - Capsule with rigid body and Window: Shows how to create a 3D capsule entity, position it in a scene, and create a simple window displaying a text message.
    • Stride UI - Grid - Save and load game state: Shows how to create a simple game where clicking a cube increases the score and manages game state.
    • Material: Shows how to create a material and apply it to a 3D entity.
    • Procedural geometry: Shows how to create procedural geometry meshes—such as a triangle, plane, and circle—and add them to a scene.
    • Cylinder mesh: Shows how to create a cylinder mesh.
    • Partial torus mesh: Shows how to create a partial torus mesh.
    • Particles: Shows how to create a particle system.
    • Raycast: Shows how to implement raycasting and physics interactions.
    • Collision Group: Shows how to create a scene with two players and an enemy entity and set up collision groups.
    • Collision Layer: Shows how to create a scene with two players and an enemy entity and set up collision layers.
  • C# Advanced Examples
    • Simple Constraint: Shows how to create a simple constraint between two entities.
    • Various Constraints: Shows how to create various constraints between entities, including distance limit, distance servo, ball socket, and point-on-line servo.
    • Myra UI - Draggable Window, GetService(): Illustrates using Myra UI to create a draggable window, display a health bar, and access registered services.
    • Stride UI - Draggable Window: Illustrates using Stride UI to create a draggable window.
    • Image Processing: Shows how to apply image processing effects to a texture.
    • Root Renderer Shader: Shows how to create a custom shader for the root renderer.
  • Other Examples
    • Debug Shapes: This example sets up a basic 3D scene and adds debugging visuals.
    • Renderer: Demonstrates two distinct approaches for implementing custom rendering in Stride.
  • F# Basic Examples
    • Capsule with rigid body: Demonstrates how to create a 3D capsule entity and position it in a scene.
    • Partial torus mesh: Shows how to create a partial torus mesh.
  • VB Basic Examples
    • Capsule with Rigid Body (VB)
  • Extensions
• Extensions
  • Animation Extensions
  • Camera Extensions: Powerful and convenient ways to interact with the camera.
  • Entity Extensions: Enhancements and utilities for working with entities.
  • Game Extensions: Extensions ranging from performance monitoring to material creation and entity manipulation.
  • Model Extensions
  • Script Extensions: Additional features and tools for game development.
  • Script System Extensions: Utilities for writing async methods.
• Rendering: A guide on rendering techniques.
  • MeshBuilder: A utility class allowing dynamic creation of meshes at runtime.
  • TextureCanvas: A utility class allowing dynamic creation of textures at runtime.
• Troubleshooting: Solutions and tips for common issues encountered while using the toolkit.

Explore these sections to discover the full potential of the Stride Community Toolkit and enhance your game development skills.