stride-docs icon indicating copy to clipboard operation
stride-docs copied to clipboard

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

Open Doprez opened this issue 1 year ago • 2 comments

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.

Doprez avatar Oct 19 '24 17:10 Doprez

This is good idea!

VaclavElias avatar Oct 19 '24 19:10 VaclavElias

from Feralnex in Discord:

Android build

  1. Go to C:\Users\USERNAME\.nuget\packages and delete all the stride folders (it might cause missing references etc. by how the nuget packages are cached) as @SolarChrome suggested a while ago

  2. Open and build Stride.sln by executing command: msbuild Stride.sln /t:Build /p:Configuration=Debug

If there're errors restore solution by executing: msbuild Stride.sln /t:Restore

and build solution again. 3. Close Stride.sln -> open and build Android.sln by executing command: msbuild Stride.Android.sln /t:Build /p:Configuration=Debug

If there're errors restore solution by executing: msbuild Stride.Android.sln /t:Restore

and build solution again. 4. Close solution and DON'T REBUILD OR TRY TO DEBUG Stride.sln (Stride.GameStudio.sln) it will force some .dlls to rebuild and might cause missing references when trying to build project for Android platform 5. Open GameStudio.exe from the stride/sources/editor/Stride.GameStudio/bin... and You can try to debug it by debugging the process from the list through Visual Studio 6. You should be able to build project for both Windows and Android platform

Doprez avatar Oct 20 '24 13:10 Doprez