Skip to content

Documentation versions

If the editor will not open ​

Find the symptom you see below. For a fresh installation, follow the first-run instructions.

The file opens as text ​

  1. Right-click the file's tab at the top of VS Code.
  2. Choose Reopen Editor With… → Binary GIN.
  3. To use it for all .bgin files, choose Configure default editor for '*.bgin'… → Binary GIN in the editor list.

If Binary GIN is missing, press Ctrl+Shift+X and check that Binary GIN Editor is installed and enabled. After installing or updating, press Ctrl+Shift+P, find Developer: Reload Window, and press Enter. Then reopen the file.

A blank tab, write EOF, or The editor could not be opened ​

write EOF means the connection to the BGIN worker ended. Check that the VSIX suffix matches the extension host platform. For WSL, SSH, and Dev Containers, use the platform of the remote environment.

  1. For ENOENT or No module named, reinstall the VSIX for your platform.
  2. If VS Code asks for workspace trust, confirm it if you trust the folder contents.
  3. Run Developer: Reload Window from the Command Palette, reopen the file, and check the log if the problem persists.

The tree opens but the image is missing ​

  1. Click Preview if the right pane is hidden, then Refresh.
  2. If you are using the supplied resources, open their Preview.code-workspace. Keep the resources folder next to that file.
  3. For your own resources, check the paths in Resources and click Save folders.
  4. Open View → Problems to see missing files. Click Render notes below the preview for image-specific warnings.
  5. After fixing the issue, click Refresh again.

See resources for the folder setup steps.

Text is tiny or only part of the screen is visible ​

To enlarge the image, use + or the zoom field beside Fit. Avoid reducing Height in preview settings to zoom in: text size can depend on screen height. To restore the standard settings, open Settings → Reset to defaults, close the dialog, and click Refresh.

If only one object is visible, click Clear selection above the tree. More about the preview.

Resource folder settings will not save ​

If the message includes not a registered configuration or asks you to reload, run Ctrl+Shift+P → Developer: Reload Window, reopen Resources, and click Save folders. Check that you have installed the latest extension version you received.

How to get the error text ​

  1. Choose View → Output from the top menu in VS Code.
  2. Open the log dropdown at the top-right of the bottom panel. Select Binary GIN instead of Window. For a failure while generating the image, also check Binary GIN Preview.
  3. Repeat the action that fails.
  4. Copy the last messages in full, including the lines before EOF or BGIN worker exited. Include the extension version, VSIX suffix, and BGIN filename.

A screenshot of the failed editor shows the symptom; the Binary GIN log is needed to determine the cause.

A newer BGIN is rejected or its format is ambiguous ​

A shared BGIN signature does not guarantee the same encoding. Check formats and corpus coverage. Special second-table records and inconsistent directories are not repaired automatically. Preserve the original for investigation; changing the format number manually does not fix structure.

Objects cover the entire image ​

In the currently open screen, click Refresh, then use Spread branches or Hide top layers. See composition inspection.

An MCP edit conflicts ​

The user or another client changed the document. Reread its text and revision before editing; do not retry an outdated whole-document replacement. Check the connection window, session pause and MCP configuration. External disk changes also cause save conflicts: preserve any wanted draft separately, then reopen the current file.