Skip to main content

Startup Configuration Files

A startup configuration file needs to be configured for fx_main.exe to start correctly. Take game_framework_editor.ini as an example to illustrate the related configuration options as follows:

SectionItemDescriptionNecessary
SystemSleepLoop sleep milliseconds (If less than 0, no sleep)Yes
MainEntityMain entity type. An object of this type will be created as the main entity when starting the Engine. It will be returned by the ICore::GetMainEntity script interface nx_main. The main entity type of the Client Engine is generally fx_world.world.No
MainScriptMain script. If it is not empty, the Engine will call the main function of the specified script under the script path when starting, with the calling parameters as the main entity and command line parameters.Yes
DllPathAppend DLL search pathYes
FileSystemSpecify which file system to be used. If it is empty, the built-in file system in the fx_core module will be used by default.Yes
FileConfigConfig files in the file systemYes
Module[dllname]Each item name represents a DLL that needs to be loaded.No
ScriptPathScript pathNo
ReloadWhether to enable script Hot Reload. 1 is on, while 0 is off.Yes
ResourcePathResource path. If OPEN_PROJECT is in the command line parameter of fx_main.exe, the current configs will be overridden by the ones in the project files specified by the OPEN_PROJECT parameter.No
EditorResourcePathEditor resource pathYes
EngineResourcePathEngine required resource pathNo
EngineShaderPathShader pathNo
EngineThemesPathTheme pathYes
ProjectTemplatesPathProject template path (Valid in Editor only)Yes
EngineConfigengine_configEngine config path, the folder configured relative to EngineResourceNo