Launcher engine interaction - Revision history

Cyborg17: /* fs2_open.ini */ Mention when we switched over to exclusive .ini use

2022-07-13T14:58:46Z

fs2_open.ini: Mention when we switched over to exclusive .ini use

← Older revision		Revision as of 14:58, 13 July 2022
Line 18:		Line 18:

	==fs2_open.ini==		==fs2_open.ini==
	This file contains more "permanent" options and is saved in a standard ini format. The file is separated into multiple "sections" which each contain options specific to that part of the engine:		This file contains more "permanent" options and is saved in a standard ini format. All operating systems were switched to using this file instead of registry entries as of 3.8.0. The file is separated into multiple "sections" which each contain options specific to that part of the engine:

Z64555: /* fs2_open.ini */ Add default to ConnectionSpeed

2022-07-13T12:48:31Z

fs2_open.ini: Add default to ConnectionSpeed

← Older revision		Revision as of 12:48, 13 July 2022
Line 93:		Line 93:

	:; ConnectionSpeed		:; ConnectionSpeed
	:: Used for setting how fast the internet connection is. Possible values are "Slow", "56K", "ISDN", "Cable", and "Fast".		:: Used for setting how fast the internet connection is. Possible values are "Slow", "56K", "ISDN", "Cable", and "Fast". Defaults to "Fast" for non-windows OS's.

	:; SpeechTechroom : Enables or disables text-to-speech in the techroom. Valid values are 1 and 0. Defaults to 0.		:; SpeechTechroom : Enables or disables text-to-speech in the techroom. Valid values are 1 and 0. Defaults to 0.

Z64555: Fix typo: missing open paren

2022-07-13T03:10:54Z

Fix typo: missing open paren

← Older revision		Revision as of 03:10, 13 July 2022
Line 38:		Line 38:

	:; CurrentJoystickGUID		:; CurrentJoystickGUID
	:: Specifies the GUID of the primary joystick. The case of alphabetic characters will be normalized so it doesn't matter if this string is upper or lower case. This GUID can be determined by using SDL2 or with the [[#JSON output\|JSON output]] if supported by the current build).		:: Specifies the GUID of the primary joystick. The case of alphabetic characters will be normalized so it doesn't matter if this string is upper or lower case. This GUID can be determined by using SDL2 or with the [[#JSON output\|JSON output]] (if supported by the current build).
	:::'''Note:''' This is the part of the legacy method of defining the joystick. See Joy0GUID and Joy0ID below.		:::'''Note:''' This is the part of the legacy method of defining the joystick. See Joy0GUID and Joy0ID below.

Z64555: /* fs2_open.ini */ Add newlines to improve seperation between sentances/paragraphs.

2022-07-13T03:06:34Z

fs2_open.ini: Add newlines to improve seperation between sentances/paragraphs.

Show changes

Cyborg17: /* fs2_open.ini */

2022-07-13T02:59:59Z

fs2_open.ini

← Older revision		Revision as of 02:59, 13 July 2022
Line 40:		Line 40:
	:::'''Note:''' This is the part of the legacy method of defining the joystick. See Joy0GUID and Joy0ID below.		:::'''Note:''' This is the part of the legacy method of defining the joystick. See Joy0GUID and Joy0ID below.
	:; Joy0ID		:; Joy0ID
	:: As of FSO 22.0, used for defining your first of multiple joysticks. Get this ID from the ID listed in the exported flags.txt. For details on how to export visit the ~~FAQ~~ [https://wiki.hard-light.net/index.php/Frequently_Asked_Questions_(FAQ) FAQ].		:: As of FSO 22.0, used for defining your first of multiple joysticks. Get this ID from the ID listed in the exported flags.txt. For details on how to export visit the [https://wiki.hard-light.net/index.php/Frequently_Asked_Questions_(FAQ) FAQ].
	:; Joy0GUID		:; Joy0GUID
	:: As of FSO 22.0, used for defining your first of multiple joysticks. Get this GUID from the GUID listed in the exported flags.txt, matching the entry used for Joy0ID. For details on how to export visit the wiki's [https://wiki.hard-light.net/index.php/Frequently_Asked_Questions_(FAQ) FAQ].		:: As of FSO 22.0, used for defining your first of multiple joysticks. Get this GUID from the GUID listed in the exported flags.txt, matching the entry used for Joy0ID. For details on how to export visit the wiki's [https://wiki.hard-light.net/index.php/Frequently_Asked_Questions_(FAQ) FAQ].
Line 112:		Line 112:
	:; Password : The password the player uses for logging into the PXO service (not the account's password)		:; Password : The password the player uses for logging into the PXO service (not the account's password)
	:; SquadName : The Squad Name the player uses.		:; SquadName : The Squad Name the player uses.



	=Getting a list of supported flags and devices=		=Getting a list of supported flags and devices=

Cyborg17: Add ImageExportNum and adjust formatting and a few other clarity edits.

2022-07-12T23:58:41Z

Add ImageExportNum and adjust formatting and a few other clarity edits.

Cyborg17: /* fs2_open.ini */

2022-07-12T22:03:46Z

fs2_open.ini

← Older revision		Revision as of 22:03, 12 July 2022
Line 31:		Line 31:
	:; CurrentJoystickGUID		:; CurrentJoystickGUID
	:: Specifies the GUID of the primary joystick. The case of alphabetic characters will be normalized so it doesn't matter if this string is upper or lower case. This GUID can be determined by using SDL2 or with the [[#JSON output\|JSON output]] if supported by the current build).		:: Specifies the GUID of the primary joystick. The case of alphabetic characters will be normalized so it doesn't matter if this string is upper or lower case. This GUID can be determined by using SDL2 or with the [[#JSON output\|JSON output]] if supported by the current build).
			'''Note:''' This is the part of the legacy method of defining the joystick. See Joy0GUID and Joy0ID below.
	:; CurrentJoystick		:; CurrentJoystick
	:: Specified the index of the primary joystick. This will only be used if there are multiple joysticks with the same GUID. This is the index used to open the joystick in SDL2 or the index into the joysticks array in the [[#JSON output\|JSON output]]. '''Note:''' This is the part of the legacy method of defining the joystick. See ~~Joy<Index>GUID~~ and ~~Joy<Index>ID~~ below.		:: Specified the index of the primary joystick. This will only be used if there are multiple joysticks with the same GUID. This is the index used to open the joystick in SDL2 or the index into the joysticks array in the [[#JSON output\|JSON output]].
			'''Note:''' This is the part of the legacy method of defining the joystick. See Joy0GUID and Joy0ID below.
	:; Joy0ID		:; Joy0ID
	:: For defining your first of multiple joysticks. Get this ID from the id listed in the exported flags.txt. For details on how to export visit the FAQ [https://wiki.hard-light.net/index.php/Frequently_Asked_Questions_(FAQ) FAQ].		:: For defining your first of multiple joysticks. Get this ID from the id listed in the exported flags.txt. For details on how to export visit the FAQ [https://wiki.hard-light.net/index.php/Frequently_Asked_Questions_(FAQ) FAQ].

Cyborg17: /* fs2_open.ini */ Add new joystick options

2022-07-12T22:02:10Z

fs2_open.ini: Add new joystick options

@@ Line 32: / Line 32: @@
 :: Specifies the GUID of the primary joystick. The case of alphabetic characters will be normalized so it doesn't matter if this string is upper or lower case. This GUID can be determined by using SDL2 or with the [[#JSON output|JSON output]] if supported by the current build).
 :; CurrentJoystick
-:: Specified the index of the primary joystick. This will only be used if there are multiple joysticks with the same GUID. This is the index used to open the joystick in SDL2 or the index into the joysticks array in the [[#JSON output|JSON output]].
+:: Specified the index of the primary joystick. This will only be used if there are multiple joysticks with the same GUID. This is the index used to open the joystick in SDL2 or the index into the joysticks array in the [[#JSON output|JSON output]].  '''Note:''' This is the part of the legacy method of defining the joystick.  See Joy<Index>GUID and Joy<Index>ID below.
 :; LastPlayer
 :: The name of the last pilot used. Used by the engine to determine which pilot should be at the top of the list and pre-loaded.

Kiloku at 15:12, 3 July 2022

2022-07-03T15:12:39Z

← Older revision		Revision as of 15:12, 3 July 2022
Line 33:		Line 33:
	:; CurrentJoystick		:; CurrentJoystick
	:: Specified the index of the primary joystick. This will only be used if there are multiple joysticks with the same GUID. This is the index used to open the joystick in SDL2 or the index into the joysticks array in the [[#JSON output\|JSON output]].		:: Specified the index of the primary joystick. This will only be used if there are multiple joysticks with the same GUID. This is the index used to open the joystick in SDL2 or the index into the joysticks array in the [[#JSON output\|JSON output]].
			:; LastPlayer
			:: The name of the last pilot used. Used by the engine to determine which pilot should be at the top of the list and pre-loaded.
			:; GammaD3D
			:: The gamma (brightness) value to be used to display the game.
	:; EnableJoystickFF		:; EnableJoystickFF
	:: Used to determine if force feedback should be enabled if the joystick supports it. If using the [[#JSON output\|JSON output]] then it's possible to determine if a joystick supports this by looking at the '''is_haptic''' field of the joystick object.		:: Used to determine if force feedback should be enabled if the joystick supports it. If using the [[#JSON output\|JSON output]] then it's possible to determine if a joystick supports this by looking at the '''is_haptic''' field of the joystick object.
Line 39:		Line 43:
	:; Language		:; Language
	:: Sets the language of the game. Possible values are "English", "German", "French", and "Polish".		:: Sets the language of the game. Possible values are "English", "German", "French", and "Polish".
			:; ForceFullscreen : If set to 1, forces the game to start in full screen mode.
			:; ScreenshotNum : The number of screenshots taken by the player.
			:; MaxFPS : Used to set the framerate cap for the game. If set to zero, framerate cap is disabled.
	:; ForcePort : Used to force a specific port for multiplayer connections		:; ForcePort : Used to force a specific port for multiplayer connections
	:; ConnectionSpeed		:; ConnectionSpeed
Line 48:		Line 55:
	:; SpeechVolume : The volume scale of the text-to-speech sound. Should be in the range of 0 to 100.		:; SpeechVolume : The volume scale of the text-to-speech sound. Should be in the range of 0 to 100.
	:; SpeechVoice : Sets which voice to use. See [[#JSON output\|JSON output]] for a cross-platform way of determining which voices are available.		:; SpeechVoice : Sets which voice to use. See [[#JSON output\|JSON output]] for a cross-platform way of determining which voices are available.
			:; PXOBanners : Whether or not to use Banners for multiplayer. Valid values are 1 and 0. Defaults to 1.
			:; LowMem : Use Low Memory mode (Allows 2d animations to drop frames)
			:; ProcessorAffinity : Set which processor should be assigned to the game. Defaults to 2. This setting applies only on Windows.

	; Video : Contains options specific to the video display of FSO.		; Video : Contains options specific to the video display of FSO.
Line 62:		Line 72:
	:; PlaybackDevice : Sets the playback device OpenAL should use. The [[#JSON output\|JSON output]] contains a list of available playback devices.		:; PlaybackDevice : Sets the playback device OpenAL should use. The [[#JSON output\|JSON output]] contains a list of available playback devices.
	:; CaptureDevice : Sets the capture device OpenAL should use. The [[#JSON output\|JSON output]] contains a list of available capture devices.		:; CaptureDevice : Sets the capture device OpenAL should use. The [[#JSON output\|JSON output]] contains a list of available capture devices.

			; PXO : Contains settings related to the PXO multiplayer service
			:; Login : The login number for the player's account
			:; Password : The password the player uses for logging into the PXO service (not the account's password)
			:; SquadName : The Squad Name the player uses.

	=Getting a list of supported flags and devices=		=Getting a list of supported flags and devices=

M!m: Fix -get_flags link

2017-11-23T11:10:28Z

Fix -get_flags link

← Older revision		Revision as of 11:10, 23 November 2017
Line 15:		Line 15:
	</pre>		</pre>

	The available flags should not be hardcoded by the launcher. Instead, it should use [[~~Launcher engine interaction~~#Getting ~~engine~~ flags\|-get_flags]] for determining which flags are supported by the launcher.		The available flags should not be hardcoded by the launcher. Instead, it should use [[#Getting a list of supported flags and devices\|-get_flags]] for determining which flags are supported by the launcher.

	==fs2_open.ini==		==fs2_open.ini==

← Older revision		Revision as of 23:58, 12 July 2022
Line 19:		Line 19:
	==fs2_open.ini==		==fs2_open.ini==
	This file contains more "permanent" options and is saved in a standard ini format. The file is separated into multiple "sections" which each contain options specific to that part of the engine:		This file contains more "permanent" options and is saved in a standard ini format. The file is separated into multiple "sections" which each contain options specific to that part of the engine:


	; Default : This is the default section used by FSO if no specific section is selected.		; Default : This is the default section used by FSO if no specific section is selected.


	:; VideocardFs2open		:; VideocardFs2open
	:: This value determines what display mode FSO will use. It has the following format: <tt>[API]-([width]x[height])x[bits] bit</tt>. <tt>[API]</tt> must be exactly 4 characters long. The only valid option here is "OGL " for using the OpenGL API. The other options are pretty obvious. The width and height should match one of the video modes supported by the display (see [[#JSON output\|JSON output]] for a way of getting this information without linking against SDL2). The <tt>bits</tt> parameter should either be 16 or 32 but in almost all cases this should be hard-coded to 32.		:: This value determines what display mode FSO will use. It has the following format: <tt>[API]-([width]x[height])x[bits] bit</tt>. <tt>[API]</tt> must be exactly 4 characters long. The only valid option here is "OGL " for using the OpenGL API. The other options are pretty obvious. The width and height should match one of the video modes supported by the display (see [[#JSON output\|JSON output]] for a way of getting this information without linking against SDL2). The <tt>bits</tt> parameter should either be 16 or 32 but in almost all cases this should be hard-coded to 32.
	:; OGL_AntiAliasSamples		:; OGL_AntiAliasSamples
	:: This should be the level of anti-aliasing desired for OpenGL rendering. This should be the multiple of 2 for how many samples should be taken (e.g. a value of 3 means 8x MSAA). If set to 0 anti-aliasing will be disabled. '''Note:''' As of FSO 3.8.0 this option has no effect!		:: This should be the level of anti-aliasing desired for OpenGL rendering. This should be the multiple of 2 for how many samples should be taken (e.g. a value of 3 means 8x MSAA). If set to 0 anti-aliasing will be disabled.
			:::'''Note:''' As of FSO 3.8.0 this option has no effect!
	:; TextureFilter		:; TextureFilter
	:: Sets how textures should be filtered. Valid values are 0 for bilinear filtering and 1 for trilinear filtering.		:: Sets how textures should be filtered. Valid values are 0 for bilinear filtering and 1 for trilinear filtering.
Line 31:		Line 35:
	:; CurrentJoystickGUID		:; CurrentJoystickGUID
	:: Specifies the GUID of the primary joystick. The case of alphabetic characters will be normalized so it doesn't matter if this string is upper or lower case. This GUID can be determined by using SDL2 or with the [[#JSON output\|JSON output]] if supported by the current build).		:: Specifies the GUID of the primary joystick. The case of alphabetic characters will be normalized so it doesn't matter if this string is upper or lower case. This GUID can be determined by using SDL2 or with the [[#JSON output\|JSON output]] if supported by the current build).
	'''Note:''' This is the part of the legacy method of defining the joystick. See Joy0GUID and Joy0ID below.		:::'''Note:''' This is the part of the legacy method of defining the joystick. See Joy0GUID and Joy0ID below.
	:; CurrentJoystick		:; CurrentJoystick
	:: Specified the index of the primary joystick. This will only be used if there are multiple joysticks with the same GUID. This is the index used to open the joystick in SDL2 or the index into the joysticks array in the [[#JSON output\|JSON output]].		:: Specified the index of the primary joystick. This will only be used if there are multiple joysticks with the same GUID. This is the index used to open the joystick in SDL2 or the index into the joysticks array in the [[#JSON output\|JSON output]].
	'''Note:''' This is the part of the legacy method of defining the joystick. See Joy0GUID and Joy0ID below.		:::'''Note:''' This is the part of the legacy method of defining the joystick. See Joy0GUID and Joy0ID below.
	:; Joy0ID		:; Joy0ID
	:: ~~For~~ defining your first of multiple joysticks. Get this ID from the id listed in the exported flags.txt. For details on how to export visit the FAQ [https://wiki.hard-light.net/index.php/Frequently_Asked_Questions_(FAQ) FAQ].		:: As of FSO 22.0, used for defining your first of multiple joysticks. Get this ID from the ID listed in the exported flags.txt. For details on how to export visit the FAQ [https://wiki.hard-light.net/index.php/Frequently_Asked_Questions_(FAQ) FAQ].
	:; Joy0GUID		:; Joy0GUID
	:: ~~For~~ defining your first of multiple joysticks. Get this GUID from the GUID listed in the exported flags.txt, matching the entry used for Joy0ID. For details on how to export visit the wiki's [https://wiki.hard-light.net/index.php/Frequently_Asked_Questions_(FAQ) FAQ].		:: As of FSO 22.0, used for defining your first of multiple joysticks. Get this GUID from the GUID listed in the exported flags.txt, matching the entry used for Joy0ID. For details on how to export visit the wiki's [https://wiki.hard-light.net/index.php/Frequently_Asked_Questions_(FAQ) FAQ].
	:; Joy1ID		:; Joy1ID
	:: Same as above, for defining your second joystick.		:: Same as above, for defining your second joystick.
Line 76:		Line 80:
	:; LowMem : Use Low Memory mode (Allows 2d animations to drop frames)		:; LowMem : Use Low Memory mode (Allows 2d animations to drop frames)
	:; ProcessorAffinity : Set which processor should be assigned to the game. Defaults to 2. This setting applies only on Windows.		:; ProcessorAffinity : Set which processor should be assigned to the game. Defaults to 2. This setting applies only on Windows.
			:; ImageExportNum : The index of the next file to be dds exported from FSO.


	; Video : Contains options specific to the video display of FSO.		; Video : Contains options specific to the video display of FSO.


	:; Display		:; Display
	:: Used to choose on which display FSO should be displayed on. The [[#JSON output\|JSON output]] contains a list of display detected on the system and their index. Alternatively, SDL2 can be used to enumerate this information.		:: Used to choose on which display FSO should be displayed on. The [[#JSON output\|JSON output]] contains a list of display detected on the system and their index. Alternatively, SDL2 can be used to enumerate this information.


	; ForceFeedback : Contains options for configuring the force feedback subsystem of FSO.		; ForceFeedback : Contains options for configuring the force feedback subsystem of FSO.


	:; Strength : A percentage scale of how strong the effect should be. 0 means completely disabled, 100 means full strength.		:; Strength : A percentage scale of how strong the effect should be. 0 means completely disabled, 100 means full strength.


	; Sound : Contains options specific to how sound should be handled in FSO.		; Sound : Contains options specific to how sound should be handled in FSO.


	:; Quality : Specifies the quality of the sound output. The value should be in [1, 3] where 3 is the highest quality and 1 is the lowest.		:; Quality : Specifies the quality of the sound output. The value should be in [1, 3] where 3 is the highest quality and 1 is the lowest.
	:; SampleRate : Explicitly specifies the sample rate the OpenAL context should use.		:; SampleRate : Explicitly specifies the sample rate the OpenAL context should use.
Line 90:		Line 104:
	:; PlaybackDevice : Sets the playback device OpenAL should use. The [[#JSON output\|JSON output]] contains a list of available playback devices.		:; PlaybackDevice : Sets the playback device OpenAL should use. The [[#JSON output\|JSON output]] contains a list of available playback devices.
	:; CaptureDevice : Sets the capture device OpenAL should use. The [[#JSON output\|JSON output]] contains a list of available capture devices.		:; CaptureDevice : Sets the capture device OpenAL should use. The [[#JSON output\|JSON output]] contains a list of available capture devices.


	; PXO : Contains settings related to the PXO multiplayer service		; PXO : Contains settings related to the PXO multiplayer service


	:; Login : The login number for the player's account		:; Login : The login number for the player's account
	:; Password : The password the player uses for logging into the PXO service (not the account's password)		:; Password : The password the player uses for logging into the PXO service (not the account's password)
	:; SquadName : The Squad Name the player uses.		:; SquadName : The Squad Name the player uses.



	=Getting a list of supported flags and devices=		=Getting a list of supported flags and devices=