Skip to content

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.

  1. Open a .bgin file with Binary GIN and click Resources at the top-right.
  2. Select Source layout → Extracted archive, then click Browse…. Select the folder containing gui, textures_android, and texter_fonts.
  3. Click Auto-fill. The editor will try to find the required folders.
  4. Check the resulting paths against the table below. If a folder was not found, use Browse… beside its field to select it yourself.
  5. Click Save folders, close the dialog, and click Refresh.
FieldFolder to select
Resource rootThe common folder containing the other resource folders. In the package, this is resources.
BGIN foldergui. It should include widgets.bgin for text styles and sprites.bgin for image and animation descriptions.
Textures folderA folder of images, ZIP-based JPK files, or the assetpacks root. Keep files with __alpha in their names too: they define transparency.
Fonts foldertexter_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.

Partial unpacked zdata / Play Asset Delivery ​

Choose Source layout → Unpacked zdata / Play Asset Delivery, then select zdata, files, assetpacks, or a specific assets/data folder. Click Auto-fill, review the paths and save. Version and revision directories come from the selected tree, not from the BGIN profile. Multiple common_pack versions require selecting a specific folder or entering paths manually.

text
zdata/
  files/assetpacks/
    common_pack/<version>/<revision>/assets/data/
      gui/
      texter_fonts/
    textures_pack1/<version>/<revision>/assets/data#tcf_astc/
      textures1.jpk

The entire game archive is unnecessary. Keep the required BGIN definitions (usually widgets.bgin and sprites.bgin), referenced textures and alpha masks, and fonts. You may keep only these folders or choose independent folders manually. Auto-fill retains already entered paths for missing fields; review them.

ZIP-based JPK members are read on demand without extracting the whole archive. Sources stay unchanged. Duplicate texture names across packages produce an error; select a single consistent version and GPU variant. A whole pack may contain many files that a particular screen does not need.

The studied 5.8.0 main GUI is in common_pack; textures are in textures_pack*. Play Asset Delivery may store these in private application storage, and paths change across releases. No OBB in Android/obb does not imply missing assets. For a device with inaccessible storage, use an already available extracted copy; an unpacked cache installer can also supply this structure.

Separate texture conversion ​

Saving BGIN or changing its wire format never converts textures. The command BGIN: Convert Texture Separately accepts a PVR texture (possibly named .tga) and a separate output file for ~1.6.0:

  • Remove outer compression preserves GPU blocks and mip levels; ETC2/ASTC are rejected for the older target.
  • RGBA8 decodes every mip level to uncompressed pixels, increasing size.

Convert a separate alpha texture with a separate call. The source is not replaced. Preview decodes supported ETC2/ASTC PVR and LZ4/legacy Zstd envelopes, but this does not make an older game capable of reading them. The 1.6.0 PVR loader does not support these newer envelopes and GPU formats. That does not claim that every other engine loading path lacks any ETC2 support. In-game loading of converted resources has not been tested.

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.

KeyPurpose
bgin.languageen or ru for editor language.
bgin.resourceFoldersPaths saved through Resources. Relative paths start at the VS Code project folder, or the BGIN folder when no project is open.
bgin.previewInitial preview settings. A previously opened editor can have its own saved values.
bgin.windowsExplorerNewFileEnables empty BGIN creation through Windows Explorer.