Accessibility: Difference between revisions

From Vintage Story Wiki
updated for 1.19.4 while removing mention of the game version other than in the History section
m (improved readability of this subsection with line breaks and punctuation)
(updated for 1.19.4 while removing mention of the game version other than in the History section)
Line 1: Line 1:
{{WIP}}
{{GameVersion|1.19.4}}
{{GameVersion|1.19.0-pre1}}


== Settings menu ==
== Settings menu ==
Line 12: Line 11:
<br>
<br>
The [[Settings]] page should cover all the features in the [[Settings#Graphics|Graphics]] tab in detail.
The [[Settings]] page should cover all the features in the [[Settings#Graphics|Graphics]] tab in detail.
<br>
<br>
<br>
<br>
<br>
<br>
Line 19: Line 16:


=== Mouse tab ===
=== Mouse tab ===
[[File:Settings-mouse tab.png|thumb|left|alt=the second tab of several at the top is selected, displaying an array of options for the game's mouse features|Mouse tab of Settings menu]]
[[File:Settings-mouse_tab.png|thumb|left|alt=the second tab of several at the top is selected, displaying an array of options for the game's mouse features|Mouse tab of Settings menu]]
* '''Item collect mode''': Check this box to reduce the need to use the Shift key.
* '''Mouse sensitivity''': Increase to heighten cursor movement, reducing the need to move the mouse/wrist.  Decrease to soften cursor movement, allowing easier precision of cursor placement.
<br>
* '''Mouse wheel sensitivity''': Currently no apparent benefit.
<br>
* '''Item collect mode''': Select the "Always" option to reduce the need to use the {{Keypress|Shift}} key.
<br>
* '''Mouse Controls''': Click on a mouse action, and then use the mouse button or keyboard key you would like to perform that mouse action.  Additionally, you can rebind keyboard controls to a mouse button in the [[Accessibility#Controls_tab|Controls tab]].  For multi-button mice, up to 5 additional buttons are supported.
<br>
<br>
<br>
<br>
<br>
<br>
Line 34: Line 29:


=== Controls tab ===
=== Controls tab ===
Any key used in the game can be rebound to something different, which may be important for some players: in general, everyone playing the game for extended periods should set the keys to bindings which are comfortable to use -- also, take breaks! 
[[File:Settings-controls tab.png|thumb|left|alt=the third tab of several at the top is selected, displaying a list of the keys bound to various game actions|Controls tab of Settings menu]]
[[File:Settings-controls tab.png|thumb|left|alt=the third tab of several at the top is selected, displaying a list of the keys bound to various game actions|Controls tab of Settings menu]]
Any key used in the game can be rebound to something different, which may be important for some players: in general, everyone playing the game for extended periods should set the keys to bindings which are comfortable to use (and take breaks!)  As of game version 1.19.4, you can also configure any control to be a mouse button, including up to 5 extra buttons for multi-button gaming mice.
* '''Toggle Sprint''': [in game version 1.19, this setting is now found on the Accessibility tab] Check this box to reduce the need to use the [[Controls#Movement_controls|Sprint key]].  Tap Sprint once while walking to begin running; your character will continue running without keeping the Sprint key pressed, until you stop moving forward.  When you move again it will be at a walking pace.
* '''Mouse modifiers locked to Sneak/Sprint''': Several mouse actions in-game require a combination of either the {{Keypress|Shift}} key or the {{Keypress|Ctrl}} key, as well as a mouseclick (left or right mouse button) - for example, placing down buckets requires both {{Keypress|Shift}} and {{Keypress|Ctrl}}.  By default, the Shift key is the key used for [[Controls#Movement controls|Sneak]], and the Ctrl key is used for [[Controls#Movement controls|Sprint]], and if you are happy with those defaults then this setting is probably not going to be relevant to you. But if you want to change Sneak to a different key, then it becomes important: by default (locked), changing the Sneak control has the effect of changing the key which has to be pressed for Shift + mouseclick actions as well.  Some people like that (thinking of it as "Sneak + mouseclick"), some people don't like that at all (they want to change the control for Sneak without changing the normal Shift + mouseclick control ...)  If you are one of the people who wants to reconfigure Sneak ''without'' reconfiguring the {{Keypress|Shift}} key, then unlocking mouse modifiers means you can keep on using {{Keypress|Shift}} as the Shift key for mouseclicks as normal, even though the Sneak key has changed to something different. Or, if you like, you can leave the Sneak key as it is but change only the key used as the Shift key for mouseclicking. The same applies to the {{Keypress|Ctrl}} key and Sprint which are locked together by default - for example, use this setting if you want to change the Sprint key to {{Keypress|Q}} or {{Keypress|R}} (some people find that more comfortable) but keep on using the {{Keypress|Ctrl}} key for Ctrl + mouse clicks.
* '''Mouse modifiers locked to Sneak/Sprint''': Several mouse actions in-game require a combination of either the {{Keypress|Shift}} key or the {{Keypress|Ctrl}} key, as well as a mouseclick (left or right mouse button) - for example, placing down buckets requires both {{Keypress|Shift}} and {{Keypress|Ctrl}}.  By default, the Shift key is the key used for [[Controls#Movement controls|Sneak]], and the Ctrl key is used for [[Controls#Movement controls|Sprint]], and if you are happy with those defaults then this setting is probably not going to be relevant to you. But if you want to change Sneak to a different key, then it becomes important: by default (locked), changing the Sneak control has the effect of changing the key which has to be pressed for Shift + mouseclick actions as well.  Some people like that (thinking of it as "Sneak + mouseclick"), some people don't like that at all (they want to change the control for Sneak without changing the normal Shift + mouseclick control ...)  If you are one of the people who wants to reconfigure Sneak ''without'' reconfiguring the {{Keypress|Shift}} key, then unlocking mouse modifiers means you can keep on using {{Keypress|Shift}} as the Shift key for mouseclicks as normal, even though the Sneak key has changed to something different. Or, if you like, you can leave the Sneak key as it is but change only the key used as the Shift key for mouseclicking. The same applies to the {{Keypress|Ctrl}} key and Sprint which are locked together by default - for example, use this setting if you want to change the Sprint key to {{Keypress|Q}} or {{Keypress|R}} (some people find that more comfortable) but keep on using the {{Keypress|Ctrl}} key for Ctrl + mouse clicks.
People who use the mouse in their '''left hand''' might like to change these settings to use the right-hand side {{Keypress|R Shift}} and {{Keypress|R Ctrl}} keys on the keyboard for Shift + mouse click and Ctrl + mouse click actions.
People who use the mouse in their '''left hand''' might like to change these settings to use the right-hand side {{Keypress|R Shift}} and {{Keypress|R Ctrl}} keys on the keyboard for Shift + mouse click and Ctrl + mouse click actions.
Line 44: Line 38:


=== Accessibility tab ===
=== Accessibility tab ===
[[File:Accessibility-119-pre1.png|thumb|left|alt=the fourth tab of several at the top is selected, displaying a few options thought to be most relevant to users in need of accommodations|Accessibility tab of Settings menu]]
[[File:Settings-accessibility tab.png|thumb|left|alt=the fourth tab of several at the top is selected, displaying a few options thought to be most relevant to users in need of accommodations|Accessibility tab of Settings menu]]
Options:
Options:
* '''Toggle Sprint''': Check this box to reduce the need to use the [[Controls#Movement_controls|Sprint key]].  Tap Sprint once while walking to begin running; your character will continue running without keeping the Sprint key pressed, until you stop moving forward.  When you move again it will be at a walking pace.
* '''Toggle Sprint''': Check this box to reduce the need to use the [[Controls#Movement_controls|Sprint key]].  Tap Sprint once while walking to begin running; your character will continue running without keeping the Sprint key pressed, until you stop moving forward.  When you move again it will be at a walking pace.
* '''View Bobbing''': Uncheck this box if you tend to experience motion sickness.  With view bobbing enabled, your character's field of view would bounce up and down while (s)he runs.
* '''View Bobbing''': Uncheck this box if you tend to experience motion sickness.  With view bobbing enabled, your character's field of view would bounce up and down while (s)he runs.
* '''Camera shake strength''': When your character's body temperature drops dangerously low, (s)he will begin shivering and the edges of the screen will become frosty.  Increasing the ''Camera shake strength'' slider should reduce the degree to which the character's view is disrupted.  You'll need to use other indicators such as the frosty screen to warn you of low body temperature.  Your character will begin losing health points if you don't take steps to raise her/his body temperature.
* '''Camera shake strength''': When your character's body temperature drops dangerously low, (s)he will begin shivering and the edges of the screen will become frosty.  Increasing the ''Camera shake strength'' slider should reduce the degree to which the character's view is disrupted.  You'll need to use other indicators such as the frosty screen to warn you of low body temperature.  Your character will begin losing health points if you don't take steps to raise her/his body temperature.
* '''Wireframe thickness''': This affects the thickness of the selection box drawn around the block you are looking at.  It also affects the colored voxel gridlines seen when knapping, clay-forming and smithing. Some people may find thicker lines easier to see - especially on very high resolution monitors eg. 4k monitors.
* '''Wireframe thickness''': This affects the thickness of the selection box drawn around the block you are looking at.  It also affects the colored voxel gridlines seen when knapping, clay-forming, smithing, and chiseling. Some people may find thicker lines easier to see - especially on very high resolution monitors eg. 4k monitors.
* '''Wireframe colors''': From game version 1.19.4, the game offers two alternative color presets which can be used in place of the green/orange voxel grid seen when clay-forming and knapping stone, and when smithing metals; these may help visibility of the different grid colors with certain forms of colorblindness or color vision anomaly.
* '''Wireframe colors''': This determines the colors for the voxel wireframe gridlines when knapping, clayforming, or smithing.  Changing to Preset 2 or Preset 3 may improve color contrast for various types of colorblindness or color vision anomaly.
* '''Glitch strength waviness''': [[Temporal_storm|Temporal Storms]] can be disabled entirely through commands.  It might be preferable to preserve this feature of the game while removing effects that are uncomfortable.  Reducing the ''Glitch strength waviness'' slider should make visual distortions during storms more tolerable.  Expect the normal colors of the world to become reddish until the storm ends.  (Those feeling experimental can even ''increase'' the Glitch strength waviness to more than 100%.)
* '''Glitch strength waviness''': [[Temporal_storm|Temporal Storms]] can be disabled entirely through [[World_Configuration#Temporal_stability|commands]].  It might be preferable to preserve this feature of the game while removing effects that are uncomfortable.  Reducing the ''Glitch strength waviness'' slider should make visual distortions during storms more tolerable.  Expect the normal colors of the world to become reddish until the storm ends.   
<br>
<br>


Line 79: Line 73:


== Mods ==  
== Mods ==  
The modding community for Vintage Story has produced several excellent mods that might help with one or more Accessibility issues.  Examples of useful mods are listed under the Visual, Dexterity and Auditory headings below.
The modding community for Vintage Story has produced several excellent mods that might help with one or more Accessibility issues.  Examples of useful mods are listed under the [[Accessibility#Visual|Visual]], [[Accessibility#Dexterity_and_repetitive_actions|Dexterity]] and [[Accessibility#Auditory|Auditory]] headings below.


General guidance for using mods:
General guidance for using mods:
* It's generally safe to add/remove convenience mods even after playing a world for awhile.  But best practice includes creating a backup before changing mods.  (If a mod adds blocks, items, entities, or new worldgen, a backup may be more important.)
* It's generally safe to add/remove mods even after playing a world for awhile.  But best practice includes creating a backup before changing mods.  If a mod adds blocks, items, entities, or new worldgen, a backup may be more important.
* Mods are specific to game versions. If you update the game it's worth checking your favorite mods to see if they have also been updated (which is up to the individual mod authors).  A mod that hasn't been specifically updated for your current game version can sometimes still work or mostly work, it is always worth trying this.  Again, back up your world before experimenting.
* Mods are compatible with specific game versions. If you update the game, [https://mods.vintagestory.at/list/mod check] your favorite mods to see if they have also been updated (which is up to the individual mod authors).  A mod that hasn't been specifically updated for your current game version can often still work or mostly work.  Again, create a backup of your world before experimenting.
* Code mods - especially if not updated for the current game version or only recently updated - can cause issues or crashes (either directly, or more subtly if they prevent another game system from working properly; also check client-main and server-main logs for reported errors)Test them out and report any issues direct to the mod author.   
* [[Modding:Getting_Started#Types_of_Mods|Code mods]] - especially if not updated for the current game version or only recently updated - can cause issues or crashes (either directly, or more subtly if they prevent another game system from working properly).  Check client-main.txt and server-main.txt logs for reported errors.  Report issues to the mod author rather than to Vintage Story staff.   
* In single player games, mods are installed by downloading them and then dragging and dropping to your Vintagestory Mods folder. On a Windows PC, the Mods folder is found at %appdata%\Vintagestory\Mods. Alternatively, a mod's download page may offer '1-click install'.
* In single player games, mods are installed by downloading them and then dragging the zip file into to your VintagestoryData Mods folder. On a Windows PC, the Mods folder is found at %appdata%\VintagestoryData\Mods by default. The mod database has a '1-click install' feature that puts the zip file directly into the Mods folder rather than the Downloads folder; this only applies to the most-recently-published version of the mod, though.
* In multiplayer games, when you join a server, the required mods are automatically downloaded to a specific folder for that server, kept separate from your single-player mod folder (in your Mods folder, the main folder is for single-player and the game creates a subfolder for each multiplayer server).  To also use one of your single-player client-side mods in multiplayer, copy-paste it into that server's subfolder.  Several accessibility mods are client-side only, meaning that you can use them even on multiplayer servers without causing problems.  Other mods require the server admins to install them, if you want to see them in a multiplayer game.
* When you join a multiplayer server, the required mods are automatically downloaded to a specific subfolder for that server, within your single-player mod folder.  To also use one of your single-player client-side mods in multiplayer, copy-paste it into that server's subfolder.  Several accessibility mods are client-side only, meaning that you can use them even on multiplayer servers without causing problems.  Some mods would require the server admins to install them.


== Visual ==
== Visual ==
Line 245: Line 239:
** Tweak: Added ability to adjust temporal instability waviness in the new Accessibility tab
** Tweak: Added ability to adjust temporal instability waviness in the new Accessibility tab
** Tweak: Added experimental minbrightness client config, potential use for YouTubers/streamers to prevent pitch-black areas."  [https://www.vintagestory.at/blog.html/news/v1190-pre1-dejank-redux-r367/ Official Devlog]
** Tweak: Added experimental minbrightness client config, potential use for YouTubers/streamers to prevent pitch-black areas."  [https://www.vintagestory.at/blog.html/news/v1190-pre1-dejank-redux-r367/ Official Devlog]
** Feature: In the Accessibility settings tab, knapping, clayforming, smithing voxel wireframe colors are now configurable between different presets. In addition to the standard setting, two alternative presets for these colors are provided, chosen for better contrast for players with certain types of color blindness (color vision anomaly) [https://www.vintagestory.at/blog.html/news/v1194-stableified-glue-r380/ Official Devlog]
** Feature: Re-bindable mouse buttons [https://www.vintagestory.at/blog.html/news/v1194-stableified-glue-r380/ Official Devlog]


== Notes ==
== Notes ==
Confirmedusers, editor
1,284

edits