This article's documentation is for the "GoldSrc" engine. Click here for more information.
This article's documentation is for anything that uses the Source engine. Click here for more information.
This article's documentation is for Source 2. Click here for more information.

XBLAH's Modding Tool/Docs/Mod/Run: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Nesciuse moved page XBLAH's Modding Tool/Docs/Mod/Run/en to XBLAH's Modding Tool/Docs/Mod/Run without leaving a redirect: Move en subpage to basepage)
 
(6 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Language subpage}}
{{LanguageBar}}
{{note|This tutorial was written for {{xblahmt|4}} v1.18.1. Please be aware that subsequent updates might have introduced alterations in terminologies, introduced novel features, or reorganized certain elements within the interface.}}
{{gldsrc topicon}}
{{Source topicon}}
{{Source 2 topicon}}
 
 
{{note|This tutorial was written for {{xblahmt|4}} v2.0.2. Please be aware that subsequent updates might have introduced alterations in terminologies, introduced novel features, or reorganized certain elements within the interface.}}




Line 8: Line 13:
== Accessing the feature ==
== Accessing the feature ==


The mod can be run through via {{Path|Toolbar > [[File:XBLAH's Modding Tool - Run Mod - Default Button.png|16px]]|icon=custom|customico=Pointer.png}}.
The mod can be run through via {{Path|Toolbar > |icon=custom|customico=Pointer.png}} [[File:XBLAH's Modding Tool - Run Mod - Default Button.png]].


For additional options, an expert dialog may be accessed via {{Path|Top Menu > Mod > Run|icon=custom|customico=Pointer.png}} or via {{Path|Toolbar > Expert Mode|icon=custom|customico=Pointer.png}}.
For additional options, an expert dialog may be accessed via {{Path|Top Menu > Project > Run|icon=custom|customico=Pointer.png}} or via {{Path|Toolbar > Expert Mode|icon=custom|customico=Pointer.png}}.


== Running a Mod ==
== Running a Mod ==
Line 16: Line 21:
=== Normal ===
=== Normal ===
To run the mod, click one of the available options in the Toolbar.
To run the mod, click one of the available options in the Toolbar.
*[[File:XBLAH's Modding Tool - Run Mod - Default Button.png]] Run the mod in Fullscreen ({{goldsrc|4}} and {{source|4}} mods) or VR ({{source2|4}} mods).
*[[File:XBLAH's Modding Tool - Run Mod - Default Button.png]] Run the mod in Fullscreen ({{gldsrc|4}} and {{source|4}} mods) or VR ({{source2|4}} mods).
*[[File:XBLAH's Modding Tool - Run Mod - Fullscreen Button.png]] Run the mod in Fullscreen mode.
*[[File:XBLAH's Modding Tool - Run Mod - Fullscreen Button.png]] Run the mod in Fullscreen mode.
*[[File:XBLAH's Modding Tool - Run Mod - Windowed Button.png]] Run the mod in Windowed mode.
*[[File:XBLAH's Modding Tool - Run Mod - Windowed Button.png]] Run the mod in Windowed mode.
Line 24: Line 29:


To run the mod, select a Preset and click '''OK'''. Optionally, you can set an Additional Command. Commands starting with '''-''' are shortcut parameters, and commands starting with '''+''' are console commands. This Additional Command will be appended to the Command of the preset, rather than replacing it.
To run the mod, select a Preset and click '''OK'''. Optionally, you can set an Additional Command. Commands starting with '''-''' are shortcut parameters, and commands starting with '''+''' are console commands. This Additional Command will be appended to the Command of the preset, rather than replacing it.
You can preview what the execution command will be.


== Run Presets ==
== Run Presets ==
Line 30: Line 37:
The tool generates default presets for each mod, given the Base Game and Engine Branch. You can create new presets in case you need to run the mod multiple times with a custom configuration.
The tool generates default presets for each mod, given the Base Game and Engine Branch. You can create new presets in case you need to run the mod multiple times with a custom configuration.


{{tip|If you messed up the presets and want a factory reset, you can click the '''Reset''' button.}}
{{tip|If you messed up the presets and want a factory reset, you can click the '''Reset Presets''' button.}}


=== Add a preset ===
=== Add a preset ===
Line 57: Line 64:


=== Edit a preset ===
=== Edit a preset ===
You can also check the preset configurations by clicking the [[File:XBLAH's Modding Tool - Edit Button.png|Edit button]] button.
You can also check the preset configurations by clicking the [[File:XBLAH's Modding Tool - Edit Button.png|Edit button]] button. You can create a child preset by modifying the coverage to a more restrict option.


=== Remove a preset ===
=== Remove a preset ===
You can remove a preset by clicking the [[File:XBLAH's Modding Tool - Remove Button.png|Remove button]] button.
You can remove a preset by clicking the '''Delete''' button. If case the preset is a child of another preset (preset with a same name, but with a broader coverage), only the child preset will be deleted, by clicking the '''Use Broader Settings''' button.
 
== Preset file ==
You can manually modify the preset file, located under {{path|cfg/RunPresets.cfg|icon=file}}.
 
{{classicExample|a preset file, included in the tool.
{{pre|
"PresetFile"
{
"Version" "2"
"Presets"
{
"Default"
{
"Name" "Default"
"Engine" ""
"Game" ""
"Mod" ""
"RunMode" "fullscreen"
"Command" "-novid"
}
"Fullscreen"
{
"Name" "Fullscreen"
"Engine" ""
"Game" ""
"Mod" ""
"RunMode" "fullscreen"
"Command" "-novid"
}
"Windowed"
{
"Name" "Windowed"
"Engine" "goldsrc"
"Game" ""
"Mod" ""
"RunMode" "windowed"
"Command" "-novid"
}
"Windowed"
{
"Name" "Windowed"
"Engine" "source"
"Game" ""
"Mod" ""
"RunMode" "windowed"
"Command" "-novid"
}
"Ingame tools"
{
"Name" "Ingame tools"
"Engine" "source"
"Game" ""
"Mod" ""
"RunMode" "windowed"
"Command" "-novid -tools -nop4"
}
"Default"
{
"Name" "Default"
"Engine" "source2"
"Game" "Half-Life Alyx"
"Mod" ""
"RunMode" "vr"
"Command" "-novid"
}
"Fullscreen"
{
"Name" "Fullscreen"
"Engine" "source2"
"Game" "Half-Life Alyx"
"Mod" ""
"RunMode" "fullscreen"
"Command" "-vr_enable_fake_vr_test -novid"
}
"VR"
{
"Name" "VR"
"Engine" "source2"
"Game" "Half-Life Alyx"
"Mod" ""
"RunMode" "vr"
"Command" "-novid"
}
}
}
}}
}}
 
=== Version ===
Version indicates the default file version. It's recommended that default file updates overwrite existing user presets. If the file version is smaller than the version of {{path|cfg/RunPresets_default.cfg|icon=file}}, the tool will prompt you if you would like to overwrite it with the newer file.


== Supported Games ==
== Supported Games ==
* All {{goldsrc|4}} games
* All {{gldsrc|4}} games
* All {{source|4}} games
* All {{source|4}} games
* All {{source2|4}} games
* All {{source2|4}} games
Line 69: Line 166:
== See also ==
== See also ==
* [[File structures in Valve games]]
* [[File structures in Valve games]]
* [[Command line options]]
[[Category:Modding]]
[[Category:XBLAH's Modding Tool]]

Latest revision as of 12:31, 12 July 2024

English (en)Translate (Translate)


Note.pngNote:This tutorial was written for XBLAH's Modding Tool XBLAH's Modding Tool v2.0.2. Please be aware that subsequent updates might have introduced alterations in terminologies, introduced novel features, or reorganized certain elements within the interface.


You can run mods straight from XBLAH's Modding Tool XBLAH's Modding Tool, without having to restart Steam when you create or install a new mod. XBLAH's Modding Tool XBLAH's Modding Tool supports lots of different run modes. It contains basic presets for each game, and you can add new ones.

Accessing the feature

The mod can be run through via Custom IconToolbar > XBLAH's Modding Tool - Run Mod - Default Button.png.

For additional options, an expert dialog may be accessed via Custom IconTop Menu > Project > Run or via Custom IconToolbar > Expert Mode.

Running a Mod

Normal

To run the mod, click one of the available options in the Toolbar.

  • XBLAH's Modding Tool - Run Mod - Default Button.png Run the mod in Fullscreen (GoldSrc GoldSrc and Source Source mods) or VR (Source 2 Source 2 mods).
  • XBLAH's Modding Tool - Run Mod - Fullscreen Button.png Run the mod in Fullscreen mode.
  • XBLAH's Modding Tool - Run Mod - Windowed Button.png Run the mod in Windowed mode.
  • XBLAH's Modding Tool - Run Mod - Ingame Tools.png Run the mod with the Ingame Tools.

Expert

To run the mod, select a Preset and click OK. Optionally, you can set an Additional Command. Commands starting with - are shortcut parameters, and commands starting with + are console commands. This Additional Command will be appended to the Command of the preset, rather than replacing it.

You can preview what the execution command will be.

Run Presets

XBLAH's Modding Tool XBLAH's Modding Tool - Running a Mod
XBLAH's Modding Tool XBLAH's Modding Tool - Modifying a Run Preset

The tool generates default presets for each mod, given the Base Game and Engine Branch. You can create new presets in case you need to run the mod multiple times with a custom configuration.

Tip.pngTip:If you messed up the presets and want a factory reset, you can click the Reset Presets button.

Add a preset

You can create new presets by clicking the Add button button.

Run Mode
Defines how the mod should run.
  • Fullscreen
  • Windowed
  • VR
Note.pngNote:Game compatibility with the selected Run Mode is required.
Coverage
Defines the coverage of the selected Run Preset. Self-explanatory.
  • Global
  • Current engine only
  • Current game only
  • Current mod only
Executable <optional>
If set, the mod will run using the executable with the selected path. If none is selected, it will automatically select the game executable.
Note.pngNote:Game compatibility with custom executables is required.
Command <optional>
Extra commands can be optionally set, so they are called once the game is ran.

Edit a preset

You can also check the preset configurations by clicking the Edit button button. You can create a child preset by modifying the coverage to a more restrict option.

Remove a preset

You can remove a preset by clicking the Delete button. If case the preset is a child of another preset (preset with a same name, but with a broader coverage), only the child preset will be deleted, by clicking the Use Broader Settings button.

Preset file

You can manually modify the preset file, located under Filecfg/RunPresets.cfg.

PlacementTip.pngExample:a preset file, included in the tool.
"PresetFile"
{
	"Version"	"2"
	"Presets" 
	{
		"Default"
		{
			"Name"		"Default"
			"Engine"	""
			"Game"		""
			"Mod"		""
			"RunMode"	"fullscreen"
			"Command"	"-novid"
		}
		"Fullscreen"
		{
			"Name"		"Fullscreen"
			"Engine"	""
			"Game"		""
			"Mod"		""
			"RunMode"	"fullscreen"
			"Command"	"-novid"
		}
		"Windowed"
		{
			"Name"		"Windowed"
			"Engine"	"goldsrc"
			"Game"		""
			"Mod"		""
			"RunMode"	"windowed"
			"Command"	"-novid"
		}
			"Windowed"
		{
			"Name"		"Windowed"
			"Engine"	"source"
			"Game"		""
			"Mod"		""
			"RunMode"	"windowed"
			"Command"	"-novid"
		}
		"Ingame tools"
		{
			"Name"		"Ingame tools"
			"Engine"	"source"
			"Game"		""
			"Mod"		""
			"RunMode"	"windowed"
			"Command"	"-novid -tools -nop4"
		}
		"Default"
		{
			"Name"		"Default"
			"Engine"	"source2"
			"Game"		"Half-Life Alyx"
			"Mod"		""
			"RunMode"	"vr"
			"Command"	"-novid"
		}
		"Fullscreen"
		{
			"Name"		"Fullscreen"
			"Engine"	"source2"
			"Game"		"Half-Life Alyx"
			"Mod"		""
			"RunMode"	"fullscreen"
			"Command"	"-vr_enable_fake_vr_test -novid"
		}
		"VR"
		{
			"Name"		"VR"
			"Engine"	"source2"
			"Game"		"Half-Life Alyx"
			"Mod"		""
			"RunMode"	"vr"
			"Command"	"-novid"
		}
	}
}

Version

Version indicates the default file version. It's recommended that default file updates overwrite existing user presets. If the file version is smaller than the version of Filecfg/RunPresets_default.cfg, the tool will prompt you if you would like to overwrite it with the newer file.

Supported Games

See also