Skip to content

Documentation versions

Editing objects and creating screens ​

One BGIN file can contain several screens. A screen contains objects such as text, images, buttons, and containers: groups that arrange the objects inside them. The tree on the left shows this structure.

Change an existing object ​

  1. Click the screen-name button above the tree, find a screen in the dialog and choose Open.
  2. Expand a group using the arrow beside its name, then click an object.
  3. Its Properties appear below the tree. Change the field you need. Name changes the object's name; Type changes its type.
  4. Click Refresh to check the image, then Ctrl+S to save. Ctrl+Z undoes a change; Ctrl+Y restores an undone action.

Each object type has its own set of properties. Use the dropdowns or labeled fields to change values. A blank field means no explicit value is set and the default is used. Properties the editor does not recognize are preserved and shown as read-only.

If a property's purpose is unclear, click Documentation beside the object's name to open its type reference. Reveal in tree next to it expands the path to the object and shows its row in the tree.

Resize the tree, properties, and preview by dragging the thin lines between them. Hover over a line to see a cursor indicating the drag direction.

Find a screen ​

The screen-name button above the tree opens Choose screen. Search matches names and types. All lists every screen; By prefix groups them by derived prefix. A separate prefix filter narrows the list. Prefixes are detected from names using separators and CamelCase: template_card and screenGarage, for example, yield template and screen. Other detected prefixes appear too.

Objects beside the type counts the root and all stored descendants in children and tracks. References to external BGIN definitions and animation frames are not counted as additional objects. Select a row and choose Open, double-click it, or press Enter. Selecting a screen does not render it; click Refresh explicitly afterward.

Find an object ​

Click Find object… above the tree and enter part of a name or type. The search window keeps matching objects and the groups containing them. Click a result to switch to its screen and reveal it in the main tree.

Clear selection removes the selection. It also restores the whole-screen preview when the preview is set to show only the selected object.

Add, copy, or delete ​

Right-click a tree row, or press Shift+F10, to open its menu.

ActionWhat it does
New child object…Adds an object inside the selected container. Choose a type in the dialog and confirm.
New screen…Adds another screen to this file.
Rename…Renames the selection; F2 also works.
Change type…Chooses another type. A container with objects inside cannot become a type that does not accept children.
Copy JSONCopies the object and everything inside it as JSON text.
CutCopies the object and its contents, then removes it from its current location.
Paste into containerInserts the copied object inside the selected container. A duplicate name gets a suffix.
Paste as screenInserts the copied content as a separate screen of a suitable type.
DuplicateImmediately makes a copy beside the original object without changing the clipboard.
Move up / Move downMoves the object among its neighbors; ↑/↓ above the tree do the same.
Expand all / Collapse allExpands or collapses the current screen's tree.
DeleteRemoves the selected object and its contents, or the entire screen.

With a tree row selected: Ctrl+C copies, Ctrl+X cuts, Ctrl+V pastes into a container, Ctrl+Shift+V pastes as a screen, Ctrl+D duplicates, and Delete removes. Changes reach the file on disk when you press Ctrl+S.

Type cards in creation dialogs have a help icon at the top-right. Click it to read about a type before choosing. The search field filters cards by name.

Create a new file and its first screen ​

  1. Press Ctrl+Shift+P → BGIN: New File → Enter and choose a folder, .bgin filename, and BGIN format mode.
  2. In Name this BGIN document, enter a document name and click Start editing. This is an internal name; it is not taken from the filename.
  3. Click New screen…. For an ordinary interface, select Interface screens.
  4. Enter a screen name, choose a container type, and click Create.
  5. Add objects by right-clicking the container → New child object….

The first-screen dialog also offers Sprite library for images and animations, and Widget templates for templates and text styles. Choose these for the corresponding files; the document kind is fixed once work begins. For a normal screen, use Interface screens with a container as its starting point.

Document and screen names are separate. Screen names within one document must be nonempty and different. You can keep an empty file on disk: it receives a warning. A named BGIN needs at least one screen before saving. If you delete the last screen, create or paste another before saving.

Edit as text ​

The JSON button at the top shows the same document as text. Hierarchy returns to the tree. This does not create a separate JSON file.

If JSON is missing a comma, quote, or bracket, fix it before saving. Messages appear in View → Problems. The editor also checks that the supplied values can be written as BGIN. If you need a separate JSON file for sharing, use the sidebar.