Technical Documentation

Windows

Last Updated: October 21, 20241.2 min read

Dependencies

  • CMake
  • Visual Studio
  • Vulkan SDK

Batch Script

The Code/Setup.bat batch script automates the first setup on Windows. You can expect it to:
  1. Automatically invoke CMake to generate a Visual Studio solution
  2. Build the Project System and Asset Compiler
  3. Install the Project System’s shell integration
    1. The shell integration allows you to right-click Sceneri’s project and asset files to perform quick actions from Explorer.
  4. Reconcile Engine Dependencies
    1. This effectively compiles engine assets that Sceneri relies on to start.
  5. Build the Sceneri Editor
  6. Start the newly compiled Sceneri Editor
If successful, the script should have compiled and launched the latest Editor application build. You can then open the generated solution /ย project from the <engine folder>/Code/Intermediate<platform> folder.

Manual

  • Open the CMake app
  • Enter the source code directory in the top section, and the target intermediate directory below:
  • Press Generate.
  • Use the default native compilers, and then press Done.
  • After the project has finished generating, press Open Project.
  • You should now be greeted by the project:

Useful Startup Parameters

  • -width X -height X (width and height of the engine window)
  • -project “absolute\path\to\yourproject.nproject”