Options file structure: Difference between revisions

From Unofficial Homecoming Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Overview ==
== Overview ==
[[Issue 12]] introduced the ability to save in-game options. This article aims to document the format/syntax of the text files created. The {{slashcommand|option_save}} and {{slashcommand|option_save|path}} commands save a text file, either in the installation folder or to a specified file path. The contents of the file depends on what has been set in the [[The Players' Guide to the Cities/User Interface/Options Window|Options Window]].
[[Issue 12]] introduced the ability to save in-game options. This article aims to document the format/syntax of the text files created. The {{slashcommand|option_save}} and {{slashcommand|option_save_file|path}} commands save a text file, either in the installation folder or to a specified file path. The values in the file depend on what has been set in the [[The Players' Guide to the Cities/User Interface/Options Window|Options Window]] or by the  {{slashcommand|Option_set}} command. Copied below are the contents of the default Options.txt file from when the game is initially installed.


== Default Structure ==
== Default Structure ==
<code>MouseSpeed 1.000000</code> -- How fast the mouse pointer moves on the screen<br />
<pre>
<code>SpeedTurn 3.000000</code> -- How fast the character spins with /turnleft<br />
MouseSpeed 1.000000
<code>MouseInvert 0</code> -- Which way the camera looks when you move the mouse up and down<br />
SpeedTurn 3.000000
<code>ChatFade 0</code> -- How fast the chat fades when out of focus/hover<br />
MouseInvert 1
<code>Chat1Fade 0</code> -- How fast Chat Tab 1 fades<br />
ChatFade 0
<code>Chat2Fade 0</code> -- How fast Chat Tab 2 fades<br />
Chat1Fade 0
<code>Chat3Fade 0</code> -- How fast Chat Tab 3 fades<br />
Chat2Fade 0
<code>Chat4Fade 0</code> -- How fast Chat Tab 4 fades<br />
Chat3Fade 0
<code>CompassFade 0</code> -- How fast the compass window fades<br />
Chat4Fade 0
<code>UseToolTips 1</code> -- Hide (0) or show (1) tooltips<br />
CompassFade 0
<code>AllowProfanity 0</code> -- Disable (1) or enable (0) profanity filter<br />
UseToolTips 1
<code>ShowBallons 1</code> -- Hide (0) or show (1) chat balloons<br />
AllowProfanity 0
<code>DeclineGifts 0</code> -- Disable (1) or allow (0) non-teammate gifts<br />
ShowBallons 1
<code>DeclineGiftsFromTeammates 0</code> -- Disable (1) or allow (0) teammate gifts<br />
DeclineGifts 0
<code>PromptTeleportFromTeammates 0</code> -- Disable (0) or enable (1) the teleportation prompt<br />
DeclineGiftsFromTeammates 0
<code>ShowPets 0</code> -- Hide (0) or show (1) the pets window<br />
PromptTeleportFromTeammates 0
<code>WebHideStats 0</code> -- Hide (1) or show (0) stats from City Vault<br />
ShowPets 0
<code>WebHideBadges 0</code> -- Hide (1) or show (0) badges from City Vault<br />
LockTrayNumbers 0
<code>WebHideFriends 1</code> -- Hide (1) or show (0) friends from City Vault<br />
HideContactIcons 0
<code>WindowFade 0</code> -- How fast all windows fade when out of focus/hover<br />
ShowAllStoreBoosts 0
<code>EnableChatLog 0</code> -- Disable (0) or enable (1) logging chat<br />
WebHideBadges 0
<code>HideHeader 0</code> -- Hide (1) or show (0) the header at the top of the Supergroup window<br />
WebHideFriends 0
<code>HideButtons 0</code> -- Hide (1) or show (0) the bottom row of buttons in the Supergroup window<br />
WindowFade 0
<code>EnableClickToMove 0</code> -- Disable (0) or enable (1) click to move<br />
EnableChatLog 0
<code>DisableDrag 0</code> -- Disable (1) or allow (0) dragging power icons in the tray<br />
HideHeader 0
<code>gShowPetBuffs 0</code> -- Hide (0) or show (1) {{red|buffs in [[Pets Window]]?}}<br />
HideButtons 0
<code>PreventPetIconDrag 0</code> -- Prevent (0) or allow (1) {{red|dragging pet icons in Pet Window?}}<br />
EnableClickToMove 0
<code>ShowPetControls 0</code> -- Hide (0) or show (1) pet controls in Pet Window<br />
DisableDrag 0
<code>AdvancedPetControls 0</code> -- Hide (0) or show (1) advanced controls in Pet Window<br />
gShowPetBuffs 0
<code>ChatDisablePetSay 0</code> -- Hide (1) or show (0) {{red|your own pets' chatter?}}<br />
PreventPetIconDrag 0
<code>ChatEnablePetTeamSay 0</code> -- Hide (0) or show (1) {{red|teammate pet chatter?}}<br />
ShowPetControls 0
<code>TeamComplete 0</code> -- Disable (0) or enable (1) cooperative mission completion<br />
AdvancedPetControls 0
<code>HidePetNames 0</code> -- Hide (1) or show (0) custom pet names (only affects MM henchmen<br />
ChatDisablePetSay 0
<code>HidePromptPlaceEnhancement 0</code> -- Disable (1) or enable (0) warning prompt when placing enhancements<br />
ChatEnablePetTeamSay 0
<code>HidePromptDeleteEnhancement 0</code> -- Disable (1) or enable (0) warning prompt when deleting enhancements<br />
TeamComplete 0
<code>HidePromptDeleteSalvage 0</code> -- Disable (1) or enable (0) warning prompt when deleting salvage<br />
HidePetNames 0
<code>HidePromptDeleteRecipe 0</code> -- Disable (1) or enable (0) warning prompt when deleting recipes<br />
HidePromptPlaceEnhancement 0
<code>HideInspirationFullMsg 0</code> -- Disable (1) or enable (0) warning message when inspiration tray is full<br />
HidePromptDeleteEnhancement 0
<code>HideSalvageFullMsg 0</code> -- Disable (1) or enable (0) warning message when salvage capacity is full<br />
HidePromptDeleteSalvage 0
<code>HideRecipeFullMsg 0</code> -- Disable (1) or enable (0) warning message when recipe capacity is full<br />
HidePromptDeleteRecipe 0
<code>HideEnhancementFullMsg 0</code> -- Disable (1) or enable (0) warning message when enhancement tray is full<br />
HideInspirationFullMsg 0
<code>ShowEnemyTells 1</code> -- Disable (0) or enable (1) /tells from the opposite faction<br />
HideSalvageFullMsg 0
<code>SeeEnemyBroadcast 1</code> -- Disable (0) or enable (1) viewing /broadcast chat from the opposite faction<br />
HideRecipeFullMsg 0
<code>DoNotSeeEnemyLocal 0</code> -- Disable (1) or enable (0) viewing /local chat from the opposite faction<br />
HideEnhancementFullMsg 0
<code>HidePromptCoop 0</code> -- Disable (0) or enable (1) prompt for cooperative mission completion<br />
ShowEnemyTells 1
<code>StaticColorsPerName 0</code> -- Enable (0) or disable (1) colored names in chat<br />
SeeEnemyBroadcast 1
<code>ContactSort 0</code> -- Sorting the [[The Players' Guide to the Cities/User Interface/Contact Window|Contact Window]], various options<br />
DoNotSeeEnemyLocal 0
<code>RecipeHideMissingParts 0</code> -- Hide (1) or show (0) recipes with missing salvage in the recipe windows<br />
HidePromptCoop 0
<code>RecipeHideUnowned 0</code> -- Hide (1) or show (0) unowned recipes in the recipe windows<br />
StaticColorsPerName 0
<code>RecipeHideMissingPartsBench 0</code> -- Hide (1) or show (0) recipes with missing salvage in the invention workbench<br />
ContactSort 0
<code>RecipeHideUnownedBench 0</code> -- Hide (1) or show (0) unowned recipes in the invention workbench<br />
RecipeHideMissingParts 0
<code>AutoDeclineSuperGroupInvite 0</code> -- Decline (1) or allow (0) supergroup invites<br />
RecipeHideUnowned 0
<code>AutoDeclineTradeInvite 0</code> -- Decline (1) or allow (0) trade invitations<br />
RecipeHideMissingPartsBench 0
<code>CamFree 0</code> -- Disable (0) or allow (1) the camera to move independently of character orientation<br />
RecipeHideUnownedBench 0
<code>ToolTipDelaySec 0.600000</code> -- How fast tooltips take to display<br />
AutoDeclineSuperGroupInvite 0
<code>ShowArchetype 2</code> -- Show Player archetype, various options<br />
AutoDeclineTradeInvite 0
<code>ShowSupergroup 2</code> -- Show Player supergroup (if applicable), various options<br />
CamFree 0
<code>ShowPlayerName 1</code> -- Show Player names -- Hidden (0), Always (1), On mouse over (2), When selected (4), When selected or on mouseover (6)<br />
ToolTipDelaySec 0.600000
<code>ShowPlayerBars 6</code> -- Show Player health/endurance bars -- Hidden (0), Always (1), On mouse over (2), When selected (4), When selected or on mouseover (6)<br />
ShowArchetype 2
<code>ShowVillainName 6</code> -- Show Enemy Names -- Hidden (0), Always (1), On mouse over (2), When selected (4), When selected or on mouseover (6)<br />
ShowSupergroup 2
<code>ShowVillainBars 6</code> -- Show Enemy Health/End Bars -- Hidden (0), Always (1), On mouse over (2), When selected (4), When selected or on mouseover (6)<br />
ShowPlayerName 1
<code>ShowPlayerReticles 6</code> -- Show targeting reticles on friendlies, various options<br />
ShowPlayerBars 6
<code>ShowVillainReticles 6</code> -- Show targeting reticles on enemies, various options<br />
ShowVillainName 6
<code>ShowAssistReticles 6</code> -- Show reticles when targeting through something/someone, various options<br />
ShowVillainBars 6
<code>ShowOwnerName 0</code> -- Show Personal Player Name -- Hidden (0), Show always (1)<br />
ShowPlayerReticles 6
<code>MousePitchSetting 0</code> -- Look Up and Down. These are options for controlling the mouse pitch.  "Free Look" (0) places no restriction on pitch. "Center When Moving" (1) will return the camera to the default pitch whenever your character moves. "Always Centered" (2) locks the camera pitch to the default angle<br />
ShowVillainReticles 6
<code>MapOptions 0</code> -- What is displayed on the [[The Players' Guide to the Cities/User Interface/Map Window|Map Window]], various options<br />
ShowAssistReticles 6
<code>BuffSettings 0</code> -- Disable (1) or enable (0) sending of buff information (disabling greatly reduces information flow)<br />
ShowOwnerName 0
<code>ChatBubbleColor1 0</code> -- Chat balloon text color<br />
MousePitchSetting 0
<code>ChatBubbleColor2 ffffffff</code> -- Chat balloon background color<br />
MapOptions bffffefe
<code>DefaultChatFontSize 12</code> -- Text size, mostly affects chat windows<br />
BuffSettings 0
<code>MouseButtonReverse 0</code> -- Mouse buttons: Normal (left-click doors, right click characters for options) (0) or reversed (right click doors, left click characters for options) (1)<br />
ChatBubbleColor1 0
<code>DisableCameraShake 0</code> -- Disable (1) or enable (0) camera shake with certain powers (disabling is good for motion sickness sufferers)<br />
ChatBubbleColor2 ffffffff
<code>DisableMouseScroll 0</code> -- Disable (1) or enable (0) scrolling with the mouse wheel<br />
DefaultChatFontSize 12
<code>LogPrivateMessages 0</code> -- Disable (0) or enable (1) /tell logging<br />
MouseButtonReverse 0
<code>ShowPlayerRating 6</code> -- Show [[Player Rating System|rating]], various options<br />
DisableCameraShake 0
<code>DisableLoadingTips 0</code> -- Disable (1) or enable (0) helpful hints on loading screens<br />
DisableMouseScroll 0
<code>MouseScrollSpeed 20.000000</code> -- How fast the mouse wheel will scroll in scrollable windows<br />
LogPrivateMessages 0
<code>EnableJoystick 1</code> -- Disable (0) or enable (1) the use of joysticks<br />
ShowPlayerRating 6
<code>FadeExtraTrays 0</code> -- Disable (0) or enable (1) extra trays fading<br />
DisableLoadingTips 0
<code>ArchitectNav 1</code> -- Regarding the [[Mission Architect]] coming in [[Issue 14]]<br />
MouseScrollSpeed 20.000000
<code>ArchitectToolTips 1</code> -- Regarding the [[Mission Architect]] coming [[Issue 14]]<br />
EnableJoystick 1
<code>ArchitectAutoSave 1</code> -- Regarding the [[Mission Architect]] coming [[Issue 14]]<br />
FadeExtraTrays 0
<code>NoXP 0</code> -- Disable (1) or enable (0) experience earning
ArchitectNav 1
ArchitectToolTips 1
ArchitectAutoSave 1
NoXP 0
ArchitectBlockComment 0
AutoAcceptTeamLevelAbove 0
AutoAcceptTeamLevelBelow 0
DisableEmail 0
FriendSGEmailOnly 0
NoXPExemplar 0
HideFee 0
HideSalvageWarning 0
GmailFriendOnly 0
UseOldTeamUI 0
HideUnclaimableCert 0
BlinkCertifications 1
VoucherPrompt 0
NewCertPrompt 0
HidePromptUnslotEnhancement 0
MapOptionRevision 4
MapOptions2 e
OpenSalvageWarning 0
HidePromptBooster 0
HidePromptCatalyst 0
AutoFlipSuperPackCards 0
HideConvertConfirmPrompt 0
HideStorePiecesState 0
CursorScale 1.000000
</pre>
 
 


{{Navbox Option Commands}}
{{Navbox Option Commands}}


[[Category:Game Client]]
[[Category:Game Client]]

Latest revision as of 21:09, 12 February 2024

Overview

Issue 12 introduced the ability to save in-game options. This article aims to document the format/syntax of the text files created. The /option_save and /option_save_file path commands save a text file, either in the installation folder or to a specified file path. The values in the file depend on what has been set in the Options Window or by the /Option_set command. Copied below are the contents of the default Options.txt file from when the game is initially installed.

Default Structure

MouseSpeed 1.000000
SpeedTurn 3.000000
MouseInvert 1
ChatFade 0
Chat1Fade 0
Chat2Fade 0
Chat3Fade 0
Chat4Fade 0
CompassFade 0
UseToolTips 1
AllowProfanity 0
ShowBallons 1
DeclineGifts 0
DeclineGiftsFromTeammates 0
PromptTeleportFromTeammates 0
ShowPets 0
LockTrayNumbers 0
HideContactIcons 0
ShowAllStoreBoosts 0
WebHideBadges 0
WebHideFriends 0
WindowFade 0
EnableChatLog 0
HideHeader 0
HideButtons 0
EnableClickToMove 0
DisableDrag 0
gShowPetBuffs 0
PreventPetIconDrag 0
ShowPetControls 0
AdvancedPetControls 0
ChatDisablePetSay 0
ChatEnablePetTeamSay 0
TeamComplete 0
HidePetNames 0
HidePromptPlaceEnhancement 0
HidePromptDeleteEnhancement 0
HidePromptDeleteSalvage 0
HidePromptDeleteRecipe 0
HideInspirationFullMsg 0
HideSalvageFullMsg 0
HideRecipeFullMsg 0
HideEnhancementFullMsg 0
ShowEnemyTells 1
SeeEnemyBroadcast 1
DoNotSeeEnemyLocal 0
HidePromptCoop 0
StaticColorsPerName 0
ContactSort 0
RecipeHideMissingParts 0
RecipeHideUnowned 0
RecipeHideMissingPartsBench 0
RecipeHideUnownedBench 0
AutoDeclineSuperGroupInvite 0
AutoDeclineTradeInvite 0
CamFree 0
ToolTipDelaySec 0.600000
ShowArchetype 2
ShowSupergroup 2
ShowPlayerName 1
ShowPlayerBars 6
ShowVillainName 6
ShowVillainBars 6
ShowPlayerReticles 6
ShowVillainReticles 6
ShowAssistReticles 6
ShowOwnerName 0
MousePitchSetting 0
MapOptions bffffefe
BuffSettings 0
ChatBubbleColor1 0
ChatBubbleColor2 ffffffff
DefaultChatFontSize 12
MouseButtonReverse 0
DisableCameraShake 0
DisableMouseScroll 0
LogPrivateMessages 0
ShowPlayerRating 6
DisableLoadingTips 0
MouseScrollSpeed 20.000000
EnableJoystick 1
FadeExtraTrays 0
ArchitectNav 1
ArchitectToolTips 1
ArchitectAutoSave 1
NoXP 0
ArchitectBlockComment 0
AutoAcceptTeamLevelAbove 0
AutoAcceptTeamLevelBelow 0
DisableEmail 0
FriendSGEmailOnly 0
NoXPExemplar 0
HideFee 0
HideSalvageWarning 0
GmailFriendOnly 0
UseOldTeamUI 0
HideUnclaimableCert 0
BlinkCertifications 1
VoucherPrompt 0
NewCertPrompt 0
HidePromptUnslotEnhancement 0
MapOptionRevision 4
MapOptions2 e
OpenSalvageWarning 0
HidePromptBooster 0
HidePromptCatalyst 0
AutoFlipSuperPackCards 0
HideConvertConfirmPrompt 0
HideStorePiecesState 0
CursorScale 1.000000


Retrieved from "https://homecoming.wiki/w/index.php?title=Options_file_structure&oldid=317106"