Documentation versions
Images, fonts, and settings
The preview needs resources: images, fonts, and files describing how they are used. A .bgin file often stores only references to them.
If you have the full editor package
The package includes a resources folder. In VS Code, choose File → Open Workspace from File… and open Preview.code-workspace from the same folder. Its paths are already configured. Open a BGIN file and click Refresh.
Keep resources next to Preview.code-workspace. When moving the package, move both together. Opening only the gui folder instead of the workspace does not load these preconfigured settings.
If you use your own resources
Use resources from the same game version as the file you are editing.
- Open a
.bginfile with Binary GIN and click Resources at the top-right. - Near the bottom, click Browse… beside Extracted archive folder. Select the folder containing
gui,textures_android, andtexter_fonts. - Click Auto-fill. The editor will try to find the required folders.
- Check the resulting paths against the table below. If a folder was not found, use Browse… beside its field to select it yourself.
- Click Save folders, close the dialog, and click Refresh.
| Field | Folder to select |
|---|---|
| Resource root | The common folder containing the other resource folders. In the package, this is resources. |
| BGIN folder | gui. It should include widgets.bgin for text styles and sprites.bgin for image and animation descriptions. |
| Textures folder | textures_android, containing images. Keep files with __alpha in their names too: they define transparency. |
| Fonts folder | texter_fonts, containing font files. |
Folder names may differ: select them by their contents. BGIN folder accepts an entire folder; you do not need to add files one at a time. Save folders remembers the paths and leaves the files in their current locations.
For example, TextStyle: /Widgets/MM_White_Text means: use the MM_White_Text style from the document whose internal name is Widgets. Text therefore needs its matching widgets.bgin; images need sprites.bgin and the actual textures. Renaming a file does not change its internal name.
If something is missing
Open View → Problems to see which file could not be found. Click Render notes below the image for preview warnings. Fix the path or add the missing file, then click Refresh again. If the editor fails to open, see troubleshooting.
Language and help
Editor settings → Interface language switches the editor buttons between English and Russian. The blue Editor guide and GIN documentation buttons, and the help icons beside objects, open documentation in that language. Terms of use in the settings reopens the terms.
Preview Font language chooses a game font variant. This is separate from interface language and does not translate text or $STR_… strings.
If you need to change settings through VS Code
Press Ctrl+, and search for a key. The editor's buttons are sufficient for ordinary use.
| Key | Purpose |
|---|---|
bgin.language | en or ru for editor language. |
bgin.resourceFolders | Paths saved through Resources. Relative paths start at the VS Code project folder, or the BGIN folder when no project is open. |
bgin.preview | Initial preview settings. A previously opened editor can have its own saved values. |
bgin.windowsExplorerNewFile | Enables empty BGIN creation through Windows Explorer. |