stride3d / stride3d/stride-docs

Guide on how to build and run the source of each Stride build solution

Open
#346 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PowerShell
Stars
39
Forks
74
Avg merge
3h 36m
Merged PRs (30d)
2

Description

in the Stride contributors page we should add a section to show the steps needed to build each Stride solution file and why someone would need to use them to contribute.

Basic examples:
Stride.sln
Requirements:

  • .NET 8

Use cases:

  • the core engine configured for desktop applications
  • contains the GameStudio project editor
  • ...

Stride.Android.sln
Requirements:

  • .NET 8
  • Android NDK
  • ...

Use cases:

  • the core engine configured for android applications
  • modify native libraries used to build Android games

Stride.VisualStudio.sln
Requirements:

  • .NET 8
  • .NET framework 4.7.2

Use cases:

  • contains the VS 2022 packages used for shader key file generation
  • provides syntax highlighting for SDSL SDFX files
  • adds some shortcut buttons to aid in Stride game development

The list goes on but these are just rough ideas of what we can add to help contributors get started. I think most of the contributors understand how the main Stride.sln works but not many understand the android, IOS, Visual Studio and other build solutions. Having these in a central place would help newer contributors easily get started and may be more motivated to even try and get started.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Stride contributors page and review the solution names mentioned in the issue: Stride.sln, Stride.Android.sln, and Stride.VisualStudio.sln. Document the requirements and contributor use cases for each, extending the list to the other Android, iOS, Visual Studio, and related solutions. Done means the contributors page centrally explains how and why each solution is built.

Written by the indexing model from the issue text.

Assessment

Tech stack
android, ios
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.