Scpui.tbl - Revision history

MjnMixael: Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/scpui.tbl}} Category:SCPUI Category:Tables"

2026-10-28T18:28:37Z

Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/scpui.tbl}} Category:SCPUI Category:Tables"

2026-03-26T14:42:50Z

#Settings

← Older revision		Revision as of 14:42, 26 March 2026
Line 121:		Line 121:
	*Determines if the splash text should be drawn at all during preload.		*Determines if the splash text should be drawn at all during preload.
	*This value is optional. If not provided, a default value of true is used.		*This value is optional. If not provided, a default value of true is used.
			*Syntax: '''''boolean'''''

			===$Always Allow Show All:===
			*Allows the Ctrl-Shift-S "show all" feature used in the tech room and other UIs to be used in release builds
			*This value is optional. If not provided, a default value of false is used.
	*Syntax: '''''boolean'''''		*Syntax: '''''boolean'''''

2026-02-15T22:10:35Z

#Settings

← Older revision		Revision as of 22:10, 15 February 2026
Line 51:		Line 51:
	*This value is optional. If not provided, a default height of 48 will be used.		*This value is optional. If not provided, a default height of 48 will be used.
	*Syntax: '''''integer'''''		*Syntax: '''''integer'''''

			===$Use Legacy Slider For Volume:===
			*Forces SCPUI to use the retail style 10-dot slider for volume controls instead of the more modern range slider controls.
			*This value is optional. If not provided, a default false will be used.
			*Syntax: '''''boolean'''''

	===$Database Unread Show String Badge:===		===$Database Unread Show String Badge:===

2026-01-09T14:48:10Z

$Mod ID:

← Older revision		Revision as of 14:48, 9 January 2026
Line 14:		Line 14:
	===$Mod ID:===		===$Mod ID:===
	*The mod ID to use. By default this will match your mod's path root folder. For example, [[bta\|Between the Ashes]] has a -mod line like <code>-mod BTA-2.0.0\content</code> and so the default Mod ID will resolve to <code>BTA</code>. If your game runs without a -mod command line then it would be a good idea to set an ID here to prevent it from being "unknown_mod_id".		*The mod ID to use. By default this will match your mod's path root folder. For example, [[bta\|Between the Ashes]] has a -mod line like <code>-mod BTA-2.0.0\content</code> and so the default Mod ID will resolve to <code>BTA</code>. If your game runs without a -mod command line then it would be a good idea to set an ID here to prevent it from being "unknown_mod_id".
	*Syntax: '''''~~boolean~~'''''		*Syntax: '''''string'''''

	===$Default FSO Font Name:===		===$Default FSO Font Name:===

2025-09-19T20:57:49Z

#Background Replacement

← Older revision		Revision as of 20:57, 19 September 2025
Line 136:		Line 136:

	==#Background Replacement==		==#Background Replacement==
	*Defines what css class to use to set the background for UIs on a per-campaign basis.		*Defines what css class to use to set the background for UIs on a per-campaign or per-mainhall basis.
			*Mainhall defines take priority over Campaign defines.
	*By default all UIs use the css class<code>general_bg</code>.		*By default all UIs use the css class<code>general_bg</code>.

Line 145:		Line 146:
	====+Campaign Filename:====		====+Campaign Filename:====
	*The campaign filename without extension		*The campaign filename without extension
			*Syntax: '''''string'''''

			====+RCSS Class Name:====
			*The css class name to use as a replacement. Make sure this class exists in a loaded rcss file!
			*Syntax: '''''string'''''

			===$Mainhall Background:===
			*Designates that a new define will follow
			*Has no arguments

			====+Mainhall Name:====
			*The mainhall name
	*Syntax: '''''string'''''		*Syntax: '''''string'''''

2025-09-19T20:43:03Z

#Settings

@@ Line 52: / Line 52: @@
 *Syntax: '''''integer'''''
-===$Show New In Database:===
+===$Database Unread Show String Badge:===
-*If false, then the tech database will not show the "NEW!" text to designate entries the player has not read yet.
+*If true, then unread database entries will display a text badge (such as "NEW!").
-*This value is optional. If not provided, the default is true.
+*This value is optional. If not provided, the default is false.
 *Syntax: '''''boolean'''''
 ===$Minimum Splash Time:===

2025-07-24T15:35:51Z

#Settings

← Older revision		Revision as of 15:35, 24 July 2025
Line 11:		Line 11:
	==#Settings==		==#Settings==
	*This section defines a few global SCPUI settings		*This section defines a few global SCPUI settings

			===$Mod ID:===
			*The mod ID to use. By default this will match your mod's path root folder. For example, [[bta\|Between the Ashes]] has a -mod line like <code>-mod BTA-2.0.0\content</code> and so the default Mod ID will resolve to <code>BTA</code>. If your game runs without a -mod command line then it would be a good idea to set an ID here to prevent it from being "unknown_mod_id".
			*Syntax: '''''boolean'''''

			===$Default FSO Font Name:===
			*The Font name or index from fonts.tbl that SCPUI should use to get a base pixel value from. By default it will use the font at index 1.
			*Syntax: '''''string'''''

	===$Hide Multiplayer:===		===$Hide Multiplayer:===

2025-01-28T14:21:59Z

#Settings

@@ Line 43: / Line 43: @@
 *This value is optional. If not provided, a default height of 48 will be used.
 *Syntax: '''''integer'''''
 ==#State Replacement==

2024-09-18T22:05:56Z

← Older revision		Revision as of 22:05, 18 September 2024
Line 1:		Line 1:
	{{~~SCP_table~~}}		{{SCPUI_table}}
	{{Tables}}		{{Tables}}
	Scpui.tbl is used by the [[SCPUI]] script system to define what [[List_of_Game_States\|engine game states]] are linked to [[librocket]] RML files. This effectively allows SCPUI to override a built-in game UI with one of its own. This table also allows setting various background definitions for UIs on a granular basis.		Scpui.tbl is used by the [[SCPUI]] script system to define what [[List_of_Game_States\|engine game states]] are linked to [[librocket]] RML files. This effectively allows SCPUI to override a built-in game UI with one of its own. This table also allows setting various background definitions for UIs on a granular basis.

2024-09-07T16:03:40Z

#Medal Placements

← Older revision		Revision as of 16:03, 7 September 2024
Line 107:		Line 107:
	==#Medal Placements==		==#Medal Placements==
	*This section defines how medals are placed in SCPUI's ui because SCPUI cannot use the definitions in the retail [[medals.tbl\|medals.tbl.]]		*This section defines how medals are placed in SCPUI's ui because SCPUI cannot use the definitions in the retail [[medals.tbl\|medals.tbl.]]
	*SCPUI expects 5 image files for each medal		*SCPUI expects 5 image files for each medal, a blank indent of the medal (no medal), the medal with no badge, the medal with bronze badge, the medal with silver badge, the medal with gold badge. These should be named MEDALNAME_00, MEDALNAME_01, MEDALNAME_02, MEDALNAME_03, MEDALNAME_04 where MEDALNAME is the [[Medals.tbl#.24Bitmap:\|Bitmap defined in medals.tbl]].

	===$Medal ~~Bitmap~~:===		===$Medal:===
	*The name of the medal as defined in [[Medals.tbl#.24Name:\|medals.tbl]].		*The name of the medal as defined in [[Medals.tbl#.24Name:\|medals.tbl]].
	*Each medal should have 5 images, a blank indent of the medal (no medal), the medal with no badge, the medal with bronze badge, the medal with silver badge, the medal with gold badge. These should be named MEDALNAME_00, MEDALNAME_01, MEDALNAME_02, MEDALNAME_03, MEDALNAME_04 where MEDALNAME is the [[Medals.tbl#.24Bitmap:\|Bitmap defined in medals.tbl]].
	*Syntax: '''''string'''''		*Syntax: '''''string'''''