Difference between revisions of "Options file structure"
m (→Default Structure: disabledrag) |
m |
||
(5 intermediate revisions by 4 users 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. | + | [[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]]. |
== Default Structure == | == Default Structure == | ||
Line 6: | Line 6: | ||
<code>SpeedTurn 3.000000</code> -- How fast the character spins with /turnleft<br /> | <code>SpeedTurn 3.000000</code> -- How fast the character spins with /turnleft<br /> | ||
<code>MouseInvert 0</code> -- Which way the camera looks when you move the mouse up and down<br /> | <code>MouseInvert 0</code> -- Which way the camera looks when you move the mouse up and down<br /> | ||
− | <code>ChatFade 0</code> -- How fast the chat fades when | + | <code>ChatFade 0</code> -- How fast the chat fades when out of focus/hover<br /> |
<code>Chat1Fade 0</code> -- How fast Chat Tab 1 fades<br /> | <code>Chat1Fade 0</code> -- How fast Chat Tab 1 fades<br /> | ||
<code>Chat2Fade 0</code> -- How fast Chat Tab 2 fades<br /> | <code>Chat2Fade 0</code> -- How fast Chat Tab 2 fades<br /> | ||
Line 12: | Line 12: | ||
<code>Chat4Fade 0</code> -- How fast Chat Tab 4 fades<br /> | <code>Chat4Fade 0</code> -- How fast Chat Tab 4 fades<br /> | ||
<code>CompassFade 0</code> -- How fast the compass window fades<br /> | <code>CompassFade 0</code> -- How fast the compass window fades<br /> | ||
− | <code>UseToolTips 1</code> -- | + | <code>UseToolTips 1</code> -- Hide (0) or show (1) tooltips<br /> |
− | <code>AllowProfanity 0</code> -- | + | <code>AllowProfanity 0</code> -- Disable (1) or enable (0) profanity filter<br /> |
− | <code>ShowBallons 1</code> -- | + | <code>ShowBallons 1</code> -- Hide (0) or show (1) chat balloons<br /> |
− | <code>DeclineGifts 0</code> -- | + | <code>DeclineGifts 0</code> -- Disable (1) or allow (0) non-teammate gifts<br /> |
− | <code>DeclineGiftsFromTeammates 0</code> -- | + | <code>DeclineGiftsFromTeammates 0</code> -- Disable (1) or allow (0) teammate gifts<br /> |
− | <code>PromptTeleportFromTeammates 0</code> -- | + | <code>PromptTeleportFromTeammates 0</code> -- Disable (0) or enable (1) the teleportation prompt<br /> |
− | <code>ShowPets 0</code> -- | + | <code>ShowPets 0</code> -- Hide (0) or show (1) the pets window<br /> |
− | <code>WebHideStats 0</code> -- | + | <code>WebHideStats 0</code> -- Hide (1) or show (0) stats from City Vault<br /> |
− | <code>WebHideBadges 0</code> -- | + | <code>WebHideBadges 0</code> -- Hide (1) or show (0) badges from City Vault<br /> |
− | <code>WebHideFriends 1</code> -- | + | <code>WebHideFriends 1</code> -- Hide (1) or show (0) friends from City Vault<br /> |
− | <code>WindowFade 0</code> -- How fast all windows | + | <code>WindowFade 0</code> -- How fast all windows fade when out of focus/hover<br /> |
− | <code>EnableChatLog 0</code> -- | + | <code>EnableChatLog 0</code> -- Disable (0) or enable (1) logging chat<br /> |
<code>HideHeader 0</code> -- {{red|What the heck is this one?}}<br /> | <code>HideHeader 0</code> -- {{red|What the heck is this one?}}<br /> | ||
<code>HideButtons 0</code> -- {{red|What the heck is this one?}}<br /> | <code>HideButtons 0</code> -- {{red|What the heck is this one?}}<br /> | ||
− | <code>EnableClickToMove 0</code> -- | + | <code>EnableClickToMove 0</code> -- Disable (0) or enable (1) click to move<br /> |
<code>DisableDrag 0</code> -- Disable (1) or allow (0) dragging power icons in the tray<br /> | <code>DisableDrag 0</code> -- Disable (1) or allow (0) dragging power icons in the tray<br /> | ||
− | <code>gShowPetBuffs 0</code> -- | + | <code>gShowPetBuffs 0</code> -- Hide (0) or show (1) {{red|buffs in [[Pets Window]]?}}<br /> |
<code>PreventPetIconDrag 0</code> -- Prevent (0) or allow (1) {{red|dragging pet icons in Pet Window?}}<br /> | <code>PreventPetIconDrag 0</code> -- Prevent (0) or allow (1) {{red|dragging pet icons in Pet Window?}}<br /> | ||
− | <code>ShowPetControls 0</code> -- | + | <code>ShowPetControls 0</code> -- Hide (0) or show (1) pet controls in Pet Window<br /> |
− | <code>AdvancedPetControls 0</code> -- | + | <code>AdvancedPetControls 0</code> -- Hide (0) or show (1) advanced controls in Pet Window<br /> |
− | <code>ChatDisablePetSay 0</code> -- | + | <code>ChatDisablePetSay 0</code> -- Hide (1) or show (0) {{red|your own pets' chatter?}}<br /> |
− | <code>ChatEnablePetTeamSay 0</code> -- | + | <code>ChatEnablePetTeamSay 0</code> -- Hide (0) or show (1) {{red|teammate pet chatter?}}<br /> |
− | <code>TeamComplete 0</code> -- | + | <code>TeamComplete 0</code> -- Disable (0) or enable (1) cooperative mission completion<br /> |
<code>HidePetNames 0</code> -- Hide (1) or show (0) custom pet names (only affects MM henchmen<br /> | <code>HidePetNames 0</code> -- Hide (1) or show (0) custom pet names (only affects MM henchmen<br /> | ||
<code>HidePromptPlaceEnhancement 0</code> -- Disable (1) or enable (0) warning prompt when placing enhancements<br /> | <code>HidePromptPlaceEnhancement 0</code> -- Disable (1) or enable (0) warning prompt when placing enhancements<br /> | ||
Line 49: | Line 49: | ||
<code>HidePromptCoop 0</code> -- Disable (0) or enable (1) prompt for cooperative mission completion<br /> | <code>HidePromptCoop 0</code> -- Disable (0) or enable (1) prompt for cooperative mission completion<br /> | ||
<code>StaticColorsPerName 0</code> -- Enable (0) or disable (1) colored names in chat<br /> | <code>StaticColorsPerName 0</code> -- Enable (0) or disable (1) colored names in chat<br /> | ||
− | <code>ContactSort 0</code> -- | + | <code>ContactSort 0</code> -- Sorting the [[The Players' Guide to the Cities/User Interface/Contact Window|Contact Window]], various options<br /> |
<code>RecipeHideMissingParts 0</code> -- Hide (1) or show (0) recipes with missing salvage in the recipe windows<br /> | <code>RecipeHideMissingParts 0</code> -- Hide (1) or show (0) recipes with missing salvage in the recipe windows<br /> | ||
<code>RecipeHideUnowned 0</code> -- Hide (1) or show (0) unowned recipes in the recipe windows<br /> | <code>RecipeHideUnowned 0</code> -- Hide (1) or show (0) unowned recipes in the recipe windows<br /> | ||
Line 58: | Line 58: | ||
<code>CamFree 0</code> -- Disable (0) or allow (1) the camera to move independently of character orientation<br /> | <code>CamFree 0</code> -- Disable (0) or allow (1) the camera to move independently of character orientation<br /> | ||
<code>ToolTipDelaySec 0.600000</code> -- How fast tooltips take to display<br /> | <code>ToolTipDelaySec 0.600000</code> -- How fast tooltips take to display<br /> | ||
− | <code>ShowArchetype 2</code> -- Show | + | <code>ShowArchetype 2</code> -- Show Player archetype, various options<br /> |
− | <code>ShowSupergroup 2</code> -- Show | + | <code>ShowSupergroup 2</code> -- Show Player supergroup (if applicable), various options<br /> |
− | <code>ShowPlayerName 1</code> -- Show | + | <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 /> |
− | <code>ShowPlayerBars 6</code> -- Show | + | <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 /> |
− | <code>ShowVillainName 6</code> -- Show | + | <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 /> |
− | <code>ShowVillainBars 6</code> -- Show | + | <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 /> |
<code>ShowPlayerReticles 6</code> -- Show targeting reticles on friendlies, various options<br /> | <code>ShowPlayerReticles 6</code> -- Show targeting reticles on friendlies, various options<br /> | ||
<code>ShowVillainReticles 6</code> -- Show targeting reticles on enemies, various options<br /> | <code>ShowVillainReticles 6</code> -- Show targeting reticles on enemies, various options<br /> | ||
<code>ShowAssistReticles 6</code> -- Show reticles when targeting through something/someone, various options<br /> | <code>ShowAssistReticles 6</code> -- Show reticles when targeting through something/someone, various options<br /> | ||
− | <code>ShowOwnerName 0</code> -- Show | + | <code>ShowOwnerName 0</code> -- Show Personal Player Name -- Hidden (0), Show always (1)<br /> |
<code>MousePitchSetting 0</code> -- {{red|What the heck is this one?}}<br /> | <code>MousePitchSetting 0</code> -- {{red|What the heck is this one?}}<br /> | ||
− | <code>MapOptions 0</code> -- | + | <code>MapOptions 0</code> -- What is displayed on the [[The Players' Guide to the Cities/User Interface/Map Window|Map Window]], various options<br /> |
<code>BuffSettings 0</code> -- Disable (1) or enable (0) sending of buff information (disabling greatly reduces information flow)<br /> | <code>BuffSettings 0</code> -- Disable (1) or enable (0) sending of buff information (disabling greatly reduces information flow)<br /> | ||
<code>ChatBubbleColor1 0</code> -- Chat balloon text color<br /> | <code>ChatBubbleColor1 0</code> -- Chat balloon text color<br /> | ||
<code>ChatBubbleColor2 ffffffff</code> -- Chat balloon background color<br /> | <code>ChatBubbleColor2 ffffffff</code> -- Chat balloon background color<br /> | ||
<code>DefaultChatFontSize 12</code> -- Text size, mostly affects chat windows<br /> | <code>DefaultChatFontSize 12</code> -- Text size, mostly affects chat windows<br /> | ||
− | <code>MouseButtonReverse 0</code> -- Normal (left-click doors, right click characters for options) (0) or reversed (right click doors, left click characters for options) (1) | + | <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 /> |
<code>DisableCameraShake 0</code> -- Disable (1) or enable (0) camera shake with certain powers (disabling is good for motion sickness sufferers)<br /> | <code>DisableCameraShake 0</code> -- Disable (1) or enable (0) camera shake with certain powers (disabling is good for motion sickness sufferers)<br /> | ||
<code>DisableMouseScroll 0</code> -- Disable (1) or enable (0) scrolling with the mouse wheel<br /> | <code>DisableMouseScroll 0</code> -- Disable (1) or enable (0) scrolling with the mouse wheel<br /> | ||
Line 86: | Line 86: | ||
<code>ArchitectToolTips 1</code> -- Regarding the [[Mission Architect]] coming [[Issue 14]]<br /> | <code>ArchitectToolTips 1</code> -- Regarding the [[Mission Architect]] coming [[Issue 14]]<br /> | ||
<code>ArchitectAutoSave 1</code> -- Regarding the [[Mission Architect]] coming [[Issue 14]]<br /> | <code>ArchitectAutoSave 1</code> -- Regarding the [[Mission Architect]] coming [[Issue 14]]<br /> | ||
− | <code>NoXP 0</code> -- Disable ( | + | <code>NoXP 0</code> -- Disable (1) or enable (0) experience earning |
− | {{Option Commands | + | {{Navbox Option Commands}} |
+ | |||
+ | [[Category:Game Client]] |
Latest revision as of 08:20, 9 July 2012
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 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 Options Window.
Default Structure
MouseSpeed 1.000000
-- How fast the mouse pointer moves on the screen
SpeedTurn 3.000000
-- How fast the character spins with /turnleft
MouseInvert 0
-- Which way the camera looks when you move the mouse up and down
ChatFade 0
-- How fast the chat fades when out of focus/hover
Chat1Fade 0
-- How fast Chat Tab 1 fades
Chat2Fade 0
-- How fast Chat Tab 2 fades
Chat3Fade 0
-- How fast Chat Tab 3 fades
Chat4Fade 0
-- How fast Chat Tab 4 fades
CompassFade 0
-- How fast the compass window fades
UseToolTips 1
-- Hide (0) or show (1) tooltips
AllowProfanity 0
-- Disable (1) or enable (0) profanity filter
ShowBallons 1
-- Hide (0) or show (1) chat balloons
DeclineGifts 0
-- Disable (1) or allow (0) non-teammate gifts
DeclineGiftsFromTeammates 0
-- Disable (1) or allow (0) teammate gifts
PromptTeleportFromTeammates 0
-- Disable (0) or enable (1) the teleportation prompt
ShowPets 0
-- Hide (0) or show (1) the pets window
WebHideStats 0
-- Hide (1) or show (0) stats from City Vault
WebHideBadges 0
-- Hide (1) or show (0) badges from City Vault
WebHideFriends 1
-- Hide (1) or show (0) friends from City Vault
WindowFade 0
-- How fast all windows fade when out of focus/hover
EnableChatLog 0
-- Disable (0) or enable (1) logging chat
HideHeader 0
-- What the heck is this one?
HideButtons 0
-- What the heck is this one?
EnableClickToMove 0
-- Disable (0) or enable (1) click to move
DisableDrag 0
-- Disable (1) or allow (0) dragging power icons in the tray
gShowPetBuffs 0
-- Hide (0) or show (1) buffs in Pets Window?
PreventPetIconDrag 0
-- Prevent (0) or allow (1) dragging pet icons in Pet Window?
ShowPetControls 0
-- Hide (0) or show (1) pet controls in Pet Window
AdvancedPetControls 0
-- Hide (0) or show (1) advanced controls in Pet Window
ChatDisablePetSay 0
-- Hide (1) or show (0) your own pets' chatter?
ChatEnablePetTeamSay 0
-- Hide (0) or show (1) teammate pet chatter?
TeamComplete 0
-- Disable (0) or enable (1) cooperative mission completion
HidePetNames 0
-- Hide (1) or show (0) custom pet names (only affects MM henchmen
HidePromptPlaceEnhancement 0
-- Disable (1) or enable (0) warning prompt when placing enhancements
HidePromptDeleteEnhancement 0
-- Disable (1) or enable (0) warning prompt when deleting enhancements
HidePromptDeleteSalvage 0
-- Disable (1) or enable (0) warning prompt when deleting salvage
HidePromptDeleteRecipe 0
-- Disable (1) or enable (0) warning prompt when deleting recipes
HideInspirationFullMsg 0
-- Disable (1) or enable (0) warning message when inspiration tray is full
HideSalvageFullMsg 0
-- Disable (1) or enable (0) warning message when salvage capacity is full
HideRecipeFullMsg 0
-- Disable (1) or enable (0) warning message when recipe capacity is full
HideEnhancementFullMsg 0
-- Disable (1) or enable (0) warning message when enhancement tray is full
ShowEnemyTells 1
-- Disable (0) or enable (1) /tells from the opposite faction
SeeEnemyBroadcast 1
-- Disable (0) or enable (1) viewing /broadcast chat from the opposite faction
DoNotSeeEnemyLocal 0
-- Disable (1) or enable (0) viewing /local chat from the opposite faction
HidePromptCoop 0
-- Disable (0) or enable (1) prompt for cooperative mission completion
StaticColorsPerName 0
-- Enable (0) or disable (1) colored names in chat
ContactSort 0
-- Sorting the Contact Window, various options
RecipeHideMissingParts 0
-- Hide (1) or show (0) recipes with missing salvage in the recipe windows
RecipeHideUnowned 0
-- Hide (1) or show (0) unowned recipes in the recipe windows
RecipeHideMissingPartsBench 0
-- Hide (1) or show (0) recipes with missing salvage in the invention workbench
RecipeHideUnownedBench 0
-- Hide (1) or show (0) unowned recipes in the invention workbench
AutoDeclineSuperGroupInvite 0
-- Decline (1) or allow (0) supergroup invites
AutoDeclineTradeInvite 0
-- Decline (1) or allow (0) trade invitations
CamFree 0
-- Disable (0) or allow (1) the camera to move independently of character orientation
ToolTipDelaySec 0.600000
-- How fast tooltips take to display
ShowArchetype 2
-- Show Player archetype, various options
ShowSupergroup 2
-- Show Player supergroup (if applicable), various options
ShowPlayerName 1
-- Show Player names -- Hidden (0), Always (1), On mouse over (2), When selected (4), When selected or on mouseover (6)
ShowPlayerBars 6
-- Show Player health/endurance bars -- Hidden (0), Always (1), On mouse over (2), When selected (4), When selected or on mouseover (6)
ShowVillainName 6
-- Show Enemy Names -- Hidden (0), Always (1), On mouse over (2), When selected (4), When selected or on mouseover (6)
ShowVillainBars 6
-- Show Enemy Health/End Bars -- Hidden (0), Always (1), On mouse over (2), When selected (4), When selected or on mouseover (6)
ShowPlayerReticles 6
-- Show targeting reticles on friendlies, various options
ShowVillainReticles 6
-- Show targeting reticles on enemies, various options
ShowAssistReticles 6
-- Show reticles when targeting through something/someone, various options
ShowOwnerName 0
-- Show Personal Player Name -- Hidden (0), Show always (1)
MousePitchSetting 0
-- What the heck is this one?
MapOptions 0
-- What is displayed on the Map Window, various options
BuffSettings 0
-- Disable (1) or enable (0) sending of buff information (disabling greatly reduces information flow)
ChatBubbleColor1 0
-- Chat balloon text color
ChatBubbleColor2 ffffffff
-- Chat balloon background color
DefaultChatFontSize 12
-- Text size, mostly affects chat windows
MouseButtonReverse 0
-- Mouse buttons: Normal (left-click doors, right click characters for options) (0) or reversed (right click doors, left click characters for options) (1)
DisableCameraShake 0
-- Disable (1) or enable (0) camera shake with certain powers (disabling is good for motion sickness sufferers)
DisableMouseScroll 0
-- Disable (1) or enable (0) scrolling with the mouse wheel
LogPrivateMessages 0
-- Disable (0) or enable (1) /tell logging
ShowPlayerRating 6
-- Show rating, various options
DisableLoadingTips 0
-- Disable (1) or enable (0) helpful hints on loading screens
MouseScrollSpeed 20.000000
-- How fast the mouse wheel will scroll in scrollable windows
EnableJoystick 1
-- Disable (0) or enable (1) the use of joysticks
FadeExtraTrays 0
-- Disable (0) or enable (1) extra trays fading
ArchitectNav 1
-- Regarding the Mission Architect coming in Issue 14
ArchitectToolTips 1
-- Regarding the Mission Architect coming Issue 14
ArchitectAutoSave 1
-- Regarding the Mission Architect coming Issue 14
NoXP 0
-- Disable (1) or enable (0) experience earning
|