-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathREADME.html
More file actions
401 lines (363 loc) · 18.7 KB
/
README.html
File metadata and controls
401 lines (363 loc) · 18.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>KeyQuest User Guide</title>
<style>
:root {
color-scheme: light;
}
body {
font-family: Arial, sans-serif;
font-size: 18px;
line-height: 1.6;
color: #111;
background: #fff;
margin: 0;
padding: 0;
}
a {
color: #0b57d0;
}
a:hover {
text-decoration-thickness: 2px;
}
a:focus-visible,
button:focus-visible,
[tabindex]:focus-visible {
outline: 3px solid #111;
outline-offset: 2px;
}
.skip-link {
position: absolute;
left: 8px;
top: -48px;
z-index: 1000;
background: #fff;
color: #111;
border: 2px solid #111;
padding: 8px 10px;
text-decoration: none;
}
.skip-link:focus {
top: 8px;
}
header,
nav,
main,
footer {
display: block;
}
header,
nav,
footer {
padding: 0 24px;
}
main {
max-width: 900px;
margin: 0 auto;
padding: 24px;
}
.content {
max-width: 75ch;
}
.content-block {
max-width: 75ch;
margin: 0 auto;
}
.hero {
margin: 16px 0 24px;
}
.hero img {
display: block;
width: 100%;
max-width: 960px;
height: auto;
border: 1px solid #d0d7de;
border-radius: 16px;
}
h1, h2, h3 {
line-height: 1.3;
}
h1 {
margin-top: 0;
}
section {
border-top: 1px solid #ddd;
padding-top: 16px;
margin-top: 16px;
}
ul,
ol {
padding-left: 20px;
}
.note {
background: #f4f4f4;
border-left: 4px solid #666;
padding: 10px;
}
</style>
</head>
<body>
<a class="skip-link" href="#main-content">Skip to main content</a>
<header>
<div class="content-block">
<h1>KeyQuest User Guide</h1>
<p><strong>Version {{APP_VERSION}}</strong></p>
<p>This guide is written for all users, including screen reader and keyboard-only users.</p>
<div class="hero">
<img
src="docs/assets/keyquest-hero.svg"
alt="KeyQuest banner showing the KeyQuest name and describing it as an accessible typing adventure game for Windows with keyboard, screen reader, and low-vision support.">
</div>
</div>
</header>
<nav aria-label="Page sections">
<div class="content-block">
<h2>On This Page</h2>
<ul>
<li><a href="#welcome">Welcome</a></li>
<li><a href="#quick-start">Quick Start</a></li>
<li><a href="#main-menu">Main Menu Sections</a></li>
<li><a href="#custom-sentences">Using Your Own Sentences</a></li>
<li><a href="#downloads">Downloads</a></li>
<li><a href="#accessibility">Accessibility</a></li>
<li><a href="changelog.html">New in Key Quest</a></li>
<li><a href="#help">Need Help</a></li>
<li><a href="#license">License</a></li>
<li><a href="#unsigned-build">Unsigned Build Notice</a></li>
</ul>
</div>
</nav>
<main id="main-content" class="content">
<section id="welcome">
<h2>Welcome</h2>
<p>
KeyQuest is a typing practice program you can use with your keyboard only.
It gives speech and visual feedback so you can practice in the way that works best for you.
</p>
<p>
It includes guided lessons, practice modes, typing tests, games, progress tracking, and a virtual pet.
</p>
<p>
Want a quick list of recent changes? Open <a href="changelog.html">New in Key Quest</a>.
</p>
</section>
<section id="quick-start">
<h2>Quick Start</h2>
<ol>
<li>Open KeyQuest.</li>
<li>Use the <strong>Up</strong> and <strong>Down</strong> arrow keys to move through menu items.</li>
<li>Press <strong>Enter</strong> or <strong>Space</strong> to open a section.</li>
<li>In active practice or gameplay modes, press <strong>Escape 3 times</strong> to return to Main Menu. On the Main Menu, press <strong>Escape 3 times</strong> to quit. The remaining press count is shown on screen and announced by speech.</li>
</ol>
<p class="note">
Press <strong>Ctrl+Space</strong> in typing modes to hear the current prompt or remaining text. Sentence typing must match capitalization and punctuation exactly.
</p>
</section>
<section id="main-menu">
<h2>Main Menu Sections</h2>
<h3>Tutorial</h3>
<p>Start here if you are new. It teaches key locations step by step.</p>
<h3>Keyboard Explorer</h3>
<p>Press keys and hear what they are, where they are, and how they are commonly used. Home-row keys also include short orientation help where it matters, including the F and J bumps.</p>
<h3>Lessons</h3>
<p>Structured typing lessons that gradually add more keys as you improve. Longer lesson text wraps on screen, and lesson intros can now be reviewed one item at a time with the arrow keys instead of being read all at once.</p>
<h3>Free Practice</h3>
<p>Practice learned keys without affecting lesson progression. You can now choose from your unlocked lessons first, so Free Practice matches the key range you have already reached.</p>
<h3>Speed Test</h3>
<p>Choose a time limit and test your typing speed and accuracy. Type each sentence exactly as shown, including capitalization and punctuation.</p>
<h3>Sentence Practice</h3>
<p>Type sentences for ongoing practice. Type each sentence exactly as shown, including capitalization and punctuation. If you make a mistake, KeyQuest spells the first missed word and then reads the rest of the sentence normally. Topics include General, General Spanish, Windows commands, JAWS commands, NVDA commands, science facts, history, geography, math, literature, and vocabulary. You can also edit sentence files or add your own. For Spanish typing, you can enter common accented characters from an English keyboard with shortcuts such as <strong>Ctrl+'</strong> then a vowel for acute accents, <strong>Ctrl+`</strong> then <strong>n</strong> for <strong>ñ</strong>, and <strong>Ctrl+Shift+/</strong> for <strong>¿</strong>.</p>
<h3>Games</h3>
<p>Play typing games with speech and visual feedback.</p>
<ul>
<li><strong>Letter Fall</strong>: Type one active target letter at a time before it reaches the bottom. <strong>Tab</strong> reports the current target and how many letters are waiting. <strong>Ctrl+Space</strong> repeats only the current target.</li>
<li><strong>Word Typing</strong>: Type words quickly and submit each word. <strong>Ctrl+Space</strong> repeats only the current word.</li>
<li><strong>Hangman</strong>: Guess words letter by letter with an offline dictionary of over 919,000 words and real definitions.</li>
</ul>
<h3>Quests</h3>
<p>See active goals and completed goals.</p>
<h3>Pets</h3>
<p>View and care for your virtual pet. Pets react to your progress.</p>
<h3>Pet Shop</h3>
<p>Spend coins on pet food, toys, and pet accessories.</p>
<h3>Badges</h3>
<p>Review your earned badges and locked badges.</p>
<h3>Progress Dashboard</h3>
<p>See your overall practice history and performance trends.</p>
<h3>Practice Log</h3>
<p>Review recent sessions in plain language with readable dates, times, durations, activity names, results, and earned rewards. You can also copy the log to the clipboard.</p>
<h3>Daily Challenge</h3>
<p>Check and complete the current daily challenge.</p>
<h3>Key Performance</h3>
<p>See which keys are easiest or hardest for you.</p>
<h3>Options</h3>
<p>Customize how the app sounds and looks. Settings are saved automatically.</p>
<ul>
<li><strong>Speech</strong>: Choose automatic, screen reader, text-to-speech, or off.</li>
<li><strong>Typing Sounds</strong>: Set keystroke sound intensity to subtle, normal, or strong.</li>
<li><strong>TTS Rate</strong>: Adjust text-to-speech speaking speed.</li>
<li><strong>TTS Volume</strong>: Adjust text-to-speech volume.</li>
<li><strong>TTS Voice</strong>: Choose a different installed voice for text-to-speech.</li>
<li><strong>Automatic Updates</strong>: Turn startup update checks on or off. When enabled in the installed Windows app, KeyQuest checks GitHub releases for a newer installer.</li>
<li><strong>Visual Theme</strong>: Switch between dark, light, or high contrast. High contrast is applied automatically if Windows High Contrast mode is active.</li>
<li><strong>Focus Assist</strong>: Turn stronger visual emphasis on or off. When enabled, KeyQuest uses stronger panels and focus cues to make the active area easier to find.</li>
<li><strong>Practice Topic</strong>: Choose the sentence language for Speed Test and Sentence Practice.</li>
<li><strong>Font Size</strong>: Choose <em>auto</em> (matches your Windows display scale), 100%, 125%, 150%, 175%, or 200%. Useful on high-DPI or low-vision setups that need larger text.</li>
</ul>
<h3>Learn Sounds</h3>
<p>Listen to built-in sounds and learn what each one means.</p>
<h3>Check for Updates</h3>
<p>Available near the bottom of the Main Menu, just above Key Quest Instructions. KeyQuest checks for a newer release, downloads the right update for your copy from the official GitHub Releases page, installs it quietly or updates the portable folder in place, and then restarts automatically. If updating fails, KeyQuest writes a local error log, tries to copy that log to the clipboard, and offers the setup download. Installed-copy updates now wait for the old app process by PID before starting the installer, which makes the close-and-reopen step more reliable.</p>
<h3>Key Quest Instructions</h3>
<p>Open this user guide in your default web browser from inside the program.</p>
<h3>New in Key Quest</h3>
<p>Open the online What's New page in your default web browser to read recent changes in plain language.</p>
<h3>About</h3>
<p>View application, creator, company, copyright, and license details, open the official website, or open the KeyQuest donation page.</p>
<ul>
<li><strong>Application</strong>: KeyQuest {{APP_VERSION}}</li>
<li><strong>Release Date</strong>: 2026-02-19</li>
<li><strong>Name</strong>: Casey Mathews</li>
<li><strong>Company</strong>: Web Friendly Help LLC</li>
<li><strong>Tagline</strong>: Helping You Tame Your Access Technology</li>
<li><strong>Copyright</strong>: (c) 2026 Casey Mathews and Web Friendly Help LLC</li>
<li><strong>License</strong>: MIT (free to use, modify, and distribute)</li>
<li><strong>Website</strong>: webfriendlyhelp.com (press Enter on Website item to open)</li>
<li><strong>Official Downloads</strong>: GitHub Releases is the official source for KeyQuest downloads and updates. Other builds or download pages are not official KeyQuest releases.</li>
<li><strong>Donate</strong>: <a href="https://square.link/u/XfI4Icmm">Support KeyQuest</a></li>
</ul>
<h3>Quit</h3>
<p>Close the program.</p>
</section>
<section id="custom-sentences">
<h2>Using Your Own Sentences</h2>
<p>
KeyQuest can use your own sentence files. This is useful if you want to practice class material, job vocabulary, assistive technology commands, bilingual content, or your own Spanish sentences.
</p>
<p>
Open the <code>Sentences</code> folder next to <code>KeyQuest.exe</code>. Each text file in that folder becomes a practice topic. For example, a file named <code>My Spanish Practice.txt</code> will appear as a topic named <strong>My Spanish Practice</strong>.
</p>
<p>
Put one sentence on each line. You can either create a new text file or edit one of the existing files already in the <code>Sentences</code> folder.
</p>
<p>
For example, you can open an existing file such as <code>Spanish Sentences.txt</code> or <code>English Sentences.txt</code> and add, remove, or change lines. You can also create a new file for a class, student, workplace, or skill area. This is an easy way to make practice feel more personal and more useful.
</p>
<p>
KeyQuest cleans sentence files when it loads them. It keeps real language letters such as Spanish accents, but it removes copy-and-paste junk such as odd spacing, emoji, hidden characters, duplicate lines, and common broken text encoding. The cleaned sentences are saved back to the file automatically.
</p>
<p>
Use plain text and end each sentence with normal punctuation such as a period, question mark, or exclamation point.
</p>
<p class="note">
KeyQuest keeps user-added sentence files during updates. If a built-in sentence file is updated, KeyQuest merges the built-in and user content without keeping exact duplicate lines.
</p>
</section>
<section id="downloads">
<h2>Downloads</h2>
<p>
You can download KeyQuest in two simple forms. If you are not sure which one to choose, start with the installer.
</p>
<h3>Installer</h3>
<p>
The installer sets KeyQuest up for you. It puts the program in the usual place on your computer and adds shortcuts.
This is the easiest choice for most people.
</p>
<p>
<a href="https://github.com/WebFriendlyHelp/KeyQuest/releases/latest/download/KeyQuestSetup.exe">Download KeyQuest Installer.exe</a>
</p>
<h3>Portable</h3>
<p>
The portable version is a zip file. You download it, unzip it, open the folder, and run <code>KeyQuest.exe</code>.
Choose this if you want to keep KeyQuest in one folder, copy it to another computer, or avoid a full installation.
</p>
<p>
<a href="https://github.com/WebFriendlyHelp/KeyQuest/releases/latest/download/KeyQuest-win64.zip">Download KeyQuest Portable.zip</a>
</p>
<p class="note">
Official KeyQuest downloads are published on GitHub Releases. The in-app updater uses those releases. Other builds, mirrors, or repackaged copies are not official KeyQuest releases.
</p>
<p class="note">
Both versions can check for updates from inside KeyQuest. The installer updates the installed app. The portable version updates the portable folder in place.
</p>
</section>
<section id="license">
<h2>License</h2>
<p>
KeyQuest is licensed under the <strong>MIT License</strong>.
See the <code>LICENSE</code> file for full terms.
</p>
</section>
<section id="accessibility">
<h2>Accessibility</h2>
<ul>
<li>Keyboard-only navigation</li>
<li>Screen reader and TTS support</li>
<li>Visual focus indicators and clear labels</li>
<li>Long prompts and typed text wrap across multiple lines on typing and lesson screens instead of being forced onto one line</li>
<li>Long menus keep the current selection in view more clearly and show when there are more items above or below</li>
<li>Consistent repeat commands in typing contexts (<strong>Ctrl+Space</strong>)</li>
<li>Windows High Contrast mode is detected automatically when your theme is set to Auto</li>
<li>Font size scaling: <em>auto</em> reads your Windows display scaling; manual 100%, 125%, 150%, 175%, and 200% options are also available</li>
<li>The app window can be resized and tries to maximize on startup, so larger text has more room to stay on screen</li>
<li>Visual keystroke feedback: brief green flash on correct key, red flash on error (deaf or hard-of-hearing users)</li>
<li>Escape press counter shown on screen while exiting active modes</li>
<li>Optional Focus Assist mode for stronger active-area emphasis on typing and setup screens</li>
<li>Stronger spacing and grouping on text-heavy screens so the active area is easier to spot</li>
<li>Shared layout handling now keeps menus and current game screens more stable at larger font sizes and live window sizes</li>
<li>Built-in larger text options up to 200% for low-vision readability</li>
<li>Hands-off in-app updating for installed and portable Windows builds using GitHub Releases</li>
<li>This page uses clear headings, skip navigation, and visible keyboard focus</li>
</ul>
</section>
<section id="help">
<h2>Need Help</h2>
<p>
If something sounds wrong or a control does not behave as expected,
share the section name and exact key presses.
That helps fix issues quickly.
</p>
<ul>
<li><strong>Website</strong>: <a href="https://webfriendlyhelp.com">Web Friendly Help website</a></li>
<li><strong>Donate</strong>: <a href="https://square.link/u/XfI4Icmm">Support KeyQuest</a></li>
<li><strong>Feedback Email</strong>: <a href="mailto:help@webfriendlyhelp.com?subject=KeyQuest%20Feedback">help@webfriendlyhelp.com</a></li>
<li><strong>Bug Reports</strong>: If an in-app update or unexpected error fails, KeyQuest saves a local error log, tries to copy it to the clipboard automatically, and tells you where it was saved.</li>
<li><strong>Official Builds</strong>: Download KeyQuest from the GitHub Releases page. Other builds or download pages are not official KeyQuest releases.</li>
</ul>
</section>
<section id="unsigned-build">
<h2>Unsigned Build Notice</h2>
<p>
Current KeyQuest builds may be unsigned. On Windows, SmartScreen may show a warning.
</p>
<ol>
<li>When the warning appears, select <strong>More info</strong>.</li>
<li>Select <strong>Run anyway</strong> if you trust the release source.</li>
</ol>
<p>
For safety, download only from the official GitHub release page.
</p>
</section>
<section id="installer">
<h2>Installer</h2>
<p>
KeyQuest can be distributed as a standard Windows installer (<code>KeyQuestSetup.exe</code>) built from the app package.
</p>
<p>
Installer builds are currently unsigned, so SmartScreen warnings may still appear. Both installed and portable Windows builds can update themselves from the official GitHub Releases page.
</p>
<p>
During self-update, KeyQuest preserves <code>progress.json</code>. Sentence files are merged during updates so user-added lines and new shipped lines are both kept without exact duplicate entries.
</p>
</section>
</main>
<footer>
<div class="content-block">
<p>End of KeyQuest User Guide.</p>
</div>
</footer>
</body>
</html>