The ORK editor is used to set up your project’s data.

Opening the ORK Editor #

Opening the editor depends on the used game engine.

Unity #

• Unity menu
  Using the Unity menu: Window > Gaming Is Love > ORK Framework
  You can also open multiple instances of the editor using multi-mode: Window > Gaming Is Love > ORK Framework (Multi Mode)
• Keyboard Shortcuts
  Windows: CTRL + ALT + O
  Mac: CMD + ALT + O
• Keyboard Shortcuts for Multi Mode
  Windows: CTRL + ALT + SHIFT + O
  Mac: CMD + ALT + SHIFT + O
• ORK Project Asset
  Either double clicking on an ORK project asset or selecting it and clicking Open Project in the inspector.

Editor Layout #

The ORK editor is separated into different areas you’ll use to navigate the settings.

Section Selection #

The section selection is used to navigate between the available sections and sub-sections of the ORK editor. You can find a list of all sections and sub-sections in this documentation.

Each section contains topic-related sub-sections, e.g. the Status section contains everything related to the status system (e.g. status values, status effects or abilities).

You can find the section selection in the upper left corner of the editor.

The section selection is a searchable dropdown. If you click on the section icon button, you’ll start the dropdown in the main section selection. If you click on the text button, you’ll start in the section of your currently selected sub-section.

You can also bring up the section dropdown using the keyboard shortcut CTRL + Space and navigate it using the arrow keys (and Enter to accept).

Asset List #

The asset list is only shown for sub-sections that contain data assets, e.g. items, combatants or UI boxes. In other sub-sections (e.g. system settings or scene connections) the asset list is replaced by the settings list and help text column.

Add, Copy, Remove #

You can find 3 buttons on top of the asset list to add a new asset, copy the selected asset or remove the selected asset.

Search, Filter & Sort #

Asset lists can be searched and filtered.

Filtering usually allows to filter the list by organizer type or content type (depending on the sub-section). Some sections also allow filtering by other content, e.g. quest tasks can be filtered by quests.

General Settings #

Some sub-sections additionally offer the General Settings button above the asset button list.

Clicking on it will display the sub-section’s general settings, which usually allow setting up default settings or other widely used settings.

Reorderable List #

The asset list can easily be reordered by dragging the individual assets.

There are also sorting options available in Search, Filter & Sort above the list.

Settings List #

The settings list shows all main foldouts of the displayed settings as individual buttons. This’ll give you a quick overview of the available settings.

You can find the settings list is to the right of the section selection and asset list (for data list sub-sections), or below the section selection for non-data list sub-sections.

Clicking on a button will limit the view to that part of the settings.

When the view is limited to a foldout, you can also display the foldout hierarchy of the displayed settings. The depth can be controlled using the Max Depth field at the bottom of the settings list.

Setting the max depth to 0 will hide the foldout hierarchy, only showing the main foldout buttons.

For content with levels (abilities, equipment), you’ll also find the level selection here.

Help Text #

The help text shows information on the currently hovered over or selected setting. Every setting in ORK has a help text to let you know more about it’s functionality or available options.

The help text is always displayed below the settings list.

The editor settings allow you to change how to cause the help text to change, e.g. via hover or clicking on a ‘?’ button.

The buttons at the bottom allow you to copy the help text (e.g. for translating it) and optionally open a link to documentation pages.

Main Settings Display #

The main settings display shows the setting of the current sub-section, general settings or selected asset.

Header/Search #

On the top you’ll find a search field to search for settings as well as a header to let you know where you’re currently at (showing the name of the sub-section, data list item as well as the current main foldout you’re viewing).

The search also offers buttons to open and close all displayed foldouts, as well as toggle the jump list on and off.

Save/Reload Buttons #

The save and reload buttons are found at the bottom of the editor.

Reload Settings Button #

Reloads the project after a confirmation dialogue.

This will reset any changes you’ve made since the last save.

Save Settings Button #

Prepares saving the changes made to the project data.

If no changes where made, a message will be displayed.

If changes where found, the save confirmation will be displayed (see below).

Save Confirmation #

The save confirmation is dispalyed when clicking on the Save Settings button.

This will list the settings that will change, be added or removed.

Backups #

Enable Create Backup to create a backup of the last saved state of the project data.

Learn more about backups in this documentation.

Update Schematics/Prefabs/Scenes #

If the project data changes require changes to schematics, prefabs or scene setups, you’ll be notified here.

You can enable/disable if those updates should be processed. When updating, the update will happen when confirming saving the changes.

Jump List (Optional) #

The jump list is optional and displayed at the right side of the editor.

A new project will have the jump list disabled.

The jump list offers a similar functionality as the settings list, but will show the complete foldout hierarchy at all times, while the settings list only shows the foldout hierarchy of the currently selected main foldout.

It offers a fast overview of the complete settings and quick navigation by clicking on the hierarchy where you want to go.

Editor Features #

The ORK editor offers multiple productivity features to help you set up your game’s data.

Data Selection Fields #

The data selection fields are used to select ORK data assets.

Beside the popup, there are 2 small buttons available:

• Add (green plus)
  The add button will add a new set of data and select it in the field.
  E.g. if the field is an Input Key selection, a new input key will be added.
• Edit
  The edit button will take you directly to the settings of the currently selected data.
  E.g. if the field is a Combatant selection, it’ll open the selected combatant’s settings.

The popup on the right of the small buttons is the asset source selection, defining how the asset will be referenced in this field. See asset sources for more details.

Asset Selection Fields #

The asset selection fields are used to select non-ORK data assets, e.g. prefabs, audio assets, etc.

The popup on the right of the small buttons is the asset source selection, defining how the asset will be referenced in this field. See asset sources for more details.

Dropdown Selections #

The dropdown selections in the ORK editor offer multiple features.

Some of the dropdowns list their data in hierarchies, grouping selections together instead of displaying a long list of selections.

Beside using the mouse, you can navigate dropdowns using the arrow keys and accept the selection using Enter.

Searchable #

All dropdowns are searchable.

Favorites #

Click on the star icon on the right side of an entry to mark it as a favorite.

Favorites are found in a separate hierarchy at the top of the dropdown’s root list.

Clicking on a favorite’s star will remove the favorite.

Unity: You can reset all popup favorites via the EditorData asset found in Assets/Gaming Is Love/_Data/. Click on the Clear Popup Favorites button in the asset’s inspector.

Copy/Paste Settings #

You can use a context menu to copy settings into the clipboard and paste them on other, compatible settings.

Which settings are part of the copied data are highlighted by a blue color (the color can be changed in the editor settings).

This can be useful if you have to redo the same setup on multiple things, even if you need to change a setting or 2 of the copied setup.

The settings stored in the clipboard will stay as they are when they where copied, even if you change the settings you copied.

Depending on the settings, this can also be used to copy some individual fields/settings instead of a whole setup, e.g. value fields:

Foldout Coloring #

Mark important settings by changing the color of a foldout.

To change a foldout’s color, click on the small square icon in it’s upper right corner.

Select a whilte color to reset the color to it’s original.

Unity: You can reset all foldout colorings via the EditorData asset found in Assets/Gaming Is Love/_Data/. Click on the Clear Foldout States button in the asset’s inspector.