Readme.md

Typist.pk3

YouTube

Typist.pk3 is a mod for Doom engine games that turns them into typing exercises.

There are several lessons, including user-defined lessons.

How To Play

Load it with GZDoom.

There are two game modes: Combat and Exploration. They are switched automatically.

Exploration Mode (blue)

Your familiar mode. You can walk, open doors, turn switches, etc.

Combat Mode (red)

This mode is for fighting enemies. Instead of aiming and shooting, you type answers for your targets. When the answer is ready, press Space or Enter, or hold for continuous fire.

• press Ctrl+Backspace to erase the whole answer.
• press Escape to force Exploration mode. After this, you can return to automatic mode switching with Unlock Game Mode key assigned in Typist options.

Because you cannot move normally in Combat mode, the following commands are available:

• dl - dash to the left,
• dr - dash to the right,
• df - dash forward,
• db - dash backward.
• rl - reload weapon (if it has reloading).

Commands are configurable.

Key setup

The mod doesn't require any special key setup. However, for smoother experience, it may be worth playing keyboard-only with the following assigned keys:

• E - move forward
• S - strafe left
• D - move backward
• F - strafe right
• I - center view
• J - turn left
• K - turn around
• L - turn right

This way, you'll waste no time switching from mouse to keyboard and back, and your fingers are almost at the right typing position!

How To Set Up Custom Text Lesson

1. Find any text or book in ASCII .txt file (UTF-8 may also work).
2. If a file is supposed to be in ASCII but actually is not, use grep -P "[^\x00-\x7F]" file.txt to find non-ASCII characters.
3. Rename text file to typist_custom_text.txt.
4. Load typist_custom_text.txt with GZDoom alongside Typist.pk3.
5. Select Custom Text in Typist options menu.

Incompatible Mods

• Guncaster. Reason: Guncaster reads player input directly from player, so weapon firing cannot be emulated like for other mods. Guncaster support cannot be added without modifications in Guncaster or GZDoom.
• Guncaster Vindicated. Reason: the same as Guncaster.

Compilation

Actually, you don't need to compile this. The repository contains everything that is needed to run this mod. But if you want to develop Typist.pk3 with maximum comfort, set up the compilation.

Linux

Required tools:

• Git
• Bash
• Python 3
• pylint3
• aspell with English (UK) dictionaries
• ShellCheck

./scripts/build.sh

To run tests:

./scripts/test.sh

(Test script also builds.)

Windows

It may be possible to compile this on Windows. Install Msys or something. You're on your own :)

Software Used

• Emacs
• Slade

Acknowledgments

Credits

• libeye (Level and screen projections): KeksDose
• Clematis (Basic ZScript unit test framework for GZDoom): ZippeyKeys12 (Zain Aamer). Clematis is under the BSD 3-Clause License.
• miniwad.wad (BSD license): fraggle
• 1000 basic English words (tt_1000.txt) (actually, 1008) CC BY-SA 3.0
• Frequency dictionary of the modern Russian language (tt_1000_ru.txt) CC BY-SA 3.0
• Sound design: Captain J. See credits for each sound effect in credits-sounds.md

Thanks

• LGR for Sega's Typing of the Dead: A Zombie-Slaying Education video
• Marrub for ZScript documentation
• Accensus for inviting into Discord server and for bug reports
• Accensus, Tapwave, and IKA for patience in testing and development of certain under-the-hood tech, which is also used in War Trophies
• kadu522 for support
• dard22 for bug reports
• Jarewill for bug reports
• SphericalCube for bug reports