j/Mind_Reader
1
0
Fork 0
mirror of https://github.com/We-Dont-Byte/Mind_Reader.git synced 2024-11-15 03:35:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
My Capstone project, continuing an earlier team's work on making VSCode more accessible. I created a ton of documentation for the project, including a Wiki, to aid in onboarding the team that came after us.
133 Commits 12 Branches 2 Tags 678 KiB
TypeScript 79.4%
PowerShell 12.1%
Shell 5.2%
HTML 3.3%
9265a05483
Go to file
Simon Maceda 9265a05483
Small update to tsconfig and README
2022-08-12 12:42:03 -05:00
.github/workflows Improve github actions CI 2022-05-05 18:44:50 -05:00
.vscode Integrate Parser (#4) 2021-10-26 12:48:04 -05:00
media Added Screenshot 2022-05-09 10:34:10 -05:00
setup-development TODO: Remove this when merging (OOPS!) 2022-05-10 14:10:02 -05:00
src line missing 2022-05-09 09:01:35 -05:00
.eslintrc.json Initial commit 2021-09-25 16:18:41 -05:00
.gitignore Update .gitignore 2022-04-09 21:14:56 -05:00
.vscodeignore "No newline at end of file" 2022-05-09 20:07:34 -05:00
package-lock.json Update Mocha to version 10.0.0 2022-05-07 21:29:59 -05:00
package.json Provide more descriptive group names for menu. 2022-05-07 23:49:13 -05:00
README.md Reference developer install guide instead of the confusing mess 2022-05-10 14:11:18 -05:00
tsconfig.json Small update to tsconfig and README 2022-08-12 12:42:03 -05:00

README.md

Mind Reader Logo

Mind Reader

The current editor options available lack the level of accessibility that is required to allow people who are visually impaired to adequately write, edit, and debug code.

This tool extends Visual Studio Code’s existing accessibility options to enable people with a visual impairment to learn Python programming with LEGO Mindstorms. Our goal is to:

  • provide an accessible experience to people with a visual impairment

  • not change the editing workflow for people without a visual impairment

Major Features

  • Compatible with major screen readers:

  • Present a summary of the scope for an individual line of code.

  • Save, Load, Run, and Delete programs directly onto the LEGO SPIKE Prime Hub from within Visual Studio Code

  • Line highlighting with customizable colors and formats

First Time Setting Up the Line Highlighter Feature

Before running Mind Reader for the first time it is recommended to add the following code block to your settings.json file

Opening Settings.json

  1. Launch VS Code
  2. Open the Command Palette by pressing Ctrl + Shift + P (Windows) / Cmd + Shift + P (Mac)
  3. The Command Palette should appear at the top of your screen ready for you to type
  4. Type settings and highlight the option that appears saying Preferences: Open Settings (JSON) then select it
  5. Your settings.json window should appear, scroll to the bottom and make sure the last item has a , before the closing curly bracket }
  6. Paste the following code block after the last comma ,, but before the closing curly bracket }:
    "mind-reader.lineHighlighter.isEnabled"          : true,
    "mind-reader.lineHighlighter.multiLineIsEnabled" : false,

    "mind-reader.lineHighlighter.backgroundColor"    : "#232C5C",

    "mind-reader.lineHighlighter.outlineColor"       : "#4866FE",
    "mind-reader.lineHighlighter.outlineWidth"       : "1px",
    "mind-reader.lineHighlighter.outlineStyle"       : "solid",

    "mind-reader.lineHighlighter.borderColorTop"     : "#FFFFFF",
    "mind-reader.lineHighlighter.borderColorRight"   : "#FFFFFF",
    "mind-reader.lineHighlighter.borderColorBottom"  : "#FFFFFF",
    "mind-reader.lineHighlighter.borderColorLeft"    : "#FFFFFF",

    "mind-reader.lineHighlighter.borderWidthTop"     : "1px",
    "mind-reader.lineHighlighter.borderWidthRight"   : "16px",
    "mind-reader.lineHighlighter.borderWidthBottom"  : "1px",
    "mind-reader.lineHighlighter.borderWidthLeft"    : "1px",

    "mind-reader.lineHighlighter.borderStyleTop"     : "solid",
    "mind-reader.lineHighlighter.borderStyleRight"   : "solid",
    "mind-reader.lineHighlighter.borderStyleBottom"  : "solid",
    "mind-reader.lineHighlighter.borderStyleLeft"    : "solid",

    "mind-reader.lineHighlighter.fontStyle"          : "normal",
    "mind-reader.lineHighlighter.fontWeight"         : "bolder",
    "mind-reader.lineHighlighter.textDecoration"     : "none",
    "mind-reader.lineHighlighter.textColor"          : "#FFFFFF",

The values are set to the default values and can be changed here manually, or through the settings window (File -> Preferences -> Settings -> Mind Reader -> Line Highlighter). Changes made directly in the settings.json will take effect automatically; however, if you change them in the settings window then after you input your new values VS Code must be closed and reopened for the changes to take effect.

After adding the code block, the settings.json file should look similar to this:

line highlighter first time setup

  1. Save and close settings.json

Line Highlighter Settings Table

Item Description Accepted Value Default Values
isEnabled Enable/Disables the line highlighter boolean true
multiLineIsEnabled Highlight when clicking and dragging to select lines boolean false
backgroundColor Changes the background color of the highlight HEX(A), RGB(A), HSL(A), Predefined Color String, or "none" "#232C5C"
outlineColor Outline Color HEX(A), RGB(A), HSL(A), Predefined Color String, or "none" "#4866FE"
outlineWidth Outline Width "medium", "thin", "thick", length (integer + string unit), or "none" "1px"
outlineStyle Outline Style none, hidden, dotted, dashed, solid, double, groove, ridge, inset, or outset "solid"
borderColorTop Top Border Color HEX(A), RGB(A), HSL(A), Predefined Color String, or "none" "#FFFFFF"
borderColorRight Right Border Color HEX(A), RGB(A), HSL(A), Predefined Color String, or "none" "#FFFFFF"
borderColorBottom Bottom Border Color HEX(A), RGB(A), HSL(A), Predefined Color String, or "none" "#FFFFFF"
borderColorLeft Left Border Color HEX(A), RGB(A), HSL(A), Predefined Color String, or "none" "#FFFFFF"
borderWidthTop Top Border Width "medium", "thin", "thick", length (integer + string unit), or "none" "1px"
borderWidthRight Right Border Width "medium", "thin", "thick", length (integer + string unit), or "none" "16px"
borderWidthBottom Bottom Border Width "medium", "thin", "thick", length (integer + string unit), or "none" "1px"
borderWidthLeft Left Border Width "medium", "thin", "thick", length (integer + string unit), or "none" "1px"
borderStyleTop Top Border Style none, hidden, dotted, dashed, solid, double, groove, ridge, inset, or outset "solid"
borderStyleRight Right Border Style none, hidden, dotted, dashed, solid, double, groove, ridge, inset, or outset "solid"
borderStyleBottom Bottom Border Style none, hidden, dotted, dashed, solid, double, groove, ridge, inset, or outset "solid"
borderStyleLeft Left Border Style none, hidden, dotted, dashed, solid, double, groove, ridge, inset, or outset "solid"
fontStyle Styling to the font contained within the highlight "normal", "italic", "oblique", or "none" "normal"
fontWeight Weight of the font contained within the highlight "normal", "bold", "bolder", "lighter", string based number, "none" "bolder"
textDecoration Decoration of the font contained within the highlight See: https://www.w3schools.com/cssref/pr_text_text-decoration.asp "none"
textColor Color of the font contained within the highlight HEX(A), RGB(A), HSL(A), Predefined Color String, or "none" "#FFFFFF"

For Developers

Developer Dependencies

Development environment setup guide

Windows 10 or 11

  • Download install-windows.ps1
  • Run ./install-windows.ps1 in PowerShell as a normal user, and accept any UAC prompts that pop up. The installation should take around 8 minutes. If an installer doesn't pop up, don't be alarmed.

For other platforms, or to install the extension manually, check out our Developer Install Guide. This is also where you should search if you encounter errors.

See the Visual Studio Code getting started API page if you need more help.

Contact Information

Single Semester Snobs

Fall 2021 Semester

We Don't Byte

Spring 2022 Semester