spaceengineers-helper README

Документация на русском

This extension created to make development of Space Engineers(SE) scripts easier. Join Discord for support.

Features

Every line here have GIF-demonstration which are probably invisible from VS Code. Go to repository to see all demo GIFs.

• Creates environment for SE script development:

• Builds command block files for your programm by seeking for dependencies you used:

• No more 1000+ lines code files:

• Use as much decomposition as you need:

Requirements

• Make sure you have C# extension and .NET 8 installed
• Specify path to your SE folder:

Known Issues

Commands

• CreateBaseSEProject (spaceengineers-helper.CreateBaseSEProject): Initializes a new Space Engineers script project from the template archive.
• BuildCommandBlockFile (spaceengineers-helper.BuildCommandBlockFile): Compiles the active script and its dependencies into the configured out directory.
• BuildCommandBlockFileToClipboard (spaceengineers-helper.BuildCommandBlockFileToClipboard): Compiles the active script and its dependencies directly into the clipboard.
• SetBaseProjZipUrl (spaceengineers-helper.SetBaseProjZipUrl): Sets a custom download URL for the base project template archive.
• ToggleMinification (spaceengineers-helper.ToggleMinification): Toggles Roslyn script minification on or off (SEH_extension.minifyOutput).
• SetOutputLayout (spaceengineers-helper.SetOutputLayout): Quick pick to switch build output layout between se-script and flat.

Settings

• SEH_extension.baseProjArchiveUrl (string): URL for base project archive.
• SEH_extension.outLayout ("se-script" | "flat"): Layout of build output:
  • "se-script" (default): saves output to out/<Name>/script.cs (suitable for symlink or copy into IngameScripts/Local; on Windows symlinks may require administrator privileges).
  • "flat": saves output to out/<Name>.txt.
• SEH_extension.minifyOutput (boolean, default false): Minify output script using Roslyn (strips comments and redundant whitespace, collapses blank lines while preserving preprocessor directives on separate lines and string/char literals intact). Helps fit into the Space Engineers 100,000 characters programmable block limit. Engine CLI flag: --minify.

Release Notes

1.0.1

Fixed:

• Dependency tree build looping that leaded to huge build time
• Removed forgotten "Hello world" command

2.0.0

Added

• Roslyn code parsing API implemeted and invoked as child process
• SetBaseProjZipUrl implemented, now it is possible to specifiy own .zip archive download path, and use any desired template of the base project
• BuildCommandBlockFileToClipboard implemented, that allows to build file directly to clipboard
• .csproj file now needs GamePath set only once, insted of ~10 entrance change

Fixed

• BuildCommandBlockFile command fixed, and now uses codeparseengine for much easier support
• Minor fixes and improvements

2.0.4

Fixed

• Retargeted to master branch of BaseProject by default
• Improved BaseProject usability for either UNIX or Windows systems
• Typo in description fixed (hopefully last one >_<)

2.0.5

Fixed

• .NET installed verions check added. Now extension tells if supported version of SDK not found
• CodeParser engine updated to .NET 8
• Used packages updated

2.0.6

Fixed

• .NET check failure now aborts command
• Robust parsing of CodeParser output
• Paths with spaces supported (execFile)
• BuildCommandBlockFile no longer reports success on failure
• Internal cleanup (typos, unused cancellation tokens)

Changed

• Migrated to ESLint 9 flat config
• Removed unused vscode-languageserver dependencies

2.0.7

Added

• SEH_extension.outLayout setting (flat | se-script) to organize output as Space Engineers script directory structure out/<Name>/script.cs for direct symlink or copy into IngameScripts/Local

2.1.0

Added

• SEH_extension.minifyOutput setting (default false) and --minify CLI flag for Roslyn script minification (stripping comments and excessive whitespace while keeping preprocessor directives and string literals intact).
• Toggle Minification (spaceengineers-helper.ToggleMinification) and Set Output Layout (spaceengineers-helper.SetOutputLayout) commands for fast configuration switching.
• Display size deltas and warning if 100,000 characters limit is exceeded.

Changed

• Default SEH_extension.outLayout changed to "se-script" (out/<Name>/script.cs).

2.1.1

Fixed

• Extension package slimmed down ~38MB -> ~5MB; docs images are now loaded from the repository