Scpui - Revision history

MjnMixael: Replaced content with "500px {{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki}} Category:SCPUI"

2026-10-28T18:28:18Z

Replaced content with "center|500px {{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki}} Category:SCPUI"

MjnMixael: /* Custom Data */

2026-03-17T14:39:12Z

Custom Data

← Older revision		Revision as of 14:39, 17 March 2026
Line 99:		Line 99:

	===Custom Data===		===Custom Data===
	SCPUI often uses special [[Ships.tbl#$Custom data:\|Custom Data]] for various special cases. This provides a way to set values per-object without needing additional tables.		SCPUI often uses special [[Ships.tbl#$Custom data:\|Custom Data]] for various special cases. This provides a way to set values per-object without needing additional tables. All keys are optional.
	{\| class="wikitable"		{\| class="wikitable"
	! Key		! Key
Line 107:		Line 107:
	\|-		\|-
	\| <code>HideInTechRoom</code>		\| <code>HideInTechRoom</code>
	\| Boolean (default: ~~true~~)		\| Boolean (default: false)
	\| ships.tbl, weapons.tbl		\| ships.tbl, weapons.tbl
	\| If true, the object is always hidden from the tech room, including when using Ctrl+S.		\| If true, the object is always hidden from the tech room, including when using Ctrl+S.

MjnMixael: document custom data parsers

2026-03-17T14:36:01Z

document custom data parsers

@@ Line 97: / Line 97: @@
 select-neg-o.png ;;Negative On
 </pre>
 ==Briefing Color Tags==

MjnMixael: /* Fonts */

2026-03-08T18:44:58Z

Fonts

← Older revision		Revision as of 18:44, 8 March 2026
Line 39:		Line 39:
	}		}
	</pre>		</pre>

			Note that the font-family is the font's name as defined in the font metadata and not the filename. In some fonts that may strictly be the font family name only, but not always. For example, <code>Noto Sans Medium</code> actually needs to be listed as <code>Noto Sans</code>.

			You will want to put all family variant font files (for example: BankGothic.ttf, BankGothic-bold.ttf, BankGotic-italic.ttf) in the <code>data/fonts</code> directory.

	SCPUI will try to match it's default font size to FSO's internal font size, which be default is the first font in fonts.tbl. You can customize this setting in [[scpui.tbl\|scpui.tbl.]]. You will also want to enable <code>+Auto Scale</code> and <code>+Can Scale</code> on your default FSO font in [[fonts.tbl\|fonts.tbl]] so that SCPUI's font and FSO's font can scale together as players will expect.		SCPUI will try to match it's default font size to FSO's internal font size, which be default is the first font in fonts.tbl. You can customize this setting in [[scpui.tbl\|scpui.tbl.]]. You will also want to enable <code>+Auto Scale</code> and <code>+Can Scale</code> on your default FSO font in [[fonts.tbl\|fonts.tbl]] so that SCPUI's font and FSO's font can scale together as players will expect.

	Note that the font-family is the font's name as defined in the font and not the filename. In some fonts that may strictly be the font family name only, but not always. For example, <code>Noto Sans Medium</code> actually needs to be listed as <code>Noto Sans</code>.

	===Background===		===Background===

MjnMixael: /* Fonts */

2025-07-24T15:25:22Z

Fonts

← Older revision		Revision as of 15:25, 24 July 2025
Line 39:		Line 39:
	}		}
	</pre>		</pre>

			SCPUI will try to match it's default font size to FSO's internal font size, which be default is the first font in fonts.tbl. You can customize this setting in [[scpui.tbl\|scpui.tbl.]]. You will also want to enable <code>+Auto Scale</code> and <code>+Can Scale</code> on your default FSO font in [[fonts.tbl\|fonts.tbl]] so that SCPUI's font and FSO's font can scale together as players will expect.

	Note that the font-family is the font's name as defined in the font and not the filename. In some fonts that may strictly be the font family name only, but not always. For example, <code>Noto Sans Medium</code> actually needs to be listed as <code>Noto Sans</code>.		Note that the font-family is the font's name as defined in the font and not the filename. In some fonts that may strictly be the font family name only, but not always. For example, <code>Noto Sans Medium</code> actually needs to be listed as <code>Noto Sans</code>.

MjnMixael: /* Briefing Color Tags */

2025-06-17T14:21:51Z

Briefing Color Tags

← Older revision		Revision as of 14:21, 17 June 2025
Line 97:		Line 97:
	SCPUI supports two methods for coloring text in briefings. It supports the retail style [[Briefing Text\|color tag]] system out of the box. However, SCPUI also has its own HTML-based approach to styling text. It works everywhere that classic color tags do - briefings (including command, loop, and red alert briefings), debriefings, and the fiction viewer - but also the tech room, campaign descriptions, and nearly everywhere that long-form text is supported. For it to work in briefings, the text must be put in "HTML mode" by putting <code>!html</code> at the start, followed by a space. Everywhere else will work without that tag.		SCPUI supports two methods for coloring text in briefings. It supports the retail style [[Briefing Text\|color tag]] system out of the box. However, SCPUI also has its own HTML-based approach to styling text. It works everywhere that classic color tags do - briefings (including command, loop, and red alert briefings), debriefings, and the fiction viewer - but also the tech room, campaign descriptions, and nearly everywhere that long-form text is supported. For it to work in briefings, the text must be put in "HTML mode" by putting <code>!html</code> at the start, followed by a space. Everywhere else will work without that tag.

	Text in HTML mode may contain HTML markup. Text may be styled using <code><span></code> tags with appropriate classes drawn from common.rcss; inline styles are also supported. FSO and HTML both make use of double quotes and slashes; to minimize conflicts, using single quotes and writing slashes as <code>$slash</code> is recommended. A complete example might look something like this: <code>!html <span class='white'>Pilot attend!<$slashspan> Today, we'll be escorting the <span class='green italic'>GTC Examplar<$slashspan> as she raids <span class='red'>Shivan<$slashspan> positions throughout <span class='yellow'>Gamma Draconis<$slashspan>.</code>		Text in HTML mode may contain HTML markup. Text may be styled using <code><span></code> tags with appropriate classes drawn from common.rcss; inline styles are also supported. FSO and HTML both make use of double quotes and slashes; to minimize conflicts, using single quotes and writing slashes as <code>$slash</code> is recommended. A complete example might look something like this: <code>!html <span class='white'>Pilot attend!<$slashspan> Today, we'll be escorting the <span class='green italic'>GTC Examplar<$slashspan> as she raids <span class='red'>Shivan<$slashspan> positions throughout <span class='yellow'>Gamma Draconis<$slashspan>.</code> The list of color classes available by default is at the bottom of <code>common.rcss</code>. You can add more to <code>custom.rcss</code> if needed.

	It is, however, rarely necessary to perform simple styling like this manually: SCPUI's [[Keywords.tbl]] may be used to automate common styling rules.		It is, however, rarely necessary to perform simple styling like this manually: SCPUI's [[Keywords.tbl]] may be used to automate common styling rules.

MjnMixael: /* Loading Screen Backgrounds */

2025-06-13T22:19:58Z

Loading Screen Backgrounds

← Older revision		Revision as of 22:19, 13 June 2025
Line 56:		Line 56:

	===Loading Screen Backgrounds===		===Loading Screen Backgrounds===
	Loading screen backgrounds are handled a little differently than in base FreespaceOpen. You must create or modify the <code>~~loadscreenbgs~~.rcss</code> file to add the custom backgrounds you wish to use. In that file create a css class with the mission filename that is to have a custom screen and then define the file like the example below.		Loading screen backgrounds are handled a little differently than in base FreespaceOpen. You must create or modify the <code>load_screen_bgs.rcss</code> file to add the custom backgrounds you wish to use. In that file create a css class with the mission filename that is to have a custom screen and then define the file like the example below.

	<pre>		<pre>

MjnMixael: /* Pilot Select */

2025-04-25T13:57:03Z

Pilot Select

← Older revision		Revision as of 13:57, 25 April 2025
Line 325:		Line 325:
	====Pilot Select====		====Pilot Select====
	The pilot select UI has special handling of custom mod options because player preferences cannot be loaded until a player is selected. For this specific use case, SCPUI creates a <code>scpui_options_global.cfg</code> whenever user preferences are saved. This file contains no mod or player specific information in the save structure. It is just a list of key/value pairs for the most recently used pilot.		The pilot select UI has special handling of custom mod options because player preferences cannot be loaded until a player is selected. For this specific use case, SCPUI creates a <code>scpui_options_global.cfg</code> whenever user preferences are saved. This file contains no mod or player specific information in the save structure. It is just a list of key/value pairs for the most recently used pilot.
	*This setup ~~was created specifically to handle the font size option during player selection, but it~~ can be used to perform script actions before a player is selected if necessary.		*This setup can be used to perform script actions before a player is selected if necessary.
	*In this case, options are still available as '''''ScpuiOptionValues'''''' and accessed the same way, but there is no guarantee that the option will exist depending on the last mod the player played.		*In this case, options are still available as '''''ScpuiOptionValues'''''' and accessed the same way, but there is no guarantee that the option will exist depending on the last mod the player played.

MjnMixael: /* Pilot Select */

2025-04-25T13:56:23Z

Pilot Select

← Older revision		Revision as of 13:56, 25 April 2025
Line 324:		Line 324:

	====Pilot Select====		====Pilot Select====
	The pilot select UI has special handling of custom mod options~~, including [[scpui#Font_Size_Multiplier\|Font Size Multiplier]]~~ because player preferences cannot be loaded until a player is selected. For this specific use case, SCPUI creates a <code>scpui_options_global.cfg</code> whenever user preferences are saved. This file contains no mod or player specific information in the save structure. It is just a list of key/value pairs for the most recently used pilot.		The pilot select UI has special handling of custom mod options because player preferences cannot be loaded until a player is selected. For this specific use case, SCPUI creates a <code>scpui_options_global.cfg</code> whenever user preferences are saved. This file contains no mod or player specific information in the save structure. It is just a list of key/value pairs for the most recently used pilot.
	*This setup was created specifically to handle the font size option during player selection, but it can be used to perform script actions before a player is selected if necessary.		*This setup was created specifically to handle the font size option during player selection, but it can be used to perform script actions before a player is selected if necessary.
	*In this case, options are still available as '''''ScpuiOptionValues'''''' and accessed the same way, but there is no guarantee that the option will exist depending on the last mod the player played.		*In this case, options are still available as '''''ScpuiOptionValues'''''' and accessed the same way, but there is no guarantee that the option will exist depending on the last mod the player played.

MjnMixael: /* Accessing Save Data */

2025-04-25T13:55:15Z

Accessing Save Data

← Older revision		Revision as of 13:55, 25 April 2025
Line 293:		Line 293:

	====Accessing Save Data====		====Accessing Save Data====
	Modifying Options within the in-game UI and saving those values to a file is just a start. In order for these options to do anything, you'll need to hook them into your scripts. After the Pilot Select screen and a player is chosen, the current Options are available in a global variable called <code>ScpuiOptionValues</code> with direct access to a specific option by specifying the [[options.tbl#+Key:\|option key]].		Modifying Options within the in-game UI and saving those values to a file is just a start. In order for these options to do anything, you'll need to hook them into your scripts. After the Pilot Select screen and a player is chosen, the current Options are available in a global variable called <code>ScpuiOptionValues</code> with direct access to a specific option by specifying the [[options.tbl#+Key:\|option key]]. In order to apply these options create a UI Topic connected to <code>options.apply</code> and run the appropriate code there.
	*It may be recommended to create a ~~script-tbl~~.~~tbm that runs [[Scripting.tbl#On_State_End:\|$On State End]]~~ and ~~checks if hv.OldState is either "GS_STATE_INITIAL_PLAYER_SELECT" or "GS_STATE_OPTIONS_MENU". If true, then forward~~ the ~~option preferences to your script's local values~~.
	<pre>		<pre>
	#Conditional Hooks		#Conditional Hooks
Line 300:		Line 299:
	$On State End:		$On State End:
	[		[
	~~if hv.OldState.Name~~ == "~~GS_STATE_INITIAL_PLAYER_SELECT~~" ~~or hv~~.~~OldState~~.~~Name == "GS_STATE_OPTIONS_MENU" then~~		(function()
	if ScpuiOptionValues.HUD_Icons == "On" then
	ba.print("MOD OPTION: Player ~~enabled~~ HUD Icons")		local topics = require('lib_ui_topics')
	RadarIcon.PlayerEnabled = true		local md = require("debugFunctions")
	else
	ba.print("MOD OPTION: Player ~~disabled~~ HUD Icons")		--Apply user settings to relevant script data
	RadarIcon.PlayerEnabled = false		topics.options.apply:bind(9999, function(message, context)
	end
	end		--Handle HUD Icon Option
			if ScpuiSystem.data.ScpuiOptionValues.HUD_Icons == "On" then
			md.print("MOD OPTION: Player disabled HUD Icons")
			RadarIcon.PlayerEnabled = true
			else
			md.print("MOD OPTION: Player enabled HUD Icons")
			RadarIcon.PlayerEnabled = false
			end

			end)

			end)()
	]		]
	#End		#End