Skip to content

Latest commit

 

History

History
125 lines (66 loc) · 4.94 KB

CaptionMod.md

File metadata and controls

125 lines (66 loc) · 4.94 KB
Raw

CaptionMod documentation

中文文档

Compatibility

Engine
GoldSrc_blob (3248~4554) √
GoldSrc_legacy (4554~6153) √
GoldSrc_new (8684 ~) √
SvEngine (8832 ~) √
GoldSrc_HL25 (>= 9884) √

Features

Language Enforcement

You can force the engine and VGUI2 to use language settings from Steam or from launch parameters.

Check Launch Parameters

VGUI2-based Subtitle System

You can:

  1. Display subtitles when sound is played

  2. Display subtitles when sentence is played

  3. Display subtitles when client receives HudText message

  4. Display subtitles when client receives SendAudio message

The subtitles are defined in \Sven Co-op\svencoop\captionmod\dictionary.csv, which can be opened with Microsoft Excel or any other open-sourced CSV editors.

HUDText Message Translation System

You can translate HUDText message into other language dynamically (regex supported)

There is a example file demostrates how to translate static HUD TextMessage to schinese , the file is at \Sven Co-op\svencoop_schinese\maps\restriction02_dictionary.csv.

There is a example file demostrates how to translate dynamic HUD TextMessage to schinese using regex, the file is at \Sven Co-op\svencoop\captionmod\dictionary_schinese.txt called #SVENCOOP_PLAYERINFO.

Mutli-byte character support for legacy VGUI1 and HUD elements

  1. Client's HudText are overhauled with multi-byte character support. (Sven Co-op and Half-Life)

  2. VGUI1 TextImage's are overhauled with multi-byte character support.

  • You can see multi-byte characters rendered correctly on VGUI1 scoreboard. (Sven Co-op and Half-Life)
  1. Client's HUDMenu are overhauled with multi-byte character support. (Sven Co-op only)
  • You can see multi-byte characters rendered correctly on HudMenu.

Source2007 style VGUI2-based ChatDialog

Set cvar cap_newchat to 1 to enable the new VGUI2-based chat dialog.

The default chat text color can be customized in \Sven Co-op\svencoop\captionmod\ChatScheme.res -> Colors -> TanLight

HiDpi Support

All VGUI2 elements will be proportional (scaling up base on your game resolution)

The HiDpi Support is enabled by defalut if your system's dpi scaling > 100% and you are running on a non-HL25th engine

When HiDpi Support is enabled, the following paths will be added to the FileSystem's search paths with "SKIN" tag. VGUI2 control settings will be loaded from those sources.

  1. (GameDirectory)\(ModDirectory)_dpi(DpiScalingPercentage)

e.g. \Sven Co-op\svencoop_dpi150 or \Half-Life\valve_dpi200

  1. (GameDirectory)\(ModDirectory)_hidpi

e.g. \Sven Co-op\svencoop_hidpi or \Half-Life\valve_hidpi

Console Vars

cap_hudmessage : To enable or disable CaptionMod's HUD TextMessage translation.

cap_netmessage : To enable or disable CaptionMod's __NETMESSAGE__ HUD TextMessage translation.

cap_max_distance : Ignore sound or sentences (which are supposed to play subtitles) whose speaker is too far away from this distance.

cap_min_avol : Ignore sound or sentences (which are supposed to play subtitles) which plays with volume smaller than this value.

cap_debug : To output debug message of the Subtitle System and HudMessage Translation System. You can set cap_debug to 1 to check wether an dictionary entry is found or not in the Subtitle System.

cap_newchat : To enable or disable Source2007 style VGUI2 chat dialog.

cap_lang : Indicate current game lanuage. Any changes to this cvar acutally do nothing. Provide the capability of getting client's current game language by sending network message "svc_sendcvarvalue" or "svc_sendcvarvalue2" or reading userinfo "cap_lang" from server.

Console Vars (Subtitle System)

cap_enabled : Set to 1 to display subtitles (if available).

cap_subtitle_prefix : Set to 1 to display speaker's name before subtitle lines.

cap_subtitle_waitplay : Set to 1 to wait for all previous lines from being displayed before playing next line.

cap_subtitle_antispam : Set to 1 to prevent the subtitle from spamming.

cap_subtitle_fadein : Fade-in duration for new subtitle lines.

cap_subtitle_fadeout : Fade-out duration for retired subtitle lines.

cap_subtitle_holdtime : Default hold duration for subtitle lines.

cap_subtitle_stimescale : Scaling factor for "StartTime".

cap_subtitle_htimescale : Scaling factor for "HoldTime".

Launch Parameters

-steamlang : use Steam language as engine and vgui2 language, ignore game language setting in Steam's game config panel. for Sven Co-op, it always uses Steam language as engine and vgui2 language no matter if -steamlang is added or not.

-forcelang [language] : force engine and vgui2 to use [language] as engine and vgui2 language, ignore game language setting in Steam's game config panel.

-high_dpi : Enable HiDpi Support

-no_high_dpi : Disable HiDpi Support