Folders structure
- Last UpdatedDec 06, 2023
- 2 minute read
The first item in the project is the application root (the project folder).
It is recommended that you use a source control software to host versioned application files and to enable parallel development.
First level
The content at the first level.
|
Folder |
Description |
|---|---|
|
code folder |
The folder containing the application source files. |
|
_release folder |
This folder is generated by the XR Studio Make Release tool. It contains a compiled application version for testing or deploy. |
|
bridge folder |
Contains an instance of the bridge application for testing connection to the process simulator with or without the application running. |
|
other folders |
Folders for project documentation, graphical source files and so on. |
Inside the Code folder
The code folder is the development root. It contains these files.
|
Files |
Description |
|---|---|
|
project.mwprj |
The project file. |
|
.mwpl files |
The license.mwpl to be used with the XR Studio and licenserelease.mwpl to be used with the compiled application. |
|
.log files |
The application log files together with the previous five versions. |
|
The application configuration file used by the XR Settings. |
|
|
custom.xml |
Containing the project-based settings and used by the XR Settings. |
|
data folder |
This folder is not used in virtual plant projects. It usually stores files to be read and written by the application for authentication or performance storing. |
|
GameData folder |
The repository of all the project-related contents, such as textures, scripts, models. |
Inside the GameData folder
GameData is the root for all possible application content.
All files used by the application must be in the GameData folder.
GameData folders
Folders with corresponding contents in the .pak module files (textures, models, logic, and sounds) require the user subfolder to avoid potential name duplications.
-
This structure reflects the structure contained in the config.xmlPlatform.dirs section.
-
If you must add or change folders to this structure, modify the config file accordingly.
GameData directory structure
The GameData directory is structured as follows.
|
Folder |
Description |
|---|---|
|
Bridge folder |
Contains the Bridge Generator-related files: both sources and outputs to be copied locally to bridge application. (Optional) |
|
Cache |
Hosts TextureSwitch information or changed resolution textures to speed up the application loading. (Automatically generated) |
|
Configuration |
Stores application configurations to manage with the Project Property Editor and use with the Application toolbar of the XR Studio. (Optional) |
|
HDR |
Stores all the HDR and post-process settings. |
|
Languages |
Contains the lang.xml file and all the languages files, such as lang_en.xml. |
|
Logic/user |
Contains the project-related script files. |
|
MenuTextures |
Not used. |
|
Models/user |
Contains the MWX source files. |
|
Movies: |
Not used. |
|
Sounds/user |
Hosts the application sound effects (.ogg format). |
|
Shaders/user |
Contains the shader library and all shaders. |