View source for Credits.txt

{{DISPLAYTITLE:<code>credits.txt</code>}}

<code>credits.txt</code> is the configuration file that defines the text displayed by {{ent|env_credits}}, {{ent|env_portal_credits}}, {{ent|env_outtro_stats}} (when using the <code>RollCredits</code> input), and {{ent|env_introcredits}}. It is located in the <code>scripts/</code> folder in most games, or the game directory root in the {{l4dseries|1}}.

The file is standard KeyValues, with the root key typically named the same as the file. Its sub-keys define various components of the credits:
* <code>[[#Credits parameters|CreditsParams]]</code> configures various settings for the credits display
* <code>[[#Intro/outro credits names|IntroCreditsNames]]</code> lists the names displayed in the intro credits {{not|{{l4dseries}}{{portal2}}{{bms}}}}
* <code>[[#Intro credits (Black Mesa)|IntroCredits]]</code> lists the names displayed in the intro credits across multiple maps {{bms|only}}
* <code>[[#Intro/outro credits names|OutroCreditsNames]]</code> lists the names displayed in the outro credits
* <code>[[#Portal lyrics|OutroSongLyrics]]</code> lists the lines for the Portal musical credits {{portalseries|only}}
* <code>[[#Portal ASCII art|OutroAsciiArt]]</code> defines the ASCII art images that appear throughout Portal's credits {{portal|only}}

== Credits parameters ==
The <code>CreditsParams</code> block contains various pre-defined settings for how the credits should be displayed. Most of these only apply to specific credits types. All of the given default values are as defined in code, and may differ from what is actually used in Valve's games.

{{KV|<code>color</code>|color255|Color used for intro credits and Portal credits. Defaults to fully transparent, so this must be set for these credits to appear.|intn=0|not={{l4dseries}}{{portal2}}}}

=== Outro credits ===
{{KV|<code>scrolltime</code>|float|The total number of seconds it will take to scroll through the outro credits. The speed of the scrolling will automatically be timed to this, making it easy to add new credit lines without having to manually adjust anything. Defaults to 57 seconds.
:In Half-Life 2's style of credits, the last line will remain in the center of the screen for 10 ({{x360}} 2) seconds after this point before fading out and firing <code>OnCreditsDone</code>. In Portal 2, <code>sp_ending_callback.bik</code> will begin playing 4 seconds after, regardless of if the song has finished. {{todo|l4d}}|intn=0}}
{{KV|<code>separation</code>|float|Spacing between outro credit lines, in pixels. Negative numbers can be used to place them closer together (e.g. if the font height is taller than the visible characters). Defaults to 5.|intn=0}}

=== Intro credits ===
{{not|{{l4dseries}}{{portal2}}}}
{{KV|<code>fadeintime</code>|float|The time it takes for each intro credit line to fade in. Defaults to 1 second.|intn=0}}
{{KV|<code>fadeholdtime</code>|float|The time each intro credit line will stay visible before beginning to fade out. Defaults to 3 seconds.|intn=0}}
{{KV|<code>fadeouttime</code>|float|The time it takes for each intro credit line to fade in. Defaults to 1 second.|intn=0}}
{{KV|<code>nextfadetime</code>|float|When switching between groups of three intro credits, this is the amount of time that the new lines will start fading in ''before'' the old ones have fully faded out. Defaults to 2 seconds.|intn=0}}
{{KV|<code>pausebetweenwaves</code>|float|After each group of three intro credits have faded in, this is the time to wait before fading them out to draw the next group. Defaults to 2 seconds.|intn=0}}
{{KV|<code>logotime</code>|float|Extra time to wait after showing the first set of three intro credits (typically just the Valve logo) before showing the rest. Defaults to 2 seconds.|intn=0}}
{{KV|<code>posx</code>|float|X position of the intro credits. Defaults to 2.|intn=0}}
{{KV|<code>posy</code>|float|Y position of the intro credits. Defaults to 2.|intn=0}}

=== Logo ===
{{not|{{l4dseries}}{{portal2}}}}
{{note|<code>env_portal_credits</code> has Episode One's logo text hardcoded in and does not support these. Use the original <code>env_credits</code> instead if you want to show a logo in a Portal mod.}}
{{KV|<code>logo</code>|string|Text to be displayed when <code>ShowLogo</code> is used. This uses <code>ClientTitleFont</code> (same as the title screen logo) in the HL2 Episodes and Portal, or <code>WeaponIcons</code> in HL2. Defaults to <code>HALF-LIFE'</code>, which will be drawn as the HL2 logo with the aforementioned fonts.|intn=0}}
{{KV|<code>logo2</code>|string|Second line of the logo, as used in the episodes. Defaults to blank.|intn=0}}

=== Portal credits ===
{{KV|<code>cursorblinktime</code>|float|Time between cursor blinks in the Portal terminal-style credits. Defaults to 0.3 seconds.|intn=0}}
{{KV|<code>scrollcreditsstart</code>|float|Sets how long after starting the Portal song credits that the actual developer credits will begin being typed out. The duration specified by <code>scrolltime</code> will start after this and is not shortened. Defaults to 6 seconds.|intn=0}}

{{portal|only}}:
{{KV|<code>songstarttime</code>|float|Sets how long after starting the Portal credits that <code>music/portal_still_alive.mp3</code> will be played. Defaults to 6.85 seconds.|intn=0}}
{{KV|<code>screenxoffset</code>|int|Horizontal offset of the terminal screen in pixels. Defaults to 0.|intn=0}}
{{KV|<code>screenyoffset</code>|int|Vertical offset of the terminal screen in pixels. Defaults to 0.|intn=0}}
{{KV|<code>screenwidthadjustment</code>|int|Extra width added to the terminal screen. Negative values can be used to make it smaller. Defaults to 0.|intn=0}}
{{KV|<code>screenheightadjustment</code>|int|Extra height added to the terminal screen. Negative values can be used to make it smaller. Defaults to 0.|intn=0}}
{{KV|<code>asciiartfont</code>|string|Sets the font used for the ASCII art. Defaults to <code>Default</code>.|intn=0}}
{{KV|<code>aascreenxoffset</code>|int|Horizontal offset of the ASCII art in pixels. Defaults to 0, which has the left edge of the ASCII art at the center of the screen.|intn=0}}
{{KV|<code>aascreenyoffset</code>|int|Vertical offset of the ASCII art in pixels. Defaults to 0, which has the top edge of the ASCII art at the center of the screen.|intn=0}}
{{KV|<code>aaseparation</code>|int|Spacing between ASCII art lines, in pixels. Negative numbers can be used to place them closer together (e.g. if the font height is taller than the visible characters). Defaults to 0.|intn=0}}

{{portal2|only}}:
{{KV|<code>color_lyrics</code>|color255|Color of the lyrics text. Defaults to fully transparent, so this must be set for lyrics to appear.|intn=0}}
{{KV|<code>color_credits</code>|color255|Color of the credits text. Defaults to fully transparent, so this must be set for credits to appear.|intn=0}}

== Intro/outro credits names ==
The <code>IntroCreditsNames</code> and <code>OutroCreditsNames</code> blocks define the names displayed in the intro and outro credits respectively. Both have the same format. For intro credits in Black Mesa, see [[#Intro credits (Black Mesa)|the section below]].

Each keyvalue represents a single line in the credits. The key name is the text that you want to appear on that line, while the value is the name of the font to use from <code>clientscheme.res</code>. Usually the font <code>CreditsText</code> is used for intro credits and <code>CreditsOutroText</code> used for outro credits, but you can swap these out or use different fonts on different lines in order to create headers or icons.

The intro credits are shown in groups of three, so you should take this into account when writing intro credits. The first three lines (showing the Valve logo in HL2) will fade in and fade out all at once, then the second group will fade in all at once, then it will begin going through the rest of the groups with a top-to-bottom fade animation.

In Black Mesa, outro credits prefixed with a question mark (<code>?</code>) will be left aligned, and credits prefixed with a exclamation point (<code>!</code>) will be right aligned and drawn on the same line as the previous credit. This allows creating dual-column credits.

{{bug|As a result of caching internally used by the KeyValues system, credit lines with the same text will use the capitalization and font from the first instance instead of what's specified. Capitalization changes will also not take effect until the game is restarted if the credits have previously been viewed during the current session.|tested={{hl2}}}}
{{bug|When using <code>env_portal_credits</code>, having a closing square bracket (<code>]</code>) anywhere in a line will cause it and all preceding text to disappear, despite this otherwise having no effect on credits names.|tested={{portal}}}}

=== Example ===
{{pre|
"IntroCreditsNames"
{
	"V"         "WeaponIcons" // Valve logo
	" "         "CreditsText" // padding out the rest of the group
	" "         "CreditsText"
	"Credit1"   "CreditsText" // first real credit
	"Credit2"   "CreditsText"
	"Credit3"   "CreditsText"
	"Credit4"   "CreditsText" // new group of three
	"Credit5"   "CreditsText"
	"Credit6"   "CreditsText"
}

"OutroCreditsNames"
{
	"HALF-LIFE'" "CreditsOutroLogos" // HL2 logo
	" "          "CreditsOutroText" // spacing is purely aesthetic, there is no grouping for outro credits
	"V"          "CreditsOutroValve" // Valve logo
	" "          "CreditsOutroText"
	"Credit1"    "CreditsOutroText" // first real credit
	"Credit2"    "CreditsOutroText"
	"Credit3"    "CreditsOutroText"
	"Credit4"    "CreditsOutroText"
	" "          "CreditsOutroText"
	"v"          "CreditsOutroText" // last line, lingers for a few seconds. Will appear the same as the above Valve logo due to KV caching
}
}}

== Intro credits (Black Mesa) ==
Due to the tram ride being split across multiple maps, Black Mesa uses a different system for intro credits. The <code>IntroCredits</code> block holds subkeys corresponding to each map. Each of these then holds a <code>totaltime</code> key that sets the total amount of time that these credits should appear over, and a <code>credits</code> key holding the actual list of credits to display. Each credit has the text to display as the key name, and the value is not used.

=== Example ===
{{pre|
"IntroCredits" //Into credits start here.
{
    "map1" //The first map there we want to have credits.
	{
		"totaltime"		"90" //Total time (in seconds) we want to roll credits.
		"credits"
		{
			  "#Map1MyText1"              "#BLANK" //The first is the text that will be displayed, the second does nothing (even if you'll write here some already existing text).
			  "#Map1MyText2"              "#BLANK" //The second text that will be displayed.
			  "#Map1MyTextX"              "#BLANK" //The X text that will be displayed.
		}
	}

    "map2" //The second map there we want to have credits.
	{
		"totaltime"		"100" //Total time (in seconds) we want to roll credits.
		"credits"
		 {
			  "#Map2MyText1"              "#BLANK" //The first text that will be displayed.
			  "#Map2MyText2"              "#BLANK" //The second text that will be displayed.
			  "#Map2MyTextX"              "#BLANK" //The X text that will be displayed.
		 }
    }
}
}}

== Portal lyrics ==
The <code>OutroSongLyrics</code> block holds the lyrics to the Portal games' ending songs along with timing and display information. It is formatted similarly to regular intro/outro credits, with each key being the text to display and the value being the font name, but there are various formatting characters that can be used at the start of a line to control the behavior of the text. If multiple of these are used on a single line, they must be used in the order listed.
* A float inside square brackets (<code>[x]</code>) indicates how long the line will take to appear. The speed of the text will be automatically timed so it lasts this duration.
* An integer inside a set of three less/greater symbols (<code><<<x>>></code>) will switch the active ASCII art to the one matching the specified ID. A value of zero hides the ASCII art. {{portal|only}}
* An ampersand (<code>&</code>) will clear the screen. This should be used on its own line with a very short display time.
* An asterisk (<code>*</code>) will cause the ''next'' line of text to be displayed directly after this one, without a line break. This can be used to make different parts of a single visual line print at different speeds, which can allow matching the spoken lyrics better.
* A caret (<code>^</code>) used on an otherwise blank line will force a newline to be added.
* A hash sign (<code>#</code>) will look up the provided text as a localization token.

=== Example ===
{{pre|
"OutroSongLyrics"
{
	"[2.05]#portal_lyrics_01"         "CreditsOutroText" // brackets used for timing, hashes used for localization
	"[1.9] "                          "CreditsOutroText"
	"[2.1]#portal_lyrics_02"          "CreditsOutroText"
	"[0.1] "                          "CreditsOutroText"
	"[1.8]#portal_lyrics_03"          "CreditsOutroText"
	"[1.00] "                         "CreditsOutroText"
	"[2.36]#portal_lyrics_04"         "CreditsOutroText"
	"[0.04] "                         "CreditsOutroText"
	"[2.71]#portal_lyrics_05"         "CreditsOutroText"
	"[2.13] "                         "CreditsOutroText"
	"[1.76]<<<1>>>#portal_lyrics_06"  "CreditsOutroText" // switch ascii art
	"[2.10] "                         "CreditsOutroText"
	"[1.57]#portal_lyrics_07"         "CreditsOutroText"
	"[0.20] "                         "CreditsOutroText"
	"[0.75]*#portal_lyrics_08"        "CreditsOutroText" // combine this with the next two lines
	"[0.1]* "                         "CreditsOutroText"
	"[0.71]#portal_lyrics_09"         "CreditsOutroText"
	"[1.67] "                         "CreditsOutroText"
	"[1.55]*#portal_lyrics_10"        "CreditsOutroText" // combine with next line
	"[1.53]#portal_lyrics_11"         "CreditsOutroText"
	"[0.279] "                        "CreditsOutroText"
	"[1.741]<<<6>>>#portal_lyrics_12" "CreditsOutroText" // switch ascii art
	"[0.400]^"                        "CreditsOutroText" // force new line
	"[0.01]&"                         "CreditsOutroText" // blank screen
}
}}

== Portal ASCII art ==
{{portal|only}}
The <code>OutroAsciiArt</code> block defines all of the ASCII art images which can be switched between as the credits progress (see above). Despite the official credits file using a specific naming and formatting scheme for these, all of it does absolutely nothing. The game appears to simply read every subkey of <code>OutroAsciiArt</code> in order, and when an ASCII art index is selected, it will blindly draw 20 lines starting from the <code>index - 1 * 20</code>th key. This means all ASCII art must be exactly 20 lines in height, but the width can vary.

{{note|Like with names, having a closing square bracket (<code>]</code>) anywhere in a line will cause it and all preceding text to disappear despite this having no effect.}}

=== Example ===

{{pre|1= <!-- needed so equal signs in ascii art don't break formatting -->
"OutroAsciiArt"
{
	"APERTURE1" "[1.000]              .,-:;//;:=,               " // the key names here do not matter, nor do the bracketed numbers at the start of the value
	"APERTURE2" "[1.000]          . :H@@@MM@M#H/.,+%;,          "
	"APERTURE3" "[1.000]       ,/X+ +M@@M@MM%=,-%HMMM@X/,       "
	"APERTURE4" "[1.000]     -+@MM; $M@@MH+-,;XMMMM@MMMM@+-     "
	"APERTURE5" "[1.000]    ;@M@@M- XM@X;. -+XXXXXHHH@M@M#@/.   "
	"APERTURE6" "[1.000]  ,%MM@@MH ,@%=            .---=-=:=,.  "
	"APERTURE7" "[1.000]  =@#@@@MX .,              -%HX$$%%%+;  "
	"APERTURE8" "[1.000] =-./@M@M$                  .;@MMMM@MM: "
	"APERTURE9" "[1.000] X@/ -$MM/                    .+MM@@@M$ "
	"APERTURE10" "[1.000],@M@H: :@:                    . =X#@@@@-"
	"APERTURE11" "[1.000],@@@MMX, .                    /H- ;@M@M="
	"APERTURE12" "[1.000].H@@@@M@+,                    %MM+..%#$."
	"APERTURE13" "[1.000] /MMMM@MMH/.                  XM@MH; =; "
	"APERTURE14" "[1.000]  /%+%$XHH@$=              , .H@@@@MX,  "
	"APERTURE15" "[1.000]   .=--------.           -%H.,@@@@@MX,  "
	"APERTURE16" "[1.000]   .%MM@@@HHHXX$$$%+- .:$MMX =M@@MM%.   "
	"APERTURE17" "[1.000]     =XMMM@MM@MM#H;,-+HMM@M+ /MMMX=     "
	"APERTURE18" "[1.000]       =%@M@M#@$-.=$@MM@@@M; %M%=       "
	"APERTURE19" "[1.000]         ,:+$+-,/H#MMMMMMM@= =,         "
	"APERTURE20" "[1.000]               =++%%%%+/:-.             "
	"CAKE1" "[2.000]            ,:/+/-                      " // second ascii art starts exactly 20 lines down
	"CAKE2" "[2.000]            /M/              .,-=;//;-  "
	"CAKE3" "[2.000]       .:/= ;MH/,    ,=/+%$XH@MM#@:     "
	"CAKE4" "[2.000]      -$##@+$###@H@MMM#######H:.    -/H#"
	"CAKE5" "[2.000] .,H@H@ X######@ -H#####@+-     -+H###@X"
	"CAKE6" "[2.000]  .,@##H;      +XM##M/,     =%@###@X;-  "
	"CAKE7" "[2.000]X%-  :M##########$.    .:%M###@%:       "
	"CAKE8" "[2.000]M##H,   +H@@@$/-.  ,;$M###@%,          -"
	"CAKE9" "[2.000]M####M=,,---,.-%%H####M$:          ,+@##"
	"CAKE10" "[2.000]@##################@/.         :%H##@$- "
	"CAKE11" "[2.000]M###############H,         ;HM##M$=     "
	"CAKE12" "[2.000]#################.    .=$M##M$=         "
	"CAKE13" "[2.000]################H..;XM##M$=          .:+"
	"CAKE14" "[2.000]M###################@%=           =+@MH%"
	"CAKE15" "[2.000]@################M/.          =+H#X%=   "
	"CAKE16" "[2.000]=+M##############M,       -/X#X+;.      "
	"CAKE17" "[2.000]  .;XM##########H=    ,/X#H+:,          "
	"CAKE18" "[2.000]     .=+HM######M+/+HM@+=.              "
	"CAKE19" "[2.000]         ,:/%XM####H/.                  "
	"CAKE20" "[2.000]              ,.:=-.                    "
}
}}
[[Category:Plain text files]]