Difference between revisions of "WD2 ScriptHook: config.json"

From Nomad DB
(Created page with "The ''config.json'' is used to enable/disable and configure options for the ScriptHook. == Options == === core === * '''core.win32Console''' (boolean) Enables/Disables a...")
 
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
The ''config.json'' is used to enable/disable and configure options for the [[ScriptHook]].
 
The ''config.json'' is used to enable/disable and configure options for the [[ScriptHook]].
  
== Options ==
+
= Options =
=== core ===
+
== core ==
 
* '''core.win32Console''' (boolean) Enables/Disables a Console window
 
* '''core.win32Console''' (boolean) Enables/Disables a Console window
 +
 +
* '''core.crashDumpsEnabled''' (boolean) Enables/Disables our Crash Reporter
  
 
* '''core.console.key''' (Key: integer or string) Key Binding for ingame Console
 
* '''core.console.key''' (Key: integer or string) Key Binding for ingame Console
Line 11: Line 13:
 
* '''core.paths''' -- Do not use --
 
* '''core.paths''' -- Do not use --
  
=== game ===
+
== game ==
 
Manages game-specific features.
 
Manages game-specific features.
  
Line 20: Line 22:
 
'''game.disableDistrictChangeUINotification''' (boolean) Enables/Disables "Distrinct Changed" Notification ingame
 
'''game.disableDistrictChangeUINotification''' (boolean) Enables/Disables "Distrinct Changed" Notification ingame
  
=== scriptHook ===
+
== scriptHook ==
 
[[ScriptHook]]-specific features.
 
[[ScriptHook]]-specific features.
  
Line 27: Line 29:
 
'''scriptHook.d3d11DebugFlag''' -- Do not use --
 
'''scriptHook.d3d11DebugFlag''' -- Do not use --
  
== Default config.json ==
+
= Default config.json =
 
<pre>
 
<pre>
 
{
 
{
 
"core": {
 
"core": {
 
"win32Console": false,
 
"win32Console": false,
 +
"crashDumpsEnabled": true,
 
 
 
"console": {
 
"console": {
Line 54: Line 57:
 
"scriptHook": {
 
"scriptHook": {
 
"enableAutoRefresh": true,
 
"enableAutoRefresh": true,
"d3d11DebugFlag": true
+
"d3d11DebugFlag": false
 
}
 
}
 
}
 
}
 
</pre>
 
</pre>
  
== Related Pages ==
+
= Related Pages =
 
* [[ScriptHook]]
 
* [[ScriptHook]]

Latest revision as of 21:55, 12 October 2020

The config.json is used to enable/disable and configure options for the ScriptHook.

Options

core

  • core.win32Console (boolean) Enables/Disables a Console window
  • core.crashDumpsEnabled (boolean) Enables/Disables our Crash Reporter
  • core.console.key (Key: integer or string) Key Binding for ingame Console
  • core.console.lineLimit (integer) Maximum amount of lines
  • core.paths -- Do not use --

game

Manages game-specific features.

game.skipIntro (boolean) Enables/Disables the startup videos

game.discordRichPresence (boolean) Enables/Disables Game status display within Discord

game.disableDistrictChangeUINotification (boolean) Enables/Disables "Distrinct Changed" Notification ingame

scriptHook

ScriptHook-specific features.

scriptHook.enableAutoRefresh (boolean) Enables/Disables automatic reloading of Scripts when the underlying files are modified.

scriptHook.d3d11DebugFlag -- Do not use --

Default config.json

{
	"core": {
		"win32Console": false,
		"crashDumpsEnabled": true,
		
		"console": {
			"key": "F1",
			"lineLimit": 150
		},
		
		"paths": {
			"vfs": "data/vfs",
			"lua": "data/scripts",
			"lua_main": "data/lua/main.lua",
			"versions": "data"
		}
	},
	
	"game": {
		"skipIntro": true,
		"discordRichPresence": true,
		"disableDistrictChangeUINotification": true
	},

	"scriptHook": {
		"enableAutoRefresh": true,
		"d3d11DebugFlag": false
	}
}

Related Pages