Documentation versions
Binary GIN Editor
A VS Code editor for game interface files ending in .bgin. Select screens and objects on the left, change their properties below the tree, and preview the result on the right. Open .bgin files directly; converting them to JSON first is optional.
Version 0.6.3 adds four BGIN wire profiles, screen search with prefix groups and object counts, spread-branch inspection of the open screen and top-layer cutoff. MCP shares live VS Code documents between clients. You can use partial unpacked zdata resources and convert textures in a separate operation.
The MCP adapter is now bundled in the VSIX; no Python or separate adapter setup is required. Copy connection settings from the sidebar.
What you need
- VS Code 1.105 or later.
- A
bgin-editor-0.6.3-<platform>.vsixfile. It includes the worker for reading, saving, and previewing BGIN. Python installation andPATHchanges are unnecessary. - Resources for previews that use game images and fonts.
Choose the package for the extension host
| Environment | File suffix |
|---|---|
| Windows x64 / ARM64 | win32-x64 / win32-arm64 |
| macOS Intel / Apple Silicon | darwin-x64 / darwin-arm64 |
| Linux with glibc, x64 / ARM64 / ARMv7 hard float | linux-x64 / linux-arm64 / linux-armhf |
| Alpine Linux with musl, x64 / ARM64 | alpine-x64 / alpine-arm64 |
With WSL, SSH, or Dev Containers, choose the OS and architecture of the remote workspace. Linux packages target glibc 2.36 and later, and Alpine packages target Alpine 3.23 and later. The editor requires VS Code with a native extension host.
Download the matching VSIX from release 0.6.3 on GitHub.
1. Install the extension
- If you received a ZIP, extract it. If it includes
Preview.code-workspace, keep it next to theresourcesfolder. - In VS Code, open Extensions → … → Install from VSIX… and select the VSIX for your platform. In a remote window, install it in the environment where the workspace is open.
- If VS Code asks you to reload the window, reload it.
Expected result — Binary GIN Editor appears among installed extensions.
2. Open the workspace
If your package includes Preview.code-workspace, open it through File → Open Workspace from File…. The resource folders are already set. For your own files, open their folder and set the resource paths as needed. Confirm workspace trust if you trust the folder contents.
3. Open a file with Binary GIN
- In the file list on the left, open
resources/guiand select a.bginfile. To open your own file, choose File → Open File…. - If it opens as text, right-click the open file's tab → Reopen Editor With… → Binary GIN. To remember this choice for
.bginfiles, use Configure default editor for '*.bgin'… in the editor list and select Binary GIN. - On first opening, read the terms of use and click I agree to the terms. Closing the dialog does not accept them.
Expected result: a tree of screens and objects appears. The terms dialog appears after the file is read successfully.
4. Preview the interface and make your first edit
- Click the screen-name button above the tree, find a screen in the dialog and choose Open.
- Click Refresh on the right. If the image pane is hidden, first click Preview in the top toolbar.
- Select an object in the tree and change a property below it.
- Click Refresh to see the change, then Ctrl+S (⌘S on macOS) to save the file.
Expected result: the preview appears on the right. It updates when you click Refresh. Resource folders are already configured in Preview.code-workspace. If you opened a file without this workspace, set the folders in Resources.
The editor interface defaults to English. To switch it, open Editor settings → Interface language. This guide uses English button names.
Next steps
- Edit objects, create screens, and copy parts of an interface.
- Adjust the preview, zoom, and selected-object display.
- Use your own images, fonts, and BGIN files.
- Choose a format and convert BGIN or JSON.
- Connect MCP and control model edits.
- Understand format labels and compatibility limits.
- Files opening as text, write EOF, and other problems.
Keep a copy of the original file before replacing it in a game. The preview shows object positions, text, and images, but does not run game button actions. It can differ from the game. The ~0.0.2…~5.8.0 labels represent BGIN formats around those A8 releases. You can try neighboring versions and other games from the same period; compatibility is not guaranteed. Some special records in newer BGIN are still unsupported.