Resource Manager – Arma Reforger

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "{{Link|Arma Reforger:String Editor|String Editor}}" to "{{Link|Arma Reforger:String Editor}}")
 
(9 intermediate revisions by the same user not shown)
Line 5: Line 5:


=== Interface ===
=== Interface ===
[[File:armareforger-resource-manager-main-view.gif|1561x1561px]]
 
 
<div class="float-right">
[[File:armareforger-resource-manager-main-view.gif|thumb|500px]]
</div>
 
By default, '''Resource Manager''' welcomes you with 4 main sections:
By default, '''Resource Manager''' welcomes you with 4 main sections:
1) '''Resource Browser''' - this window can be used to
2) '''Main Window -''' If there are not tabs opened, then '''Welcome Tab''' will be visible. When resource is opened, it will appear in this main window area in a tab.


3) '''Log Console''' - Window containing live updated logs from current session.
# '''Resource Browser''' - as its name suggests, this window can be used to browse through available resources from base game and loaded mods
# '''Main Window''' - if there are not tabs opened, then '''Welcome Tab''' will be visible. When resource is opened, it will appear in this main window area in a tab.
# '''Log Console''' - window containing live updated logs from current session.
# '''Window Menu''' - in top toolbar it is possible to access '''all available Editors''' , options, plugins and other things. More details can be found below


4) '''Window Menu -''' In top toolbar it is possible to access '''all available Editors''' , options, plugins and other things. More details can be found below
Beside that, the Workbench version is available in the bottom right corner along to which backend (Production = Stable branch, Submission = Experimental branch) it is connected.


Beside that, in bottom right corner '''(5)''' you can info about version of the '''Workbench''' and to which backend (''Production - Stable, Submission = Experimental version of the game'') it is connected.


==Window Menu==
== Window Menu ==


{| class="wikitable"
{| class="wikitable"
!Title
! Title
!Hierarchy
! Hierarchy
!
|-
|-
!Workbench
! Workbench
|
|
*Save
* Save
*Save All
* Save All
*Options
* Options
*Publish Project
* Publish Project
*Login/Logout
* Login/Logout
*Exit
* Exit
|1
|-
|-
!Editors
! Editors
|
*World Editor
*Particle Editor
*Animation Editor
*Script Editor
*Audio Editor
*Behavior Editor
*Procedural Animation Editor
*String Editor
|
|
* {{Link|Arma Reforger:World Editor}}
* {{Link|Arma Reforger:Particle Editor}}
* {{Link|Arma Reforger:Animation Editor}}
* {{Link|Arma Reforger:Script Editor}}
* {{Link|Arma Reforger:Audio Editor}}
* {{Link|Arma Reforger:Behavior Editor}}
* {{Link|Arma Reforger:Procedural Animation Editor}}
* {{Link|Arma Reforger:String Editor}}
|-
|-
!View
! View
|
*Normal view
*Text view
*Hex view
**8 bytes
**16 bytes
**32 bytes
|
|
* Normal view
* Text view
* Hex view
** 8 bytes
** 16 bytes
** 32 bytes
|-
|-
!Edit
! Edit
|
*Undo
*Redo
*Reimport resource
*Locate file in resource browser
|
|
* Undo
* Redo
* Reimport resource
* Locate file in resource browser
|-
|-
!Window
! Window
|
|
*Next Tab
* Next Tab
*Prev Tab
* Prev Tab
*Cycle Tabs
* Cycle Tabs
*Close Current Tab
* Close Current Tab
*Undo Close Tab
* Undo Close Tab


*Log Console
* Log Console
*Resource Browser
* Resource Browser
*Resource Browser 2
* Resource Browser 2
|
|-
|-
!Utilities
! Utilities
|
*Generate GUID
*File system sources
*Qt introspection tool
|
|
* Generate GUID
* File system sources
* Qt introspection tool
|-
|-
!Plugins
! Plugins
|
|
*Settings
* Settings
**Reload WB Scripts
** Reload WB Scripts
**Clear All Settings
** Clear All Settings
**List world resources
** List world resources
**Texture Import
** Texture Import
**Model Import
** Model Import
**Material Import
** Material Import
**Terrain Import
** Terrain Import
**Edit Selected Prefab(s)
** Edit Selected Prefab(s)
**SVN Log
** SVN Log
**Create/Update Selected Editable Prefabs
** Create/Update Selected Editable Prefabs


*Image Set Generator
* Image Set Generator
*Batch resource processor
* Batch resource processor
*Batch texture processor
* Batch texture processor
*Re-Save Meta Tool
* Re-Save Meta Tool
*Re-Save Tool
* Re-Save Tool
*In-game Editor
* In-game Editor
**Register Placeable Entities...
** Register Placeable Entities...
**Update All Editable Prefabs
** Update All Editable Prefabs
**Create/Update Selected Editable Prefabs
** Create/Update Selected Editable Prefabs
*SVN
* SVN
**SVN Log
** SVN Log
*User Settings
* User Settings
**Edit Engine Settings
** Edit Engine Settings
**Edit Game Settings
** Edit Game Settings
|
|-
|-
!Help
! Help
|
*About
|
|
* About
|}
|}


===Workbench===
=== Workbench ===


====Save====
==== Save ====
Save the file from the currently selected tab.
Save the file from the currently selected tab.


====Save All====
==== Save All ====
Save the file from all opened tabs.
Save the file from all opened tabs.


====Options ====
==== Options ====
See [[Arma Reforger:Resource Manager: Options|Resource Manager: Options]]
See [[Arma Reforger:Resource Manager: Options|Resource Manager: Options]]


====Login/Logout====
==== Login/Logout ====
Log in or out of the Bohemia account. Logging in allows for publishing online to the [[Arma Reforger:Workshop|Bohemia Workshop]].
Log in or out of the Bohemia account. Logging in allows for publishing online to the [[Arma Reforger:Workshop|Bohemia Workshop]].


====Publish Project ====
==== Publish Project ====
[[Arma Reforger:Mod Publishing Process|Publish the mod]] in its current state.
[[Arma Reforger:Mod Publishing Process|Publish the mod]] in its current state.


====Exit====
==== Exit ====
Close the Workbench and all other open editors, if any.
Close the Workbench and all other open editors, if any.


===Editors ===
=== Editors ===


This menu allows for navigating through all available editors.
This menu allows for navigating through all available editors.
Line 148: Line 140:
{{Feature|informative|Greyed out editors are either already opened or unopenable as per the script base status (non-compilable code).}}
{{Feature|informative|Greyed out editors are either already opened or unopenable as per the script base status (non-compilable code).}}


===View===
=== View ===


This menu allows the switching of the current tab's view mode between:
This menu allows the switching of the current tab's view mode between:


*'''Normal''' view
* '''Normal''' view
*'''Text''' view
* '''Text''' view
*'''Hex''' view (8, 16 or 32B)
* '''Hex''' view (8, 16 or 32B)


{{Feature|informative|'''Text''' and '''Hex''' views are '''read-only'''.}}
{{Feature|informative|'''Text''' and '''Hex''' views are '''read-only'''.}}


===Edit===
=== Edit ===


====Undo====
==== Undo ====
Undo the last applied action to the world. Shortcut: {{Controls|Ctrl|Z}}.
Undo the last applied action to the world. Shortcut: {{Controls|Ctrl|Z}}.


====Redo====
==== Redo ====
Reapply the last undone action. Shortcut: {{Controls|Ctrl|Y}}.
Reapply the last undone action. Shortcut: {{Controls|Ctrl|Y}}.


====Reimport resource====
==== Reimport resource ====
Reload the current file from storage. Wanted changes must have been saved first! Shortcut: {{Controls|F5}}.
Reload the current file from storage. Wanted changes must have been saved first! Shortcut: {{Controls|F5}}.


====Locate file in resource browser ====
==== Locate file in resource browser ====
Show the selected file in the Resource Browser tree. Shortcut: {{Controls|Ctrl|B}}.
Show the selected file in the Resource Browser tree. Shortcut: {{Controls|Ctrl|B}}.


====Edit prefab====
==== Edit prefab ====
Open the World Editor to edit the currently-opened prefab. Shortcut: {{Controls|Ctrl|E}}.
Open the World Editor to edit the currently-opened prefab. Shortcut: {{Controls|Ctrl|E}}.


===Window===
=== Window ===


The first section groups Tab operations.
The first section groups Tab operations.
Line 181: Line 173:
The second section groups Window operations.
The second section groups Window operations.


====Next Tab====
==== Next Tab ====
Shortcut: {{Controls|Ctrl|PageDown}}.
Shortcut: {{Controls|Ctrl|PageDown}}.


====Previous Tab====
==== Previous Tab ====
Shortcut: {{Controls|Ctrl|PageUp}}.
Shortcut: {{Controls|Ctrl|PageUp}}.


====Cycle Tabs====
==== Cycle Tabs ====
Shortcut: {{Controls|Ctrl|Tab}}.
Shortcut: {{Controls|Ctrl|Tab}}.


====Close Current Tab====
==== Close Current Tab ====
Shortcut: {{Controls|Ctrl|W}}.
Shortcut: {{Controls|Ctrl|W}}.


====Undo Close Tab====
==== Undo Close Tab ====
Shortcut: {{Controls|Ctrl|Shift|T}}.
Shortcut: {{Controls|Ctrl|Shift|T}}.


====Log Console ====
==== Log Console ====
Hide/show the Log Console and its history. Shortcut: {{Controls|F1}}.
Hide/show the Log Console and its history. Shortcut: {{Controls|F1}}.


====Resource Browser ====
==== Resource Browser ====
Hide/show the "project tree" view. Shortcut: {{Controls|F3}}.
Hide/show the "project tree" view. Shortcut: {{Controls|F3}}.


====Resource Browser 2====
==== Resource Browser 2 ====
Hide/show a secondary Resource Browser. This one has no keyboard shortcuts.
Hide/show a secondary Resource Browser. This one has no keyboard shortcuts.


===Utilities===
=== Utilities ===


====Generate GUID====
==== Generate GUID ====
Generate a new Globally Unique IDentifier.  
Generate a new Globally Unique IDentifier.


====File system dump====
==== File system dump ====
Show which directories are used as source, in the form of
Show which directories are used as source, in the form of


Line 217: Line 209:
#'''profile''' game user profile directory
#'''profile''' game user profile directory


====Qt introspection tool====
==== Qt introspection tool ====
Show debug information about Qt, the Workbench Graphical User Interface (GUI).
Show debug information about Qt, the Workbench Graphical User Interface (GUI).


===Plugins ===
=== Plugins ===


This menu lists Workbench plugins. Each plugin has its own usage and user manual.
This menu lists Workbench plugins. Each plugin has its own usage and user manual.


====Settings====
==== Settings ====


=====Reload WB Scripts =====
===== Reload WB Scripts =====
Reload Workbench plugins. Shortcut: {{Controls|Ctrl|Shift|R}}  
Reload Workbench plugins. Shortcut: {{Controls|Ctrl|Shift|R}}


===== Clear All Settings=====
===== Clear All Settings =====
Resets all parameters that have been changed, Workbench parameters included.
Resets all parameters that have been changed, Workbench parameters included.


=====Texture Import=====
===== Texture Import =====


=====Model Import=====
===== Model Import =====


=====Material import=====
===== Material import =====


=====Terrain Import=====
===== Terrain Import =====


=====Edit Selected Prefab(s)=====
===== Edit Selected Prefab(s) =====


=====Create/Update Selected Editable Prefabs =====
===== Create/Update Selected Editable Prefabs =====


=====Bookmark #=====
===== Bookmark # =====


=====SVN Log =====
===== SVN Log =====


====Batch resource processor====
==== Batch resource processor ====


====Batch texture processor====
==== Batch texture processor ====


====Re-Save Meta Tool====
==== Re-Save Meta Tool ====
Re-save the {{hl|.meta}} files for files having the provided extensions. Useful if a format has changed and files should be re-saved.
Re-save the {{hl|.meta}} files for files having the provided extensions. Useful if a format has changed and files should be re-saved.


====Re-Save Tool====
==== Re-Save Tool ====
Re-save the files having the provided extensions. Useful if a format has changed and files should be re-saved.
Re-save the files having the provided extensions. Useful if a format has changed and files should be re-saved.


Extensions are to be provided '''without''' the dot (e.g {{hl|layout}} and not {{hl|.layout}})
Extensions are to be provided '''without''' the dot (e.g {{hl|layout}} and not {{hl|.layout}})


====Image Set Generator====
==== Image Set Generator ====


====In-game Editor====
==== In-game Editor ====


====User Settings====
==== User Settings ====


=====Edit Engine Settings=====
===== Edit Engine Settings =====


=====Edit Game Settings=====
===== Edit Game Settings =====


=====Register Placeable Entities...=====
===== Register Placeable Entities... =====


=====Update All Editable Prefabs =====
===== Update All Editable Prefabs =====


=====Create/Update Selected Editable Prefabs =====
===== Create/Update Selected Editable Prefabs =====


====Bookmarks====
==== Bookmarks ====


====SVN====
==== SVN ====


=====SVN Log =====
===== SVN Log =====


====Validate Behavior Trees====
==== Validate Behavior Trees ====


====Search Tool (XOBs)====
==== Search Tool (XOBs) ====


====Edit Selected Prefab(s)====
==== Edit Selected Prefab(s) ====
Shortcut: {{Controls|Ctrl|Shift|E}}
Shortcut: {{Controls|Ctrl|Shift|E}}


====Generate Class from Layout====
==== Generate Class from Layout ====


====Localize Selected Files====
==== Localize Selected Files ====
Shortcut: {{Controls|Ctrl|Alt|L}}
Shortcut: {{Controls|Ctrl|Alt|L}}


====Find Linked Resources====
==== Find Linked Resources ====


====Validate Prefabs ====
==== Validate Prefabs ====


====Generate Controls Scheme====
==== Generate Controls Scheme ====




==Resource Browser ==
== Resource Browser ==


Resource Browser is the main tool for '''navigating''' and '''managing''' game data, it can work with "local" data, packed data and both at the same time.
Resource Browser is the main tool for '''navigating''' and '''managing''' game data, it can work with "local" data, packed data and both at the same time.
Line 311: Line 303:
And lastly, over viewport, there are '''tabs''' with opened resources.{{Feature|informative|This section also applies to "Resource Browser 2" that is a simple copycat of this window.}}
And lastly, over viewport, there are '''tabs''' with opened resources.{{Feature|informative|This section also applies to "Resource Browser 2" that is a simple copycat of this window.}}


===Contextual menus===
=== Contextual Menus ===


In both windows, using {{Controls|rmb}} on files and folders opens a '''context menu''', dependent on the clicked item's type:
In both windows, using {{Controls|rmb}} on files and folders opens a '''context menu''', dependent on the clicked item's type:
{| class="wikitable"
{| class="wikitable valign-top"
!Context
! Context
!Options
! Options
!Picture
|-
|-
|Tree view
| Tree view
|
|
*Show in Explorer
* Show in Explorer


*Register
* Register
*Edit Properties
* Edit Properties
*Delete
* Delete
*Rename
* Rename


*Copy Resource Name(s)
* Copy Resource Name(s)
*Copy Resource GUID(s)
* Copy Resource GUID(s)
*SVN
* SVN
**Update
** Update
**Commit
** Commit
**Add
** Add
**Remove
** Remove
**Revert
** Revert
|
|-
|-
|File view
| File view
|
|
*Open File in New Tab
* Open File in New Tab


*Show in Explorer
* Show in Explorer
*Navigate to Folder
* Navigate to Folder


*Register<br>Registers the resource to be used (creates .meta files)
* Register<br>Registers the resource to be used (creates .meta files)
*Register and Import<br>'''Register''' and (re)'''import'''
* Register and Import<br>'''Register''' and (re)'''import'''
*Reimport<br>Converts file from source file (tiff, fbx, etc.) to Enfusion file (xob/txo, edds, etc.)
* Reimport<br>Converts file from source file (tiff, fbx, etc.) to Enfusion file (xob/txo, edds, etc.)
* Delete
* Delete
*Rename
* Rename


*[[Arma Reforger:Data Modding Basics#Navigate to Original|Navigate to Original]]
* [[Arma Reforger:Data Modding Basics#Navigate to Original|Navigate to Original]]
*[[Arma Reforger:Data Modding Basics#Navigate to Ancestor|Navigate to Ancestor]]
* [[Arma Reforger:Data Modding Basics#Navigate to Ancestor|Navigate to Ancestor]]
*[[Arma Reforger:Data Modding Basics#Navigate to Override|Navigate to Override]]
* [[Arma Reforger:Data Modding Basics#Navigate to Override|Navigate to Override]]
*[[Arma Reforger:Data Modding Basics#Using .22Override in....22 function|Override in...]]
* [[Arma Reforger:Data Modding Basics#Using .22Override in....22 function|Override in...]]
*[[Arma Reforger:Data Modding Basics#Using .22Duplicate to....22 function|Duplicate to...]]
* [[Arma Reforger:Data Modding Basics#Using .22Duplicate to....22 function|Duplicate to...]]
*[[Arma Reforger:Data Modding Basics#Using .22Inherit in....22 function|Inherit in...]]
* [[Arma Reforger:Data Modding Basics#Using .22Inherit in....22 function|Inherit in...]]
*[[Arma Reforger:Data Modding Basics#Using .22Transfer to....22 function|Transfer to...]]
* [[Arma Reforger:Data Modding Basics#Using .22Transfer to....22 function|Transfer to...]]


*Copy Resource Name(s)<br>Copies the Enfusion path to this resource (format {{hl|{GUID}path/to/file.ext}}) to the clipboard
* Copy Resource Name(s)<br>Copies the Enfusion path to this resource (format {{hl|{GUID}path/to/file.ext}}) to the clipboard
*Copy Resource GUID(s)<br>Copies the resource GUID to the clipboard
* Copy Resource GUID(s)<br>Copies the resource GUID to the clipboard
*Copy File Path(s)<br>Copies the absolute path (format {{hl|C:\path\to\file.ext}}) to the clipboard
* Copy File Path(s)<br>Copies the absolute path (format {{hl|C:\path\to\file.ext}}) to the clipboard
*Copy Link<br>Copies an [[Arma Reforger:Resource Manager: Options#Register .22enfusion:.2F.2F.22 protocol|{{hl|Enfusion://}} link]] pointing to this resource to the clipboard
* Copy Link<br>Copies an [[Arma Reforger:Resource Manager: Options#Register .22enfusion:.2F.2F.22 protocol|{{hl|Enfusion://}} link]] pointing to this resource to the clipboard
*SVN
* SVN
**Update
** Update
**Commit
** Commit
**Add
** Add
**Remove
** Remove
**Revert
** Revert
*Find References<br>'''expensive operation''' looks through all project files to find a reference to this element. ''not present for script files''
* Find References<br>'''expensive operation''' looks through all project files to find a reference to this element. ''not present for script files''
*Refresh Thumbnail(s)
* Refresh Thumbnail(s)
*[[Arma Reforger:Prefabs Basics#Prefab edit mode|Edit Prefab(s)]]<br>[[Arma Reforger:Prefabs Basics#Opening prefab in Prefab Edit Mode|Opens the prefab]] in [[Arma Reforger:World Editor|World Editor]] in Prefab Edit Mode to see and edit it
* [[Arma Reforger:Prefabs Basics#Prefab edit mode|Edit Prefab(s)]]<br>[[Arma Reforger:Prefabs Basics#Opening prefab in Prefab Edit Mode|Opens the prefab]] in [[Arma Reforger:World Editor|World Editor]] in Prefab Edit Mode to see and edit it
*Save changes
* Save changes
*Revert changes
* Revert changes
|
|}
|}


===Usage===
=== Usage ===


====Search bar====
==== Search bar ====
The '''Search bar''' allows the typing of words/sequences, separated by a space, that should be found in the file name - including keywords.
The '''Search bar''' allows the typing of words/sequences, separated by a space, that should be found in the file name - including keywords.


e.g. looking for {{hl|village 1i03 .xob}} will find and pinpoint {{hl|House_Village_E_1I03.xob}}.
e.g. looking for {{hl|village 1i03 .xob}} will find and pinpoint {{hl|House_Village_E_1I03.xob}}.


====Filters ====
==== Filters ====
{| class="wikitable"
* Show Runtime files only
|
* Show unregistered sources only
*Show Runtime files only
*Show unregistered sources only


*'''Filter by Category'''<br>Filter files by type (See [[Arma Reforger:File Types|File Types]])
* '''Filter by Category'''<br>Filter files by type (See [[Arma Reforger:File Types|File Types]])
|
|}


====Options ====
==== Options ====
{| class="wikitable"
* Expand All on Search
|
*Expand All on Search


*Horizontal Layout
* Horizontal Layout
*Vertical Layout
* Vertical Layout


*Grid View
* Grid View
*List View
* List View


* On with filters
* On with filters
*Always On
* Always On
*Always Off
* Always Off


*Icons Scale
* Icons Scale


*Sort by Name
* Sort by Name
*Sort by Size
* Sort by Size
*Sort by Type
* Sort by Type
*Sort by Date
* Sort by Date


* Ascending sorting order
* Ascending sorting order
* Descending sorting order
* Descending sorting order
|
|}




==Viewport==
== Viewport ==


=== Tabs===
=== Tabs ===


{| class="wikitable"
{| class="wikitable valign-top"
|Right-click
| Right-click
|
|
*Close Tab
* Close Tab
*Close All Tabs
* Close All Tabs
*Close All But This
* Close All But This
*Reopen Closed Tabs
* Reopen Closed Tabs


* Navigate to File
* Navigate to File
*Show in Explorer
* Show in Explorer
|
|}
|}
A '''double-click''' on the tab will '''Locate''' the file '''in Resource Browser''', when a middle mouse button click will close it.
A '''double-click''' on the tab will '''Locate''' the file '''in Resource Browser''', when a middle mouse button click will close it.


===Viewport Types===
=== Viewport Types ===


See {{GameCategory|armaR|Modding|Official Tools|Resource Manager Viewports|link= y}}.
See {{GameCategory|armaR|Modding|Official Tools|Resource Manager Viewports|link= y}}.




==Log Console ==
== Log Console ==


Log console displays various messages, they can be either '''informative''', '''warnings''' or '''errors''', and can be sorted by '''type''' or '''category'''.
Log console displays various messages, they can be either '''informative''', '''warnings''' or '''errors''', and can be sorted by '''type''' or '''category'''.




==Details / Import Settings==
== Details / Import Settings ==


'''Details''' and '''Import Settings''' tabs are closely related, even dependent on the Viewport type. See Resource Manager: Viewport for more respective details.
'''Details''' and '''Import Settings''' tabs are closely related, even dependent on the Viewport type. See Resource Manager: Viewport for more respective details.


===Import Settings===
=== Import Settings ===


This tab is about import options. Each type of resource has different options available that are detailed in Resource Manager: Viewport.
This tab is about import options. Each type of resource has different options available that are detailed in Resource Manager: Viewport.
Line 462: Line 443:
{{Feature|informative|Each platform has its own settings, but all of them inherit from PC.}}
{{Feature|informative|Each platform has its own settings, but all of them inherit from PC.}}


====Edit also selected files====
==== Edit also selected files ====
It is possible to edit multiple files at once. To do that, you need to check the "Edit also selected files" checkbox and select files in Resource Browser.
It is possible to edit multiple files at once. To do that, you need to check the "Edit also selected files" checkbox and select files in Resource Browser.


====Parameters====
==== Parameters ====
Different per resource type, each described in {{GameCategory|armaR|Modding|Official Tools|Resource Manager Viewports|link= y}}.
Different per resource type, each described in {{GameCategory|armaR|Modding|Official Tools|Resource Manager Viewports|link= y}}.




==General Shortcuts==
== General Shortcuts ==


{| class="wikitable"
{| class="wikitable"
!Shortcut
! Shortcut
!Function
! Function
|-
|-
|{{Controls|Ctrl|S}}
| {{Controls|Ctrl|S}}
|Saves resource in active tab
| Saves resource in active tab
|-
|-
|{{Controls|Ctrl|Shift|S}}
| {{Controls|Ctrl|Shift|S}}
|Save all
| Save all
|-
|-
|{{Controls|F5}}
| {{Controls|F5}}
|Reimports active resource
| Reimports active resource
|-
|-
|{{Controls|Ctrl|B}}
| {{Controls|Ctrl|B}}
|Locates active resource in Resource Browser
| Locates active resource in Resource Browser
|-
|-
|{{Controls|F1}}
| {{Controls|F1}}
|Opens/closes log console
| Opens/closes log console
|-
|-
|{{Controls|F3}}
| {{Controls|F3}}
|Opens/closes Resource Browser window
| Opens/closes Resource Browser window
|-
|-
|{{Controls|Ctrl|Page Up}}
| {{Controls|Ctrl|Page Up}}
|Next tab
| Next tab
|-
|-
|{{Controls|Ctrl|Page Down}}
| {{Controls|Ctrl|Page Down}}
|Previous tab
| Previous tab
|-
|-
|{{Controls|Ctrl|Tab}}
| {{Controls|Ctrl|Tab}}
|Cycles between opened tab
| Cycles between opened tab
|-
|-
|{{Controls|Ctrl|W}}
| {{Controls|Ctrl|W}}
|Closes active tab
| Closes active tab
|}
|}


{{GameCategory|armaR|Modding|Official Tools}}
{{GameCategory|armaR|Modding|Official Tools}}

Latest revision as of 00:58, 12 January 2024

Welcome to the Enfusion Workbench - Resource Manager!

The Resource Manager is an integral part of the main "hub" of the Enfusion Workbench. The Resource Manager is its asset manager, which allows for importing, managing and editing assets and their related files. It’s also the place from which navigation to other tools or areas of Workbench can be done, as well as accessing project and Workbench options, build data, package, build project and more.

Interface

armareforger-resource-manager-main-view.gif

By default, Resource Manager welcomes you with 4 main sections:

  1. Resource Browser - as its name suggests, this window can be used to browse through available resources from base game and loaded mods
  2. Main Window - if there are not tabs opened, then Welcome Tab will be visible. When resource is opened, it will appear in this main window area in a tab.
  3. Log Console - window containing live updated logs from current session.
  4. Window Menu - in top toolbar it is possible to access all available Editors , options, plugins and other things. More details can be found below

Beside that, the Workbench version is available in the bottom right corner along to which backend (Production = Stable branch, Submission = Experimental branch) it is connected.


Window Menu

Title Hierarchy
Workbench
  • Save
  • Save All
  • Options
  • Publish Project
  • Login/Logout
  • Exit
Editors
View
  • Normal view
  • Text view
  • Hex view
    • 8 bytes
    • 16 bytes
    • 32 bytes
Edit
  • Undo
  • Redo
  • Reimport resource
  • Locate file in resource browser
Window
  • Next Tab
  • Prev Tab
  • Cycle Tabs
  • Close Current Tab
  • Undo Close Tab
  • Log Console
  • Resource Browser
  • Resource Browser 2
Utilities
  • Generate GUID
  • File system sources
  • Qt introspection tool
Plugins
  • Settings
    • Reload WB Scripts
    • Clear All Settings
    • List world resources
    • Texture Import
    • Model Import
    • Material Import
    • Terrain Import
    • Edit Selected Prefab(s)
    • SVN Log
    • Create/Update Selected Editable Prefabs
  • Image Set Generator
  • Batch resource processor
  • Batch texture processor
  • Re-Save Meta Tool
  • Re-Save Tool
  • In-game Editor
    • Register Placeable Entities...
    • Update All Editable Prefabs
    • Create/Update Selected Editable Prefabs
  • SVN
    • SVN Log
  • User Settings
    • Edit Engine Settings
    • Edit Game Settings
Help
  • About

Workbench

Save

Save the file from the currently selected tab.

Save All

Save the file from all opened tabs.

Options

See Resource Manager: Options

Login/Logout

Log in or out of the Bohemia account. Logging in allows for publishing online to the Bohemia Workshop.

Publish Project

Publish the mod in its current state.

Exit

Close the Workbench and all other open editors, if any.

Editors

This menu allows for navigating through all available editors.

ⓘ
Greyed out editors are either already opened or unopenable as per the script base status (non-compilable code).

View

This menu allows the switching of the current tab's view mode between:

  • Normal view
  • Text view
  • Hex view (8, 16 or 32B)
ⓘ
Text and Hex views are read-only.

Edit

Undo

Undo the last applied action to the world. Shortcut: Ctrl + Z.

Redo

Reapply the last undone action. Shortcut: Ctrl + Y.

Reimport resource

Reload the current file from storage. Wanted changes must have been saved first! Shortcut: F5.

Locate file in resource browser

Show the selected file in the Resource Browser tree. Shortcut: Ctrl + B.

Edit prefab

Open the World Editor to edit the currently-opened prefab. Shortcut: Ctrl + E.

Window

The first section groups Tab operations.

The second section groups Window operations.

Next Tab

Shortcut: Ctrl + ↡ PgDown.

Previous Tab

Shortcut: Ctrl + ↟ PgUp.

Cycle Tabs

Shortcut: Ctrl + ↹ Tab.

Close Current Tab

Shortcut: Ctrl + W.

Undo Close Tab

Shortcut: Ctrl + ⇧ Shift + T.

Log Console

Hide/show the Log Console and its history. Shortcut: F1.

Resource Browser

Hide/show the "project tree" view. Shortcut: F3.

Resource Browser 2

Hide/show a secondary Resource Browser. This one has no keyboard shortcuts.

Utilities

Generate GUID

Generate a new Globally Unique IDentifier.

File system dump

Show which directories are used as source, in the form of

  1. <Game> game data directory
  2. core ./addons/core/
  3. profile game user profile directory

Qt introspection tool

Show debug information about Qt, the Workbench Graphical User Interface (GUI).

Plugins

This menu lists Workbench plugins. Each plugin has its own usage and user manual.

Settings

Reload WB Scripts

Reload Workbench plugins. Shortcut: Ctrl + ⇧ Shift + R

Clear All Settings

Resets all parameters that have been changed, Workbench parameters included.

Texture Import
Model Import
Material import
Terrain Import
Edit Selected Prefab(s)
Create/Update Selected Editable Prefabs
Bookmark #
SVN Log

Batch resource processor

Batch texture processor

Re-Save Meta Tool

Re-save the .meta files for files having the provided extensions. Useful if a format has changed and files should be re-saved.

Re-Save Tool

Re-save the files having the provided extensions. Useful if a format has changed and files should be re-saved.

Extensions are to be provided without the dot (e.g layout and not .layout)

Image Set Generator

In-game Editor

User Settings

Edit Engine Settings
Edit Game Settings
Register Placeable Entities...
Update All Editable Prefabs
Create/Update Selected Editable Prefabs

Bookmarks

SVN

SVN Log

Validate Behavior Trees

Search Tool (XOBs)

Edit Selected Prefab(s)

Shortcut: Ctrl + ⇧ Shift + E

Generate Class from Layout

Localize Selected Files

Shortcut: Ctrl + Alt + L

Find Linked Resources

Validate Prefabs

Generate Controls Scheme

Resource Browser

Resource Browser is the main tool for navigating and managing game data, it can work with "local" data, packed data and both at the same time.

Default layout provides navigation through game data in two windows - one displays directories in tree layout and the other displays content (sub-directories and files) of the selected one.

There is a Search bar at the top left which has various filters and options available.

And lastly, over viewport, there are tabs with opened resources.

ⓘ
This section also applies to "Resource Browser 2" that is a simple copycat of this window.

Contextual Menus

In both windows, using Right Mouse Button on files and folders opens a context menu, dependent on the clicked item's type:

Context Options
Tree view
  • Show in Explorer
  • Register
  • Edit Properties
  • Delete
  • Rename
  • Copy Resource Name(s)
  • Copy Resource GUID(s)
  • SVN
    • Update
    • Commit
    • Add
    • Remove
    • Revert
File view
  • Open File in New Tab
  • Show in Explorer
  • Navigate to Folder
  • Register
    Registers the resource to be used (creates .meta files)
  • Register and Import
    Register and (re)import
  • Reimport
    Converts file from source file (tiff, fbx, etc.) to Enfusion file (xob/txo, edds, etc.)
  • Delete
  • Rename
  • Copy Resource Name(s)
    Copies the Enfusion path to this resource (format {GUID}path/to/file.ext) to the clipboard
  • Copy Resource GUID(s)
    Copies the resource GUID to the clipboard
  • Copy File Path(s)
    Copies the absolute path (format C:\path\to\file.ext) to the clipboard
  • Copy Link
    Copies an Enfusion:// link pointing to this resource to the clipboard
  • SVN
    • Update
    • Commit
    • Add
    • Remove
    • Revert
  • Find References
    expensive operation looks through all project files to find a reference to this element. not present for script files
  • Refresh Thumbnail(s)
  • Edit Prefab(s)
    Opens the prefab in World Editor in Prefab Edit Mode to see and edit it
  • Save changes
  • Revert changes

Usage

Search bar

The Search bar allows the typing of words/sequences, separated by a space, that should be found in the file name - including keywords.

e.g. looking for village 1i03 .xob will find and pinpoint House_Village_E_1I03.xob.

Filters

  • Show Runtime files only
  • Show unregistered sources only
  • Filter by Category
    Filter files by type (See File Types)

Options

  • Expand All on Search
  • Horizontal Layout
  • Vertical Layout
  • Grid View
  • List View
  • On with filters
  • Always On
  • Always Off
  • Icons Scale
  • Sort by Name
  • Sort by Size
  • Sort by Type
  • Sort by Date
  • Ascending sorting order
  • Descending sorting order


Viewport

Tabs

Right-click
  • Close Tab
  • Close All Tabs
  • Close All But This
  • Reopen Closed Tabs
  • Navigate to File
  • Show in Explorer

A double-click on the tab will Locate the file in Resource Browser, when a middle mouse button click will close it.

Viewport Types

See Arma Reforger/Modding/Official Tools/Resource Manager Viewports.


Log Console

Log console displays various messages, they can be either informative, warnings or errors, and can be sorted by type or category.


Details / Import Settings

Details and Import Settings tabs are closely related, even dependent on the Viewport type. See Resource Manager: Viewport for more respective details.

Import Settings

This tab is about import options. Each type of resource has different options available that are detailed in Resource Manager: Viewport.

If any changes are done in this category, it’s required to click on the "Reimport resource" button at the top to take effect.

ⓘ
Each platform has its own settings, but all of them inherit from PC.

Edit also selected files

It is possible to edit multiple files at once. To do that, you need to check the "Edit also selected files" checkbox and select files in Resource Browser.

Parameters

Different per resource type, each described in Arma Reforger/Modding/Official Tools/Resource Manager Viewports.


General Shortcuts

Shortcut Function
Ctrl + S Saves resource in active tab
Ctrl + ⇧ Shift + S Save all
F5 Reimports active resource
Ctrl + B Locates active resource in Resource Browser
F1 Opens/closes log console
F3 Opens/closes Resource Browser window
Ctrl + Page Up Next tab
Ctrl + Page Down Previous tab
Ctrl + ↹ Tab Cycles between opened tab
Ctrl + W Closes active tab
Retrieved from "https://community.bistudio.com/wiki?title=Arma_Reforger:Resource_Manager&oldid=351823"