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.

The toolkit is a set of extensions and helpers for Stride, an open-source C# game engine. Its largest piece is the code-only approach: building a Stride game from a plain .NET project, with no editor and no asset pipeline.

The toolkit is optional: Stride doesn't need it, and you can adopt as much or as little of it as you like. Everything is an extension method or a small component you can read, copy and change.

Start here

• New to the toolkit? Getting Started gets the package installed and a window on screen.
• New to Stride itself? Components and Scripts explains the entity-component model the rest of the manual assumes.
• Want to see it running first? The examples gallery is every code-only example with a screenshot. Each one is a complete program you can copy and run.
• Not writing C#? The toolkit works from any .NET language. The gallery has F# and Visual Basic versions of the getting-started examples.

What is in here

• Code-Only - why you might work without the editor, how to create a project, and the curated extension list for doing it.
• Extensions - the full reference, one page per type being extended: Game, Entity, Camera, Model, Animation, Script and Script System.
• Physics - the Bepu, Bullet and Box2D helpers, plus pages on silent Bepu failures: who owns the transform, why a constraint does nothing and bounce and friction.
• Rendering - Entity Text and World Text for labels, ShapeBatch for constant-pixel-width vector shapes, Reference Grid, Debug Overlay, Charts, Materials, Render to texture, GPU picking, Debug Shapes, and MeshBuilder and TextureCanvas for building meshes and textures at runtime.
• Troubleshooting - common build and runtime errors.
• API - the generated API reference for the toolkit.

The toolkit is in preview

Names and signatures still change between releases. If something in this manual does not match the package you have installed, the API reference is generated from the source and is the authority. Corrections and additions are welcome - see Contributing.